GET
/
api
/
banking
/
rules
[
  {
    "id": 1,
    "name": "Monthly Salary",
    "order": 1,
    "applyIfAccountId": 1,
    "applyIfTransactionType": "deposit",
    "conditionsType": "and",
    "conditions": [
      {
        "id": 1,
        "field": "description",
        "comparator": "contains",
        "value": "Salary"
      }
    ],
    "assignCategory": "InterestIncome",
    "assignAccountId": 1,
    "assignPayee": "Employer Inc.",
    "assignMemo": "Monthly Salary",
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:00:00Z"
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The bank rules have been successfully retrieved.

The response is of type object[].