POST /api/v202604/billImportRule

Create a new bill import rule. Scope is determined by the optional vendorId or accountId in the body. At most one scope entity can be provided. If none are provided, the rule is global (customer-level).

CreateRuleV202604 Permissions: BillsAndBatches (Create)

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

BillImportRuleRequestV202604
Property Description Type
accountId If set, the account the rule is scoped to, otherwise null Only one of VendorId, AccountId can be set integer (int32)
billImportRuleTemplateId If set, the bill import rule template to associate with the rule integer (int32)
description A human-readable description of what the rule does Required Max length of 4000 string
priority The execution priority of the rule within its scope. Must be greater than 0. Lower values execute first. Required Must be between 1 and 2147483647 integer (int32)
ruleDefinition The JavaScript rule definition to be executed by the rules engine Required string
vendorId If set, the vendor the rule is scoped to, otherwise null Only one of VendorId, AccountId can be set integer (int32)
Example Request Body application/json 
{  "accountId": 1,  "billImportRuleTemplateId": 1,  "description": "string",  "priority": 1,  "ruleDefinition": "string",  "vendorId": 1
}

Responses

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

Response Body Parameters

BillImportRuleResponseV202604
Property Description Type
account AccountChild
AccountChild properties
Property Description Type
accountCode string
accountId integer (int32)
accountInfo string
active boolean
hasCalculatedMeter boolean
hasSplitChildMeter boolean
hasSplitParentMeter boolean
hasSubAccount boolean
isSubAccount 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)
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
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": {      "vendorCode": "string",      "vendorId": 1,      "vendorInfo": "string"
    }
  },  "billImportRuleId": 1,  "billImportRuleTemplateId": 1,  "createdBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-05-01",  "description": "string",  "modifiedBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "modifiedDate": "2026-05-01",  "priority": 1,  "ruleDefinition": "string",  "vendor": {    "vendorCode": "string",    "vendorId": 1,    "vendorInfo": "string"
  }
}