List a page of bank accounts where the ID is greater than the optionally supplied fromthisid parameter

GET /bankaccount/list/{fromthisid}

OAuth2

List is limited to those bank accounts the logged in user can see. Returned in ID order.

Path parameters

fromthisid integer Required

The ID that is previous to the one to start from e.g. if IDs are 1,2,3 fromthisid as 1 will return 2,3

Responses

200 application/json

List returned OK
Hide response attributes Show response attributes object
- id integer
  
  Minimum value is 1.
- bank_code string
  
  Optional parts of a bank account code. Use as required by your bank account coding configurations. Free text
  
  Maximum length is 5.
- branch_code string
  
  Optional parts of a bank account code. Use as required by your bank account coding configurations. Free text
  
  Maximum length is 255.
- bank_account_id string
  
  Optional parts of a bank account code. Use as required by your bank account coding configurations. Free text
  
  Maximum length is 255.
- bank_account_code string
  
  Optional parts of a bank account code. Use as required by your bank account coding configurations. Free text
  
  Maximum length is 100.
- currency_code string
  
  Which 3 character code for this currency
  
  Maximum length is 20.
- account_type string
  
  Optional. Describes the type of bank account
  
  Maximum length is 50.
- name string
  
  Name of the bank account
  
  Maximum length is 255.
- description string
  
  Description the bank account
  
  Maximum length is 255.
- xero_account_id string
  
  If this is a xero account code, its the ID in xero. Read only
  
  Maximum length is 100.
- xero_status string
  
  shows if the code is still available in xero. Blank if its not a xero account code. Read only
  
  Maximum length is 50. Values are OK or No longer in Xero.
- for_group_id integer
  
  If the user is a clustered login, then this must be supplied. Otherwise its optional but must link to a group the login has access to.
401 application/json

Authentication unauthorised
Hide response attribute Show response attribute object
- error string
403 application/json

Invalid permission
Hide response attribute Show response attribute object
- error string

GET /bankaccount/list/{fromthisid}

curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/bankaccount/list/4 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "id": 123,
    "bank_code": 12,
    "branch_code": 3122,
    "bank_account_id": "029321-209",
    "bank_account_code": "12-309123-1390291123-10232",
    "currency_code": "NZD",
    "account_type": "checking",
    "name": "ASB Donations Account",
    "description": "Used to manage all donations",
    "xero_account_id": "62f28bd8-3d47-4302-88a3-dc6ff53d8126",
    "xero_status": "OK",
    "for_group_id": 543
  }
]

Response examples (401)

{
  "error": "Unauthorised"
}

Response examples (403)

{
  "error": "Invalid Permission"
}