---
title: "Gets a new blank bank_transaction rule object"
method: GET
path: "/api/v1/bank_transaction_rules/create"
tags: ["bank_transaction_rules"]
---

# Gets a new blank bank_transaction rule object

`GET /api/v1/bank_transaction_rules/create`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/bank_transaction_rules/create`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/bank_transaction_rules/create/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a blank object with default values

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A blank bank_transaction rule object

- BankTransactionRule
  - `id` string: The bank transaction rules hashed id
  - `user_id` string: The user hashed id
  - `name` string: The name of the transaction
  - `rules` BTRules[]: A mapped collection of the sub rules for the BankTransactionRule
    - `data_key` string: The key to search
    - `operator` string: The operator flag of the search
    - `value` string: The value to search for
  - `auto_convert` boolean: Flags whether the rule converts the transaction automatically
  - `matches_on_all` boolean: Flags whether all subrules are required for the match
  - `applies_to` string: Flags whether the rule applies to a CREDIT or DEBIT
  - `client_id` string: The client hashed id
  - `vendor_id` string: The vendor hashed id
  - `category_id` string: The category hashed id

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `429`: Rate Limit Exceeded
- `5XX`: Server error
- `default`: Unexpected Error

## Changes

- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `id` became read-only for the status `200`
- **2024-06-06** `8e82a2bd77e0`: 2 breaking, 12 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `default`
  - added the optional property `applies_to` to the response with the `200` status
  - added the optional property `auto_convert` to the response with the `200` status
  - …10 more
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-06-05** `4ca478d85068`: 1 breaking, 10 warning
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `applies_to` from the response with the `200` status
  - removed the optional property `auto_convert` from the response with the `200` status
  - removed the optional property `category_id` from the response with the `200` status
  - …7 more
- **2024-03-09** `9772f0a059b2`: 1 info
  - added the non-success response with the status `429`

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/bank_transaction_rules/create/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)