Bank transaction rules

Bank transaction rules determine whether incoming bank transactions are matched to existing Sage Intacct transactions or used to create new transactions. A match rule matches incoming bank transactions to existing Sage Intacct transactions. A create rule uses incoming bank transactions to create new Sage Intacct transactions.

List bank transaction rules

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

Returns a collection of bank transaction rules with a key, ID, and link for each 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
required
ruleId
required
string
User-assigned identifier of the bank transaction rule.


 
 Example:  "match-by-amount-1"
name
required
string
Name of the bank transaction rule.


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


 Enum: "create" "match"  
 Example:  "match"
required
Array of objects  non-empty 
Specifies a filter used in the bank transaction rule.


 
 Array (non-empty)
dataSource
string
Indicates if the filter should be applied to a bank transaction or an Intacct transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Specifies which Intacct transaction field to include in the bank transaction rule filter.


 Enum: "baseAmount" "baseCurrency" "description" "documentDate" "documentNumber" null "postingDate" "transactionAmount" "transactionCurrency" "transactionType"  
 Example:  "postingDate"
bankTxnAttribute
string or null
 Default:  null
Specifies which bank transaction field to include in the bank transaction rule filter.


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "transactionType"  
 Example:  "transactionType"
operator
string
Specifies the comparison operator used by the bank transaction rule filter.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Specifies the value used with the comparison operator in the bank transaction rule filter.


 
 Example:  "debit"
order
integer  <= 2 characters 
Indicates the position of this bank transaction rule filter in the processing sequence of the bank transaction rule.


 
 Example:  2
description
string
Description of the bank transaction rule.


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


 
key
string
System-assigned unique key for the location.


 
 Example:  "122"
id
string
Unique identifier of the location.


 
 Example:  "1-Lyon"
Array of objects
Specifies a group used in the bank transaction rule.


 
 Array 
dataSource
string
Indicates if the bank transaction rule group should be applied to a bank transaction or Intacct transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Specifies which Intacct transaction field to group transactions by. This is required if dataSource is intacctTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "documentNumber"
bankTxnAttribute
string or null
 Default:  null
Specifies which bank transaction field to group transactions by. This is required if dataSource is bankTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "postingDate"
order
integer  <= 2 characters 
Indicates the position of this bank transaction rule group in the processing sequence of the bank transaction rule.


 
 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
Specifies the match entry used in a bank transaction match rule, required when the rule type is set to match.


 
 Array 
intacctTxnAttribute
string
Specifies which Intacct transaction field to include in the bank transaction rule match entry.


 Enum: "amount" "description" "documentNumber" "postingDate"  
 Example:  "postingDate"
bankTxnAttribute
string
Specifies which bank transaction field to include in the bank transaction rule match entry.


 Enum: "amount" "description" "documentNumber" "documentNumberLeadingZerosRemoved" "postingDate"  
 Example:  "documentNumber"
operator
string
Specifies the comparison operator used by the bank transaction rule match entry.


 Enum: "contains" "equals" "within"  
 Example:  "equals"
value
string
Specifies the value used with the comparison operator in the bank transaction rule match entry.


 
 Example:  "DOC1000"
order
integer
Indicates the position of this bank transaction match entry in the processing sequence of the bank transaction rule.


 
 Example:  2
object
Create rule object used to create new transactions, required when the rule type is set to create.


 
objectType
string or null
 Default:  null
Sage Intacct object type that the bank transaction create rule generates, for example a journal entry.


 Enum: "cctransaction" "journalEntry" null  
 Example:  "journalEntry"
object
Reference to the journal entry template used when the create rule is applied.


 
id
string
Unique identifier of the journal entry template.


 
 Example:  "12"
key
string
System-assigned unique key for the journal entry template.


 
 Example:  "12"
object
Reference to the credit card transaction template used when the create rule is applied.


 
id
string
Unique identifier of the credit card transaction template.


 
 Example:  "5"
key
string
System-assigned unique key for the credit card transaction template.


 
 Example:  "5"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "ruleId": "GL-JE-157",
  • "description": "Rule to create journal entry.",
  • "name": "Create Journal Entry rule",
  • "ruleType": "create",
  • "createRuleObject": {
    • "objectType": "journalEntry",
    • "journalEntryTemplate": {
      • "id": "3"
      }
    },
  • "filterAttributes": [
    • {
      • "dataSource": "bankTransaction",
      • "bankTxnAttribute": "postingDate",
      • "operator": "greaterThan",
      • "value": "01/03/2025",
      • "order": 1
      },
    • {
      • "dataSource": "bankTransaction",
      • "bankTxnAttribute": "transactionType",
      • "operator": "equals",
      • "value": "debit",
      • "order": 2
      }
    ]
}
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:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "79",
    • "key": "79",
    • "ruleId": "BOA-CC-TXN-2119",
    • "name": "BOA Create CC txn from bank txn",
    • "description": "BOA rule to create CC txn from bank txn.",
    • "ruleType": "create",
    • "createRuleObject": {
      • "objectType": "journalEntry",
      • "journalEntryTemplate": {
        },
      • "creditCardTxnTemplate": {
        }
      },
    • "status": "active",
    • "location": {
      • "key": null
      },
    • "rulesetCount": 0,
    • "audit": {
      • "createdDateTime": "2025-03-27T16:13:03Z",
      • "modifiedDateTime": "2025-03-27T16:13:03Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "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:  99
Request Body schema: application/json
ruleId
string
User-assigned identifier of the bank transaction rule.


 
 Example:  "match-by-amount-1"
name
string
Name of the bank transaction rule.


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


 
 Example:  "Match bank transactions by amount"
ruleType
string
 Default:  "match"
Type of bank transaction rule. A match rule matches incoming bank transactions to existing Sage Intacct transactions. A create rule uses the incoming bank transactions to create new Sage Intacct transactions and automatically match them. 


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


 
key
string
System-assigned unique key for the location.


 
 Example:  "122"
id
string
Unique identifier of the location.


 
 Example:  "1-Lyon"
Array of objects  non-empty 
Specifies a filter used in the bank transaction rule.


 
 Array (non-empty)
dataSource
string
Indicates if the filter should be applied to a bank transaction or an Intacct transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Specifies which Intacct transaction field to include in the bank transaction rule filter.


 Enum: "baseAmount" "baseCurrency" "description" "documentDate" "documentNumber" null "postingDate" "transactionAmount" "transactionCurrency" "transactionType"  
 Example:  "postingDate"
bankTxnAttribute
string or null
 Default:  null
Specifies which bank transaction field to include in the bank transaction rule filter.


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "transactionType"  
 Example:  "transactionType"
operator
string
Specifies the comparison operator used by the bank transaction rule filter.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Specifies the value used with the comparison operator in the bank transaction rule filter.


 
 Example:  "debit"
order
integer  <= 2 characters 
Indicates the position of this bank transaction rule filter in the processing sequence of the bank transaction rule.


 
 Example:  2
Array of objects
Specifies a group used in the bank transaction rule.


 
 Array 
dataSource
string
Indicates if the bank transaction rule group should be applied to a bank transaction or Intacct transaction.


 Enum: "bankTransaction" "intacctTransaction"  
 Example:  "intacctTransaction"
intacctTxnAttribute
string or null
 Default:  null
Specifies which Intacct transaction field to group transactions by. This is required if dataSource is intacctTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "documentNumber"
bankTxnAttribute
string or null
 Default:  null
Specifies which bank transaction field to group transactions by. This is required if dataSource is bankTransaction.


 Enum: "documentNumber" null "postingDate"  
 Example:  "postingDate"
order
integer  <= 2 characters 
Indicates the position of this bank transaction rule group in the processing sequence of the bank transaction rule.


 
 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
Specifies the match entry used in a bank transaction match rule, required when the rule type is set to match.


 
 Array 
intacctTxnAttribute
string
Specifies which Intacct transaction field to include in the bank transaction rule match entry.


 Enum: "amount" "description" "documentNumber" "postingDate"  
 Example:  "postingDate"
bankTxnAttribute
string
Specifies which bank transaction field to include in the bank transaction rule match entry.


 Enum: "amount" "description" "documentNumber" "documentNumberLeadingZerosRemoved" "postingDate"  
 Example:  "documentNumber"
operator
string
Specifies the comparison operator used by the bank transaction rule match entry.


 Enum: "contains" "equals" "within"  
 Example:  "equals"
value
string
Specifies the value used with the comparison operator in the bank transaction rule match entry.


 
 Example:  "DOC1000"
order
integer
Indicates the position of this bank transaction match entry in the processing sequence of the bank transaction rule.


 
 Example:  2
object
Create rule object used to create new transactions, required when the rule type is set to create.


 
objectType
string or null
 Default:  null
Sage Intacct object type that the bank transaction create rule generates, for example a journal entry.


 Enum: "cctransaction" "journalEntry" null  
 Example:  "journalEntry"
object
Reference to the journal entry template used when the create rule is applied.


 
id
string
Unique identifier of the journal entry template.


 
 Example:  "12"
key
string
System-assigned unique key for the journal entry template.


 
 Example:  "12"
object
Reference to the credit card transaction template used when the create rule is applied.


 
id
string
Unique identifier of the credit card transaction template.


 
 Example:  "5"
key
string
System-assigned unique key for the credit card transaction template.


 
 Example:  "5"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "matchRuleAttributes": [
    • {
      • "key": "33",
      • "order": 2
      },
    • {
      • "key": "34",
      • "intacctTxnAttribute": "postingDate",
      • "bankTxnAttribute": "postingDate",
      • "operator": "within",
      • "value": "4",
      • "order": 1
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "28",
    • "href": "/objects/cash-management/bank-txn-rule/28"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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:  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
    }
}
Query bank transaction rules
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "cash-management/bank-txn-rule"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 has (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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/bank-txn-rule",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "ruleID",
    • "name",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "79",
      • "id": "79",
      • "ruleId": "AMT_DOC_MATCH_003",
      • "name": "Match by amount and document number.",
      • "href": "/objects/cash-management/bank-txn-rule/79"
      },
    • {
      • "key": "102",
      • "id": "102",
      • "ruleId": "MATCH_AMT_DATE_RANGE_015",
      • "name": "Match amount plus date range.",
      • "href": "/objects/cash-management/bank-txn-rule/102"
      },
    • {
      • "key": "119",
      • "id": "119",
      • "ruleId": "JE-TXN-MATCH_1504",
      • "name": "Match all journal entry transactions.",
      • "href": "/objects/cash-management/bank-txn-rule/119"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}