Bank transaction assignment rules

Bank transaction assignment rules automatically assign a customer to an unmatched bank deposit transaction in a checking or savings account based on pre-defined criteria.

For more information, read about assignment rules for bank transactions in the Sage Intacct Help Center.

List bank transaction assignment rules

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

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


SecurityOAuth2 
Request 
Request Body schema: application/json
required
ruleId
required
string
User-assigned identifier of the bank transaction assignment rule.


 
 Example:  "ASSIGN_CUST_DEP_001"
name
required
string
Name of the bank transaction assignment rule.


 
 Example:  "Assign Customer to Unmatched Deposit Transactions"
required
Array of objects  non-empty 
Filter attributes for the bank transaction assignment rule.


 
 Array (non-empty)
bankTxnAttribute
string or null
 Default:  null
Indicates the bankTxnAttribute used for filtering the assignment rule and used along with operator and value.


For example, selecting txnType, with an operator of equals and a value of debit will apply to all debit transactions.


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "txnType"  
 Example:  "txnType"
operator
string
Indicates the operator used for filtering the assignment rule and used along with bankTxnAttribute and value.


For example, selecting equals, with a bank transaction attribute of txnType and a value of debit will apply to all debit transactions.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Indicates the value used for filtering the assignment rule and used along with bankTxnAttribute and operator.


For example, selecting debit, with a bank transaction attribute of txnType and an operator of equals will apply to all debit transactions.


 
 Example:  "debit"
filterOrder
integer  <= 2 characters 
Specifies the order in which this filter attribute is applied to the bank transaction assignment rule.


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


 
 Example:  "Links unmatched bank deposit transactions to a customer based on keywords in the transaction description."
accountType
string
 Default:  "bank"
Indicates the associated account to which the assignment rule applies, either a bank account or a creditCard.


 Enum: "bank" "creditCard"  
 Example:  "bank"
object
Specifies the customer associated with the bank transaction assignment rule.


 
key
required
string
Unique key for the customer.


 
 Example:  "15"
id
string
Identifier for the customer.


 
 Example:  "BTI"
name
string
Name of  the customer.


 
 Example:  "joy"
object
Specifies the bank account that receives the payment from the customer.


 
key
string
Unique key for bank account.


 
 Example:  "1"
id
string
Identifier for the bank account.


 
 Example:  "Chase - 340293"
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "customer": {
    • "key": "15"
    },
  • "bankAccount": {
    • "key": "157",
    • "id": "Chase - 340293",
    • "href": "/objects/cash-management/bank-account/157"
    },
  • "ruleId": "ASSIGN_CUST_DEP_001",
  • "name": "Assign Customer to Unmatched Deposit Transactions",
  • "description": "Links unmatched bank deposit transactions to a customer based on keywords in the transaction description.",
  • "filterAttributes": [
    • {
      • "bankTxnAttribute": "txnType",
      • "operator": "equals",
      • "value": "debit",
      • "filterOrder": 1
      },
    • {
      • "bankTxnAttribute": "description",
      • "operator": "contains",
      • "value": "Blue Wave Digital",
      • "filterOrder": 2
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "3",
    • "href": "/objects/cash-management/bank-txn-assignment-rule/3"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bank transaction assignment rule
get/objects/cash-management/bank-txn-assignment-rule/{key}
Returns detailed information for a specified bank transaction assignment rule.


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


 
 Example:  153
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3",
    • "key": "3",
    • "ruleId": "ASSIGN_CUST_DEP_001",
    • "name": "Assign Customer to Unmatched Deposit Transactions",
    • "description": "Links unmatched bank deposit transactions to a customer based on keywords in the transaction description.",
    • "assignmentType": "customer",
    • "status": "active",
    • "customer": {
      • "key": "15",
      • "id": "BTI",
      • "href": "/objects/accounts-receivable/customer/15"
      },
    • "accountType": "bank",
    • "bankAccount": {
      • "key": "157",
      • "id": "Chase - 340293",
      • "href": "/objects/cash-management/bank-account/157"
      },
    • "audit": {
      • "createdDateTime": "2025-03-27T16:13:03Z",
      • "modifiedDateTime": "2025-03-27T16:13:03Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "filterAttributes": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/cash-management/bank-txn-assignment-rule/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a bank transaction assignment rule
patch/objects/cash-management/bank-txn-assignment-rule/{key}
Updates an existing bank transaction assignment rule by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  153
Request Body schema: application/json
ruleId
string
User-assigned identifier of the bank transaction assignment rule.


 
 Example:  "ASSIGN_CUST_DEP_001"
name
string
Name of the bank transaction assignment rule.


 
 Example:  "Assign Customer to Unmatched Deposit Transactions"
description
string
Description of the bank transaction assignment rule.


 
 Example:  "Links unmatched bank deposit transactions to a customer based on keywords in the transaction description."
accountType
string
 Default:  "bank"
Indicates the associated account to which the assignment rule applies, either a bank account or a creditCard.


 Enum: "bank" "creditCard"  
 Example:  "bank"
object
Specifies the customer associated with the bank transaction assignment rule.


 
key
string
Unique key for the customer.


 
 Example:  "15"
id
string
Identifier for the customer.


 
 Example:  "BTI"
name
string
Name of  the customer.


 
 Example:  "joy"
object
Specifies the bank account that receives the payment from the customer.


 
key
string
Unique key for bank account.


 
 Example:  "1"
id
string
Identifier for the bank account.


 
 Example:  "Chase - 340293"
Array of objects  non-empty 
Filter attributes for the bank transaction assignment rule.


 
 Array (non-empty)
bankTxnAttribute
string or null
 Default:  null
Indicates the bankTxnAttribute used for filtering the assignment rule and used along with operator and value.


For example, selecting txnType, with an operator of equals and a value of debit will apply to all debit transactions.


 Enum: "amount" "currency" "description" "documentNumber" "documentType" "feedType" null "postingDate" "txnType"  
 Example:  "txnType"
operator
string
Indicates the operator used for filtering the assignment rule and used along with bankTxnAttribute and value.


For example, selecting equals, with a bank transaction attribute of txnType and a value of debit will apply to all debit transactions.


 Enum: "beginsWith" "contains" "endsWith" "equals" "greaterThan" "lessThan" "notContains" "within"  
 Example:  "equals"
value
string  <= 200 characters 
Indicates the value used for filtering the assignment rule and used along with bankTxnAttribute and operator.


For example, selecting debit, with a bank transaction attribute of txnType and an operator of equals will apply to all debit transactions.


 
 Example:  "debit"
filterOrder
integer  <= 2 characters 
Specifies the order in which this filter attribute is applied to the bank transaction assignment rule.


 
 Example:  2
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "ruleId": "ASSIGN_CUST_DEP_001",
  • "name": "Assign Customer to Unmatched Deposit Transactions",
  • "description": "Links unmatched bank deposit transactions to a customer based on keywords in the transaction description.",
  • "filterAttributes": [
    • {
      • "key": "10",
      • "filterOrder": 2
      },
    • {
      • "key": "11",
      • "bankTxnAttribute": "description",
      • "operator": "contains",
      • "value": "1000",
      • "filterOrder": 1
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "3",
    • "href": "/objects/cash-management/bank-txn-assignment-rule/3"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bank transaction assignment rule
delete/objects/cash-management/bank-txn-assignment-rule/{key}
Deletes a bank transaction assignment rule.


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


 
 Example:  153
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
    }
}