Bank transaction rules

Bank transaction rules define whether to match or create Sage Intacct transactions when processing incoming bank transactions.

List bank transaction rules

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

Returns a collection with a key, ID, and link for each bank transaction rule. This operation is mostly for use in testing; use query 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/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/cash-management/bank-txn-rule/3"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/cash-management/bank-txn-rule/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a bank transaction rule
post/objects/cash-management/bank-txn-rule
Creates a new bank transaction rule.


SecurityOAuth2 
Request 
Request Body schema: application/json
ruleId
required
string
ID of the rule that matched or created the transaction.


 
 Example:  "match-by-amount-1"
name
required
string
Name of the rule that matched or created the transaction.


 
 Example:  "match-by-amount"
ruleType
required
string
 Default:  "match"
Type of rule. A match rule matches existing Sage Intacct transactions to incoming bank transactions. A create rule creates new Sage Intacct transactions and automatically matches them to incoming bank transactions.


 Enum: "create" "match"  
 Example:  "match"
required
Array of objects  non-empty 
Filter attributes for the bank transaction rule.


 
 Array (non-empty)
dataSource
string
Attribute data source. This indicates if the filter attribute should be applied on bank transaction or Intacct system transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Intacct/system transaction attribute


 Enum: "baseAmount" "baseCurrency" "description" "documentDate" "documentNumber" null "postingDate" "transactionAmount" "transactionCurrency" "transactionType"  
 Example:  "postingDate"
bankTxnAttribute
string or null
 Default:  null
Bank transaction attribute


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "transactionType"  
 Example:  "transactionType"
operator
string
Operator to  use for the txn attribute, to filter txn.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Value to  use with operator for the txn attribute, to filter txn.


 
 Example:  "debit"
order
integer  <= 2 characters 
Order


 
 Example:  2
description
string
Description of the bank transaction.


 
 Example:  "Rule for matching bank transactions by amount"
object
Location where the bank transaction rule was created.


 
key
string
System-assigned key for the location.


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


 
 Example:  "1-Lyon"
Array of objects
Group attributes for the bank transaction rule.


 
 Array 
dataSource
string
Attribute data source. This indicates if this group attribute should be applied on bank transaction or Intacct system transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Intacct/system transaction attribute. This is required if datSource is intacctTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "documentNumber"
bankTxnAttribute
string or null
 Default:  null
Bank transaction attribute. This is required if datSource is bankTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "postingDate"
order
integer  <= 2 characters 
Order


 
 Example:  1
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
Matching condition attributes for a match rule. Required when ruletype is match.


 
 Array 
intacctTxnAttribute
string
Intacct/system transaction field to match.


 Enum: "amount" "description" "documentNumber" "postingDate"  
 Example:  "postingDate"
bankTxnAttribute
string
Bank transaction field to match.


 Enum: "amount" "description" "documentNumber" "documentNumberLeadingZerosRemoved" "postingDate"  
 Example:  "documentNumber"
operator
string
Operator used to match attribute.


 Enum: "contains" "equals" "within"  
 Example:  "equals"
value
string
Value to match


 
 Example:  "DOC1000"
order
integer
Order of this match attribute in the matchching rule.


 
 Example:  2
object
Transaction template object needed to create transactions. Required when ruletype is create.


 
objectType
string or null
 Default:  null
Object type for a create rule.


 Enum: "cctransaction" "journalEntry" null  
 Example:  "journalEntry"
object
 
id
string
Identifier for the GL template.


 
 Example:  "12"
key
string
System-assigned key for the GL template.


 
 Example:  "12"
object
 
id
string
Identifier for the CC txn template.


 
 Example:  "5"
key
string
System-assigned key for the CC txn template.


 
 Example:  "5"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "ruleId": "JE rule",
  • "description": "Rule   to create journal entry",
  • "name": "Create GL rule ",
  • "ruleType": "create",
  • "createRuleObject": {
    • "objectType": "journalEntry",
    • "journalEntryTemplate": {
      • "id": "1"
      }
    },
  • "filterAttributes": [
    • {
      • "dataSource": "bankTransaction",
      • "bankTxnAttribute": "postingDate",
      • "operator": "greaterThan",
      • "value": "11/10/2023"
      },
    • {
      • "dataSource": "bankTransaction",
      • "bankTxnAttribute": "transactionType",
      • "operator": "equals",
      • "value": "withdrawal"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "15",
    • "id": "15",
    • "href": "/objects/cash-management/bank-txn-rule/15"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bank transaction rule
get/objects/cash-management/bank-txn-rule/{key}
Returns detailed information for a specified bank transaction rule..


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


 
 Example:  53
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "79",
    • "key": "79",
    • "ruleId": "gl-boa-create-rule-1",
    • "name": "Create-GL-credit-card-rule-1",
    • "description": "Create GL rule for bank account BOA",
    • "ruleType": "create",
    • "createRuleObject": {
      • "objectType": "journalEntry",
      • "journalEntryTemplate": {
        },
      • "creditCardTxnTemplate": {
        }
      },
    • "status": "active",
    • "location": {
      • "key": null
      },
    • "rulesetCount": 0,
    • "audit": {
      • "createdDateTime": "2023-08-03T16:38:31Z",
      • "modifiedDateTime": "2023-08-03T16:38:31Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "filterAttributes": [
      • {
        },
      • {
        }
      ],
    • "groupAttributes": [ ],
    • "matchRuleAttributes": [ ],
    • "href": "/objects/cash-management/bank-txn-rule/79"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a bank transaction rule
patch/objects/cash-management/bank-txn-rule/{key}
Updates an existing bank transaction rule by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  53
Request Body schema: application/json
ruleId
string
ID of the rule that matched or created the transaction.


 
 Example:  "match-by-amount-1"
name
string
Name of the rule that matched or created the transaction.


 
 Example:  "match-by-amount"
description
string
Description of the bank transaction.


 
 Example:  "Rule for matching bank transactions by amount"
ruleType
string
 Default:  "match"
Type of rule. A match rule matches existing Sage Intacct transactions to incoming bank transactions. A create rule creates new Sage Intacct transactions and automatically matches them to incoming bank transactions.


 Enum: "create" "match"  
 Example:  "match"
object
Location where the bank transaction rule was created.


 
key
string
System-assigned key for the location.


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


 
 Example:  "1-Lyon"
Array of objects  non-empty 
Filter attributes for the bank transaction rule.


 
 Array (non-empty)
dataSource
string
Attribute data source. This indicates if the filter attribute should be applied on bank transaction or Intacct system transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Intacct/system transaction attribute


 Enum: "baseAmount" "baseCurrency" "description" "documentDate" "documentNumber" null "postingDate" "transactionAmount" "transactionCurrency" "transactionType"  
 Example:  "postingDate"
bankTxnAttribute
string or null
 Default:  null
Bank transaction attribute


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "transactionType"  
 Example:  "transactionType"
operator
string
Operator to  use for the txn attribute, to filter txn.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Value to  use with operator for the txn attribute, to filter txn.


 
 Example:  "debit"
order
integer  <= 2 characters 
Order


 
 Example:  2
Array of objects
Group attributes for the bank transaction rule.


 
 Array 
dataSource
string
Attribute data source. This indicates if this group attribute should be applied on bank transaction or Intacct system transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Intacct/system transaction attribute. This is required if datSource is intacctTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "documentNumber"
bankTxnAttribute
string or null
 Default:  null
Bank transaction attribute. This is required if datSource is bankTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "postingDate"
order
integer  <= 2 characters 
Order


 
 Example:  1
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
Matching condition attributes for a match rule. Required when ruletype is match.


 
 Array 
intacctTxnAttribute
string
Intacct/system transaction field to match.


 Enum: "amount" "description" "documentNumber" "postingDate"  
 Example:  "postingDate"
bankTxnAttribute
string
Bank transaction field to match.


 Enum: "amount" "description" "documentNumber" "documentNumberLeadingZerosRemoved" "postingDate"  
 Example:  "documentNumber"
operator
string
Operator used to match attribute.


 Enum: "contains" "equals" "within"  
 Example:  "equals"
value
string
Value to match


 
 Example:  "DOC1000"
order
integer
Order of this match attribute in the matchching rule.


 
 Example:  2
object
Transaction template object needed to create transactions. Required when ruletype is create.


 
objectType
string or null
 Default:  null
Object type for a create rule.


 Enum: "cctransaction" "journalEntry" null  
 Example:  "journalEntry"
object
 
id
string
Identifier for the GL template.


 
 Example:  "12"
key
string
System-assigned key for the GL template.


 
 Example:  "12"
object
 
id
string
Identifier for the CC txn template.


 
 Example:  "5"
key
string
System-assigned key for the CC txn template.


 
 Example:  "5"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "matchRuleAttributes": [
    • {
      • "key": "7",
      • "order": 5
      },
    • {
      • "key": "11",
      • "intacctTxnAttribute": "description",
      • "bankTxnAttribute": "description",
      • "operator": "contains",
      • "value": "abc1000",
      • "order": 10
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/cash-management/bank-txn-rule/4"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bank transaction rule
delete/objects/cash-management/bank-txn-rule/{key}
Deletes a bank transaction rule.


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


 
 Example:  53
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
    }
}
Query bank transaction rules
post/services/core/query
Use the query service to find bank transaction rules that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}