Bank transaction rule maps

A bank transaction rule map links a bank transaction rule to a rule set.

List bank transaction rule maps

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

Returns a collection with a key, ID, and link for each bank transaction rule map. 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-map/1"
      },
    • {
      • "key": "26",
      • "id": "26",
      • "href": "/objects/cash-management/bank-txn-rule-map/26"
      },
    • {
      • "key": "182",
      • "id": "182",
      • "href": "/objects/cash-management/bank-txn-rule-map/182"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a bank transaction rule map
get/objects/cash-management/bank-txn-rule-map/{key}
Returns detailed information for a specified bank transaction rule map.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "2",
    • "key": "2",
    • "bankTxnRule": {
      • "id": "28",
      • "key": "28",
      • "ruleId": "Match_Amt_Plus_Date_Range",
      • "name": "Match amount plus 2 day range",
      • "ruleType": "create",
      • "href": "/objects/cash-management/bank-txn-rule/28"
      },
    • "bankTxnRuleSet": {
      • "id": "2",
      • "key": "2",
      • "href": "/objects/cash-management/bank-txn-rule-set/2"
      },
    • "ruleOrder": 2,
    • "audit": {
      • "createdDateTime": "2025-03-27T00:00:00Z",
      • "modifiedDateTime": "2025-03-27T00:00:00Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "href": "/objects/cash-management/bank-txn-rule-map/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a bank transaction rule map
delete/objects/cash-management/bank-txn-rule-map/{key}
Deletes a bank transaction rule map.


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


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