INinvoiceninja
bank_transaction_rules

Gets a list of bank_transaction_rules

Changed on

Lists all bank transaction rules

get/api/v1/bank_transaction_rules

Request

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

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
rowsnumber

The number of bank integrations to return

per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=id|desc.

Multiple sorts — for example
sort[]=id|desc&sort[]=name|asc.

Only columns defined for the bank transaction rules model are honored. Unsupported keys are ignored.

[
  "id|desc"
]

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 list of bank integrations

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

  • 89876e7e51d6Revision changes
    • info

      added the new optional query request parameter sort

  • 69a36036d334Revision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      the response optional property // became read-only for the status