GET /api/v202604/billImportRule

Retrieves a paginated list of bill import rules, with optional filtering and ordering

GetRulesV202604 Permissions: BillProcessingRules (View)
Use this endpoint to list all configured import rules. Supports filtering by description, rule name, status, vendor name, and account name. Results are paginated.
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

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
filter Optional filter criteria for narrowing results string (string) Optional
orderBy Optional ordering criteria string (string) Optional
pageSize The number of elements to return in a page integer (int32) Optional
pageNumber The current page number integer (int32) Optional

Filters

Filter Description Type Operators
accountCode Account Number String equals not equals one of like not like not one of
accountId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
accountInfo Account Name String equals not equals one of like not like not one of
billImportRuleInfo Rule Name String equals not equals one of like not like not one of
billImportRuleScopeInfo Rule Scope Name String equals not equals one of like not like not one of
description Description String equals not equals one of like not like not one of
statusId Status ID Integer equals not equals less than between one of greater than less than equal greater than equal not one of
statusInfo Status String equals not equals one of like not like not one of
vendorCode Vendor Code String equals not equals one of like not like not one of
vendorId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
vendorInfo Vendor Name String equals not equals one of like not like not one of

Order By Options

Name Description
description Description
billImportRuleInfo Rule Name
statusInfo Status
vendorName Vendor Name
accountName Account Name
accountCode Account Number
vendorCode Vendor Code

Response Headers

This endpoint returns pagination metadata in the response headers.

Header Type Description
PageNumber integer The current page number (1-based).
PageSize integer The maximum number of items per page.
TotalNumberOfRecords integer The total number of records matching the query across all pages.
TotalPages integer The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

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

Response Body Parameters

Array of:

BillImportRuleResponseV202604
Property Description Type
account AccountChild
AccountChild properties
Property Description Type
accountCode The account code (unique identifier assigned by the organization) string
accountId The unique identifier of the account integer (int32)
accountInfo The account description/name string
active Whether the account is currently active. Null if not applicable. boolean
hasCalculatedMeter Whether the account has a child calculated meter boolean
hasSplitChildMeter Whether the account has a child split meter boolean
hasSplitParentMeter Whether the account is a recipient of a meter split boolean
hasSubAccount Whether this account has sub-accounts beneath it boolean
isSubAccount Whether this account is a sub-account of a summary account boolean
vendor VendorChild
VendorChild properties
Property Description Type
vendorCode The vendor code string
vendorId The vendor identifier integer (int32)
vendorInfo The vendor info string
billImportRuleId The unique identifier of the bill import rule integer (int32)
billImportRuleInfo The name of the bill import rule string
billImportRulePrompt The prompt used to generate the rule definition string
billImportRuleTemplateId If set, the bill import rule template associated with the rule integer (int32)
createdBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
createdDate The date and time the rule was created string (date-time)
description A human-readable description of what the rule does string
modifiedBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
modifiedDate The date and time the rule was last modified string (date-time)
priority The execution priority of the rule within its scope. Lower values execute first. integer (int32)
ruleDefinition The JavaScript rule definition executed by the rules engine string
status BillImportRuleStatusChildV202604
BillImportRuleStatusChildV202604 properties
Property Description Type
billImportRuleStatusId The status identifier integer (int32)
billImportRuleStatusInfo The status display name string
vendor VendorChild
VendorChild properties
Property Description Type
vendorCode The vendor code string
vendorId The vendor identifier integer (int32)
vendorInfo The vendor info string
Example Response application/json 
[
  {    "account": {      "accountCode": "string",      "accountId": 1,      "accountInfo": "string",      "active": false,      "hasCalculatedMeter": false,      "hasSplitChildMeter": false,      "hasSplitParentMeter": false,      "hasSubAccount": false,      "isSubAccount": false,      "vendor": {}
    },    "billImportRuleId": 1,    "billImportRuleInfo": "string",    "billImportRulePrompt": "string",    "billImportRuleTemplateId": 1,    "createdBy": {      "fullName": "string",      "userCode": "string",      "userId": 1
    },    "createdDate": "2026-06-18",    "description": "string",    "modifiedBy": {      "fullName": "string",      "userCode": "string",      "userId": 1
    },    "modifiedDate": "2026-06-18",    "priority": 1,    "ruleDefinition": "string",    "status": {      "billImportRuleStatusId": 1,      "billImportRuleStatusInfo": "string"
    },    "vendor": {      "vendorCode": "string",      "vendorId": 1,      "vendorInfo": "string"
    }
  }
]