COcodatio
Bank statements

List categorized bank statement accounts

Changed on

The Get categorized bank statement accounts endpoint returns a list of bank accounts associated with categorized transactions for a company.

Before using it, you must call the Generate report endpoint of type categorizedBankStatement.

get/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts

Request

Response

OK

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required(unresolved $ref)

Example response

{
  "results": [
    {
      "sourceRef": {
        "sourceType": "Banking"
      },
      "platformName": "Banking Sandbox",
      "accountProvider": "Lloyds Bank",
      "accountName": "Business Savings Account",
      "accountType": "Debit",
      "currency": "GBP",
      "currentBalance": 0
    },
    {
      "sourceRef": {
        "sourceType": "Banking"
      },
      "platformName": "Banking Sandbox",
      "accountProvider": "Lloyds Bank",
      "accountName": "Banking - Business Credit Card",
      "accountType": "Credit",
      "currency": "GBP",
      "currentBalance": 0
    },
    {
      "sourceRef": {
        "sourceType": "Banking"
      },
      "platformName": "Banking Sandbox",
      "accountProvider": "Lloyds Bank",
      "accountName": "Business Undeposited Funds",
      "accountType": "Debit",
      "currency": "GBP",
      "currentBalance": 0
    },
    {
      "sourceRef": {
        "sourceType": "Banking"
      },
      "platformName": "Banking Sandbox",
      "accountProvider": "Lloyds Bank",
      "accountName": "Business Current Account",
      "accountType": "Debit",
      "currency": "GBP",
      "currentBalance": 0
    }
  ],
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 15,
  "_links": {
    "self": {
      "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts"
    },
    "current": {
      "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=1&pageSize=10"
    },
    "next": {
      "href": "/companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=2&pageSize=10"
    }
  }
}

Changes