PUT /api/v202104/audit Deprecated

Update audit settings

UpdateAuditSettingsV202104 Permissions: BillWorkflowSettings (Manage)

Setting Status Descriptions:

Setting Status Description
Check If this audit fails affected bills are flagged
Hold If this audit fails affected bills are flagged and held from export
Skip This audit is skipped

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, including the request body.

Request Body

AuditSettingsRequestV202104
Property Description Type
abnormalBillCostWithOutlierAnalysis AbnormalBillCostWithOutlierAnalysisSettingRequestV202104
AbnormalBillCostWithOutlierAnalysisSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
sensitivity Minimum outlier sensitivity for abnormal cost analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of ‘Severe’, ‘High’, ‘Moderate’ string
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
abnormalBillDemandWithOutlierAnalysis AbnormalBillDemandWithOutlierAnalysisSettingRequestV202104
AbnormalBillDemandWithOutlierAnalysisSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
sensitivity Minimum outlier sensitivity for abnormal demand analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of ‘Severe’, ‘High’, ‘Moderate’ string
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
abnormalBillUseWithOutlierAnalysis AbnormalBillUseWithOutlierAnalysisSettingRequestV202104
AbnormalBillUseWithOutlierAnalysisSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
sensitivity Minimum outlier sensitivity for abnormal use analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of ‘Severe’, ‘High’, ‘Moderate’ string
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
accountAlertExistsOnAccountInImportFile AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
accountHasMultipleBillsInBillingPeriod CommoditySkipAuditSettingRequestV202104
CommoditySkipAuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
commoditiesToSkip Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billContainsLineItemDescriptions BillContainsLineItemDescriptionsSettingRequestV202104
BillContainsLineItemDescriptionsSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
lineItemDescriptions List of line item descriptions. Each description must be shorter than 100 characters. If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty string[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billContainsLineItemTypes BillContainsLineItemTypesSettingRequestV202104
BillContainsLineItemTypesSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
lineItemTypes List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty string[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billEndsInFuture AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billOverlapsWithOtherAccountBill CommoditySkipAuditSettingRequestV202104
CommoditySkipAuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
commoditiesToSkip Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billSignificantlyShorterOrLongerThanPrevious BillSignificantlyShorterOrLongerThanPreviousSettingRequestV202104
BillSignificantlyShorterOrLongerThanPreviousSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
percentLengthVariance Percent variance for bill length If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
billingPeriodOutsideStartEndDates AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
dueDateBeforeEndDate AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
dueDateTooLongAfterBillEnd DueDateTooLongAfterBillEndSettingRequestV202104
DueDateTooLongAfterBillEndSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
days Threshold for how long the due date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 0 and 2147483647 Required when SettingStatus is set to Check, or Hold integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
gapBetweenBillAndPreviousBillOnAccount CommoditySkipAuditSettingRequestV202104
CommoditySkipAuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
commoditiesToSkip Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
importFileStartDateAdjustedToPreventGaps AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
invoiceNumberIsRepeatedOnAccount AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
likelyDuplicateBillOnAccount AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
rateCodeDoesNotMatchImportFile AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
serialNumberDoesNotMatchImportFile AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
statementDateBeforeEndDate AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
statementDateTooLongAfterBillEnd StatementDateTooLongAfterBillEndSettingRequestV202104
StatementDateTooLongAfterBillEndSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
days Threshold for how long the statement date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 0 and 2147483647 Required when SettingStatus is set to Check, or Hold integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
tooManyConsecutiveEstimatedBills TooManyConsecutiveEstimatedBillsSettingRequestV202104
TooManyConsecutiveEstimatedBillsSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
bills Threshold for how many bills can be estimated in a row If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 1 and 2147483647 Required when SettingStatus is set to Check, or Hold integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
totalBillCostDoesNotMatchLineItemTypes TotalBillCostDoesNotMatchLineItemTypesSettingRequestV202104
TotalBillCostDoesNotMatchLineItemTypesSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
lineItemTypes List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty string[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
totalMeterCostIsPercentageHigherThanPastYear AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
totalMeterUseIsPercentageHigherThanPastYear AuditSettingRequestV202104
AuditSettingRequestV202104 properties
Property Description Type
assignees List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) integer[]
minimumCost Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) integer (int32)
settingStatus The status of the audit setting One of ‘Check’, ‘Hold’, ‘Skip’ Required (defined) string
Example Request Body application/json 
{  "abnormalBillCostWithOutlierAnalysis": {    "assignees": [
      1
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingStatus": "string"
  },  "abnormalBillDemandWithOutlierAnalysis": {    "assignees": [
      1
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingStatus": "string"
  },  "abnormalBillUseWithOutlierAnalysis": {    "assignees": [
      1
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingStatus": "string"
  },  "accountAlertExistsOnAccountInImportFile": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "accountHasMultipleBillsInBillingPeriod": {    "assignees": [
      1
    ],    "commoditiesToSkip": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "billContainsLineItemDescriptions": {    "assignees": [
      1
    ],    "lineItemDescriptions": [
      "string"
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "billContainsLineItemTypes": {    "assignees": [
      1
    ],    "lineItemTypes": [
      "string"
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "billEndsInFuture": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "billOverlapsWithOtherAccountBill": {    "assignees": [
      1
    ],    "commoditiesToSkip": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "billSignificantlyShorterOrLongerThanPrevious": {    "assignees": [
      1
    ],    "minimumCost": 1,    "percentLengthVariance": 1,    "settingStatus": "string"
  },  "billingPeriodOutsideStartEndDates": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "dueDateBeforeEndDate": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "dueDateTooLongAfterBillEnd": {    "assignees": [
      1
    ],    "days": 1,    "minimumCost": 1,    "settingStatus": "string"
  },  "gapBetweenBillAndPreviousBillOnAccount": {    "assignees": [
      1
    ],    "commoditiesToSkip": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "importFileStartDateAdjustedToPreventGaps": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "invoiceNumberIsRepeatedOnAccount": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "likelyDuplicateBillOnAccount": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "rateCodeDoesNotMatchImportFile": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "serialNumberDoesNotMatchImportFile": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "statementDateBeforeEndDate": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "statementDateTooLongAfterBillEnd": {    "assignees": [
      1
    ],    "days": 1,    "minimumCost": 1,    "settingStatus": "string"
  },  "tooManyConsecutiveEstimatedBills": {    "assignees": [
      1
    ],    "bills": 1,    "minimumCost": 1,    "settingStatus": "string"
  },  "totalBillCostDoesNotMatchLineItemTypes": {    "assignees": [
      1
    ],    "lineItemTypes": [
      "string"
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "totalMeterCostIsPercentageHigherThanPastYear": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  },  "totalMeterUseIsPercentageHigherThanPastYear": {    "assignees": [
      1
    ],    "minimumCost": 1,    "settingStatus": "string"
  }
}

Responses

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

Response Body Parameters

AuditSettingsResponseV202104
Property Description Type
abnormalBillCostWithOutlierAnalysis AbnormalBillCostWithOutlierAnalysisSettingResponseV202104
AbnormalBillCostWithOutlierAnalysisSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
sensitivity Minimum outlier sensitivity for abnormal cost analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
abnormalBillDemandWithOutlierAnalysis AbnormalBillDemandWithOutlierAnalysisSettingResponseV202104
AbnormalBillDemandWithOutlierAnalysisSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
sensitivity Minimum outlier sensitivity for abnormal demand analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
abnormalBillUseWithOutlierAnalysis AbnormalBillUseWithOutlierAnalysisSettingResponseV202104
AbnormalBillUseWithOutlierAnalysisSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
sensitivity Minimum outlier sensitivity for abnormal use analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
accountAlertExistsOnAccountInImportFile AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
accountHasMultipleBillsInBillingPeriod CommoditySkipAuditSettingResponseV202104
CommoditySkipAuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
commoditiesToSkip CommodityChild[]
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billContainsLineItemDescriptions BillContainsLineItemDescriptionsSettingResponseV202104
BillContainsLineItemDescriptionsSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
lineItemDescriptions List of line item descriptions. Each description must be shorter than 100 characters. If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string[]
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billContainsLineItemTypes BillContainsLineItemTypesSettingResponseV202104
BillContainsLineItemTypesSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
lineItemTypes List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string[]
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billEndsInFuture AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billOverlapsWithOtherAccountBill CommoditySkipAuditSettingResponseV202104
CommoditySkipAuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
commoditiesToSkip CommodityChild[]
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billSignificantlyShorterOrLongerThanPrevious BillSignificantlyShorterOrLongerThanPreviousSettingResponseV202104
BillSignificantlyShorterOrLongerThanPreviousSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
percentLengthVariance Percent variance for bill length If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billUseUnitDifferentFromMeterAnalysis AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
billingPeriodOutsideStartEndDates AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
currencyUnitAnalysis AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
dueDateBeforeEndDate AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
dueDateTooLongAfterBillEnd DueDateTooLongAfterBillEndSettingResponseV202104
DueDateTooLongAfterBillEndSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
days Threshold for how long the due date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
gapBetweenBillAndPreviousBillOnAccount CommoditySkipAuditSettingResponseV202104
CommoditySkipAuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
commoditiesToSkip CommodityChild[]
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
importFileStartDateAdjustedToPreventGaps AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
invoiceNumberIsRepeatedOnAccount AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
likelyDuplicateBillOnAccount AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
multipleUseUnitAnalysis AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
rateCodeDoesNotMatchImportFile AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
serialNumberDoesNotMatchImportFile AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
statementDateBeforeEndDate AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
statementDateTooLongAfterBillEnd StatementDateTooLongAfterBillEndSettingResponseV202104
StatementDateTooLongAfterBillEndSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
days Threshold for how long the statement date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
tooManyConsecutiveEstimatedBills TooManyConsecutiveEstimatedBillsSettingResponseV202104
TooManyConsecutiveEstimatedBillsSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
bills Threshold for how many bills can be estimated in a row If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
totalBillCostDoesNotMatchLineItemTypes TotalBillCostDoesNotMatchLineItemTypesSettingResponseV202104
TotalBillCostDoesNotMatchLineItemTypesSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
lineItemTypes List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set string[]
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
totalMeterCostIsPercentageHigherThanPastYear AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
totalMeterUseIsPercentageHigherThanPastYear AuditSettingResponseV202104
AuditSettingResponseV202104 properties
Property Description Type
assignees List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
minimumCost Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost integer (int32)
settingCode The setting code string
settingDescription A description of the setting string
settingStatus The status of the audit setting - Possible values Check, Hold, Skip string
Example Response application/json 
{  "abnormalBillCostWithOutlierAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "abnormalBillDemandWithOutlierAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "abnormalBillUseWithOutlierAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "sensitivity": "string",    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "accountAlertExistsOnAccountInImportFile": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "accountHasMultipleBillsInBillingPeriod": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "commoditiesToSkip": [
      {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billContainsLineItemDescriptions": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "lineItemDescriptions": [
      "string"
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billContainsLineItemTypes": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "lineItemTypes": [
      "string"
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billEndsInFuture": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billOverlapsWithOtherAccountBill": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "commoditiesToSkip": [
      {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billSignificantlyShorterOrLongerThanPrevious": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "percentLengthVariance": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billUseUnitDifferentFromMeterAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "billingPeriodOutsideStartEndDates": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "currencyUnitAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "dueDateBeforeEndDate": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "dueDateTooLongAfterBillEnd": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "days": 1,    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "gapBetweenBillAndPreviousBillOnAccount": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "commoditiesToSkip": [
      {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "importFileStartDateAdjustedToPreventGaps": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "invoiceNumberIsRepeatedOnAccount": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "likelyDuplicateBillOnAccount": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "multipleUseUnitAnalysis": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "rateCodeDoesNotMatchImportFile": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "serialNumberDoesNotMatchImportFile": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "statementDateBeforeEndDate": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "statementDateTooLongAfterBillEnd": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "days": 1,    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "tooManyConsecutiveEstimatedBills": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "bills": 1,    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "totalBillCostDoesNotMatchLineItemTypes": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "lineItemTypes": [
      "string"
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "totalMeterCostIsPercentageHigherThanPastYear": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  },  "totalMeterUseIsPercentageHigherThanPastYear": {    "assignees": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ],    "minimumCost": 1,    "settingCode": "string",    "settingDescription": "string",    "settingStatus": "string"
  }
}