Bank transaction rule maps

A bank transaction rule map is used to map 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.

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": 25,
    • "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:  38
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "11",
    • "key": "11",
    • "bankTxnRule": {
      • "id": "11",
      • "key": "11",
      • "ruleId": "gl-create-rule-2",
      • "name": "gl-create-rule-2",
      • "ruleType": "create",
      • "href": "/objects/cash-management/bank-txn-rule/11"
      },
    • "bankTxnRuleSet": {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/cash-management/bank-txn-rule-set/1"
      },
    • "ruleOrder": 7,
    • "audit": {
      • "createdDateTime": "2023-09-13T00:00:00Z",
      • "modifiedDateTime": "2023-09-13T00:00:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/cash-management/bank-txn-rule-map/11"
    },
  • "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:  38
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 rule maps
post/services/core/query
Use the query service to find bank transaction rule maps 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
    }
}