activities4

auth6

bank_integrations11

bank_transaction_rules8

bank_transactions9

charts4

claim_license1

client_gateway_tokens7

clients14

companies10

company_gateways8

company_ledger1

company_user1

connected_account1

credits8

Credits1

designs8

documents1

emails1

expense1

expense_categories8

expenses8

export1

group_settings9

health_check1

import1

imports2

invoices12

locations7

logout1

migration3

one_time_token1

payment_terms7

payment_termss1

payments11

ping2

postmark3

preview2

products9

projects9

Purchase Orders11

quotes12

Recurring Invoices11

recurring_expense1

recurring_expenses8

recurring_quotes9

refresh1

reports27

scheduler1

search1

statics1

subscriptions8

support1

system_logs2

tags8

task_schedulers7

task_status8

tasks10

tax_rates7

templates2

tokens8

update2

users11

vendors9

webcron1

webhooks7

Webhooks1

yodlee1

bank_transaction_rules

Gets a new blank bank_transaction rule object

Changed on Apr 20, 2026

Returns a blank object with default values

get/api/v1/bank_transaction_rules/create

Request

Base URL
https://demo.invoiceninja.com
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.

Query parameters

includestring

Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required

Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required

Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

A blank bank_transaction rule object

idstring

The bank transaction rules hashed id

user_idstring

The user hashed id

namestring

The name of the transaction

auto_convertboolean

Flags whether the rule converts the transaction automatically

matches_on_allboolean

Flags whether all subrules are required for the match

applies_tostring

Flags whether the rule applies to a CREDIT or DEBIT

client_idstring

The client hashed id

vendor_idstring

The vendor hashed id

category_idstring

The category hashed id

Example response

{
  "id": "AS3df3A",
  "user_id": "AS3df3A",
  "name": "Rule 1",
  "rules": [
    {
      "data_key": "description,amount",
      "operator": ">",
      "value": "bob"
    }
  ],
  "auto_convert": true,
  "matches_on_all": true,
  "applies_to": "CREDIT",
  "client_id": "AS3df3A",
  "vendor_id": "AS3df3A",
  "category_id": "AS3df3A"
}

Changes

Apr 20, 202669a36036d334 Revision changes
- info
  the response optional property became read-only for the status
Jun 6, 20248e82a2bd77e0 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (11 revisions)