A rule set acts as a container for matching and creating rules. The rules determine how to match incoming bank transactions or create new transactions for reconciliation in Sage Intacct.
Returns a collection with a key, ID, and link for each rules. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Cash Management |
---|---|
User type | Business |
Permissions | List Bank transaction rule sets |
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/objects/cash-management/bank-txn-rule-set/1"
}, - {
- "key": "2",
- "id": "2",
- "href": "/objects/cash-management/bank-txn-rule-set/2"
}, - {
- "key": "3",
- "id": "3",
- "href": "/objects/cash-management/bank-txn-rule-set/3"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new bank transaction rule set.
Subscription | Cash Management |
---|---|
User type | Business |
Permissions | Add Bank transaction rule sets |
ruleSetId required | string ID for the bank transaction rule set. Example: "ruleSet-1" | ||||
name required | string <= 100 characters Name of the bank transaction rule set. Example: "rule-set-for-credit-cards" | ||||
description | string Description of the bank transaction rule set. Example: "Rule set for all card accounts" | ||||
accountType | string Default: "bank" Type of the associated account. Example: "creditcard" | ||||
object Location where the bank transaction rule set was created. | |||||
| |||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||
Array of objects List of the rules in this rule set. | |||||
Array
|
Created rule set
Bad Request
{- "ruleSetId": "Txn-Rule-Set-004",
- "name": "MBB Rule Set",
- "description": "Primary rule set for MBB",
- "accountType": "creditcard",
- "location": {
- "key": "1"
}, - "status": "active"
}
{- "ia::result": {
- "key": "5",
- "id": "5",
- "href": "/objects/cash-management/bank-txn-rule-set/5"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified bank transaction rule set.
Subscription | Cash Management |
---|---|
User type | Business |
Permissions | List, View Bank transaction rule sets |
key required | string System-assigned key for the bank transaction rule set. Example: 11 |
OK
Bad Request
{- "ia::result": {
- "id": "2",
- "key": "2",
- "ruleSetId": "BankRuleSetChase",
- "name": "Rule set for chase bank",
- "description": "Primary rule set for CB",
- "accountType": "bank",
- "numberOfAccounts": 7,
- "numberOfRules": 1,
- "status": "active",
- "location": {
- "key": "5"
}, - "audit": {
- "createdDateTime": "2022-01-26T00:15:14Z",
- "modifiedDateTime": "2023-03-24T21:41:10Z",
- "createdBy": "68",
- "modifiedBy": "68"
}, - "entity": {
- "key": "46",
- "id": "Western Region",
- "name": "Western Region",
- "href": "/objects/company-config/entity/46"
}, - "rules": [
- {
- "id": "26",
- "key": "26",
- "bankTxnRule": {
- "id": "11",
- "key": "11",
- "ruleId": "gl-create-rule-2",
- "name": "gl-create-rule-2",
- "ruleType": "create",
- "href": "/objects/cash-management/bank-txn-rule/11"
}, - "bankTxnRuleSet": {
- "id": "2",
- "key": "2",
- "href": "/objects/cash-management/bank-txn-rule-set/2"
}, - "ruleOrder": 1,
- "audit": {
- "createdDateTime": "2023-03-24T00:00:00Z",
- "modifiedDateTime": "2023-03-24T00:00:00Z",
- "createdBy": "68",
- "modifiedBy": "68"
}, - "href": "/objects/cash-management/bank-txn-rule-map/26"
}
], - "href": "/objects/cash-management/bank-txn-rule-set/2"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing bank transaction rule set by setting field values. Any fields not provided remain unchanged. Updating a rule set affects matches for incoming transactions going forward for every associated account that uses the rule set. Updating a rule set does not affect transactions that have already been matched.
Subscription | Cash Management |
---|---|
User type | Business |
Permissions | List, Edit Bank transaction rule sets |
key required | string System-assigned key for the bank transaction rule set. Example: 11 |
ruleSetId | string ID for the bank transaction rule set. Example: "ruleSet-1" | ||||
name | string <= 100 characters Name of the bank transaction rule set. Example: "rule-set-for-credit-cards" | ||||
description | string Description of the bank transaction rule set. Example: "Rule set for all card accounts" | ||||
accountType | string Default: "bank" Type of the associated account. Example: "creditcard" | ||||
object Location where the bank transaction rule set was created. | |||||
| |||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||
Array of objects List of the rules in this rule set. | |||||
Array
|
OK
Bad Request
{- "status": "inactive"
}
{- "ia::result": {
- "key": "4",
- "id": "4",
- "href": "/objects/cash-management/bank-txn-rule-set/4"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a bank transaction rule set.
Subscription | Cash Management |
---|---|
User type | Business |
Permissions | List, Delete Bank transaction rule sets |
key required | string System-assigned key for the bank transaction rule set. Example: 11 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/bank-txn-rule-set" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "cash-management/bank-txn-rule-set",
- "filters": [
- {
- "$eq": {
- "accountType": "bank"
}
}
], - "fields": [
- "key",
- "id",
- "ruleSetId",
- "description",
- "numberOfAccounts",
- "numberOfRules"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "ruleSetId": "Txn-Rule-Set-001",
- "description": "Primary rule set for Propser bank account",
- "numberOfAccounts": 6,
- "numberOfRules": 1
}, - {
- "key": "3",
- "id": "3",
- "ruleSetId": "Txn-Rule-Set-003",
- "description": "Create IET",
- "numberOfAccounts": 0,
- "numberOfRules": 1
}, - {
- "key": "4",
- "id": "4",
- "ruleSetId": "Txn-Rule-Set-004",
- "description": "Primary rule set for MBB",
- "numberOfAccounts": 0,
- "numberOfRules": 0
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}