INinvoiceninja
bank_integrations

Returns a list of Bank Integrations

Changed on

Lists all bank integrations

get/api/v1/bank_integrations

Request

Query parameters

includestring

Include child relations of the BankIntegration object. Format is comma separated.

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[]=created_at|asc.

Only columns on bank_integrations are recognized. 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",
      "provider_bank_name": "Chase Bank",
      "bank_account_id": 1233434,
      "bank_account_name": "My Checking Acc",
      "bank_account_number": "111 234 2332",
      "bank_account_status": "ACTIVE",
      "bank_account_type": "CREDITCARD",
      "balance": 1000000,
      "currency": "USD"
    }
  ],
  "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