Bank transaction rules define whether to match or create Sage Intacct transactions when processing incoming bank transactions.
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.
OK
Bad Request
{- "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
}
}
Creates a new bank transaction rule.
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 Example: "match" | ||||||||||||||||||
required | Array of objects non-empty Filter attributes for the bank transaction rule. | ||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||
description | string Description of the bank transaction. Example: "Rule for matching bank transactions by amount" | ||||||||||||||||||
object Location where the bank transaction rule was created. | |||||||||||||||||||
| |||||||||||||||||||
Array of objects Group attributes for the bank transaction rule. | |||||||||||||||||||
Array
| |||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||
Array of objects Matching condition attributes for a match rule. Required when ruletype is match. | |||||||||||||||||||
Array
| |||||||||||||||||||
object Transaction template object needed to create transactions. Required when ruletype is create. | |||||||||||||||||||
|
Created
Bad Request
{- "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"
}
]
}
{- "ia::result": {
- "key": "15",
- "id": "15",
- "href": "/objects/cash-management/bank-txn-rule/15"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified bank transaction rule..
key required | string System-assigned key for the bank transaction rule. Example: 11 |
OK
Bad Request
{- "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": {
- "id": "1",
- "key": "1",
- "href": "/objects/cash-management/journal-entry-template/1"
}, - "creditCardTxnTemplate": {
- "id": null,
- "key": null
}
}, - "status": "active",
- "location": {
- "key": null
}, - "rulesetCount": 0,
- "audit": {
- "createdDateTime": "2023-08-03T16:38:31Z",
- "modifiedDateTime": "2023-08-03T16:38:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "filterAttributes": [
- {
- "id": "81",
- "key": "81",
- "bankTransactionRule": {
- "id": "79",
- "key": "79",
- "href": "/objects/cash-management/bank-txn-rule/79"
}, - "dataSource": "bankTransaction",
- "intacctTxnAttribute": null,
- "bankTxnAttribute": "postingDate",
- "operator": "greaterThan",
- "value": "01/10/2022",
- "order": 0,
- "href": "/objects/cash-management/bank-txn-rule-filter/81"
}, - {
- "id": "82",
- "key": "82",
- "bankTransactionRule": {
- "id": "79",
- "key": "79",
- "href": "/objects/cash-management/bank-txn-rule/79"
}, - "dataSource": "bankTransaction",
- "intacctTxnAttribute": null,
- "bankTxnAttribute": "transactionType",
- "operator": "equals",
- "value": "payment",
- "order": 1,
- "href": "/objects/cash-management/bank-txn-rule-filter/82"
}
], - "groupAttributes": [ ],
- "matchRuleAttributes": [ ],
- "href": "/objects/cash-management/bank-txn-rule/79"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing bank transaction rule by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the bank transaction rule. Example: 11 |
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 Example: "match" | ||||||||||||||||||
object Location where the bank transaction rule was created. | |||||||||||||||||||
| |||||||||||||||||||
Array of objects non-empty Filter attributes for the bank transaction rule. | |||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||
Array of objects Group attributes for the bank transaction rule. | |||||||||||||||||||
Array
| |||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||||
Array of objects Matching condition attributes for a match rule. Required when ruletype is match. | |||||||||||||||||||
Array
| |||||||||||||||||||
object Transaction template object needed to create transactions. Required when ruletype is create. | |||||||||||||||||||
|
OK
Bad Request
{- "matchRuleAttributes": [
- {
- "key": "7",
- "order": 5
}, - {
- "key": "11",
- "intacctTxnAttribute": "description",
- "bankTxnAttribute": "description",
- "operator": "contains",
- "value": "abc1000",
- "order": 10
}
]
}
{- "ia::result": {
- "key": "4",
- "id": "4",
- "href": "/objects/cash-management/bank-txn-rule/4"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a bank transaction rule.
key required | string System-assigned key for the bank transaction rule. Example: 11 |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/bank-txn-rule" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}