Bank transaction rule sets

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.

List bank transaction rule sets

get/objects/cash-management/bank-txn-rule-set

Returns a collection with a key, ID, and link for each rules. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a bank transaction rule set
post/objects/cash-management/bank-txn-rule-set
Creates a new bank transaction rule set.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


 Enum: "bank" "creditcard"  
 Example:  "creditcard"
object
Location where the bank transaction rule set was created.


 
key
string
System-assigned key for the location.


 
 Example:  "122"
id
string
ID for the location.


 
 Example:  "1-Lyon"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
List of the rules in this rule set.


 
 Array 
ruleOrder
integer
Specifies the position of the rule within the rule set order.


 
 Example:  1
object
Indicates the bank transaction rule to be mapped to the rule set.


 
Responses 
201
Created rule set


400
Bad Request


Request samples 
application/json
{
  • "ruleSetId": "Txn-Rule-Set-004",
  • "name": "MBB Rule Set",
  • "description": "Primary rule set for MBB",
  • "accountType": "creditcard",
  • "location": {
    • "key": "1"
    },
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/cash-management/bank-txn-rule-set/5"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bank transaction rule set
get/objects/cash-management/bank-txn-rule-set/{key}
Returns detailed information for a specified bank transaction rule set.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bank transaction rule set.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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": [
      • {
        }
      ],
    • "href": "/objects/cash-management/bank-txn-rule-set/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a bank transaction rule set
patch/objects/cash-management/bank-txn-rule-set/{key}
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.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bank transaction rule set.


 
 Example:  99
Request Body schema: application/json
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.


 Enum: "bank" "creditcard"  
 Example:  "creditcard"
object
Location where the bank transaction rule set was created.


 
key
string
System-assigned key for the location.


 
 Example:  "122"
id
string
ID for the location.


 
 Example:  "1-Lyon"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
List of the rules in this rule set.


 
 Array 
ruleOrder
integer
Specifies the position of the rule within the rule set order.


 
 Example:  1
object
Indicates the bank transaction rule to be mapped to the rule set.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/cash-management/bank-txn-rule-set/4"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bank transaction rule set
delete/objects/cash-management/bank-txn-rule-set/{key}
Deletes a bank transaction rule set.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bank transaction rule set.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}