Codat
Codat Bank statements API

Retrieve banking data from linked bank accounts.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Bank Feeds Account mapping Bank statements API
  version: 3.0.0
  contact:
    email: support@codat.io
    name: Codat
  description: 'Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software.


    A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting software.


    [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas)


    ---

    <!-- Start Codat Tags Table -->

    ## Endpoints


    | Endpoints | Description |

    | :- |:- |

    | Companies | Create and manage your SMB users'' companies. |

    | Connections | Create new and manage existing data connections for a company. |

    | Source accounts | Provide and manage lists of source bank accounts. |

    | Account mapping | Extra functionality for building an account management UI. |

    | Company information | Get detailed information about a company from the underlying platform. |

    | Transactions | Create new bank account transactions for a company''s connections, and see previous operations. |

    <!-- End Codat Tags Table -->'
  termsOfService: https://www.codat.io/legals/
servers:
- description: Production
  url: https://api.codat.io
security:
- auth_header: []
tags:
- name: Bank statements
  description: Retrieve banking data from linked bank accounts.
paths:
  /companies/{companyId}/reports/enhancedCashFlow/transactions:
    parameters:
    - $ref: '#/components/parameters/companyId'
    get:
      summary: Get categorized bank statement
      operationId: get-categorized-bank-statement
      x-speakeasy-group: banking.categorized-statement
      description: "\uFEFF> **Categorization engine**\n>\n> The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.\n\nThe _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources."
      tags:
      - Bank statements
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnhancedCashFlowTransactions'
              examples:
                Categorized bank statement:
                  $ref: '#/components/examples/EnhancedCashflowExample'
        '400':
          $ref: '#/components/responses/Malformed-Query'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
  /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances:
    get:
      tags:
      - Bank statements
      summary: List account balances
      operationId: list-banking-account-balances
      x-speakeasy-group: banking.account-balances
      description: "The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection.\n\n[Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/connectionId'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankingAccountBalances'
              examples:
                Basiq:
                  value:
                    results:
                    - accountId: 4811e776-6187-48d9-afee-635fb0d89d93
                      balance:
                        current: 11389.85
                      date: '2017-12-31T00:00:00Z'
                      modifiedDate: '2022-10-28T07:15:07Z'
                    - accountId: 4811e776-6187-48d9-afee-635fb0d89d93
                      balance:
                        current: 8002.09
                      date: '2018-01-01T00:00:00Z'
                      modifiedDate: '2022-10-28T07:15:07Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 3103
                    _links:
                      current:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=1&pageSize=2
                      self:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances
                      next:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=2&pageSize=2
                Plaid:
                  value:
                    results:
                    - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                      balance:
                        current: 205.78
                      date: '2022-10-13T00:00:00'
                      modifiedDate: '2022-10-27T10:50:16Z'
                    - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                      balance:
                        current: 205.78
                      date: '2022-10-14T00:00:00'
                      modifiedDate: '2022-10-27T10:50:16Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 14
                    _links:
                      current:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=1&pageSize=2
                      self:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances
                      next:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=2&pageSize=2
        '400':
          $ref: '#/components/responses/Malformed-Query'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
  /companies/{companyId}/connections/{connectionId}/data/banking-accounts:
    get:
      tags:
      - Bank statements
      summary: List accounts
      operationId: list-banking-accounts
      x-speakeasy-group: banking.accounts
      description: "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/connectionId'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankingAccounts'
              examples:
                Basiq:
                  value:
                    results:
                    - id: 4811e776-6187-48d9-afee-635fb0d89d93
                      name: Hooli Saver
                      holder: david smith
                      type: Debit
                      balance:
                        available: 2932.85
                        current: 2932.85
                      identifiers:
                        type: Account
                        number: '14293919644182'
                        bankCode: 416-982
                      currency: AUD
                      institution:
                        id: AU00000
                        name: Hooli Bank
                      modifiedDate: '2022-10-28T07:14:48Z'
                      sourceModifiedDate: '2022-10-27T13:00:00Z'
                      accountName: Hooli Saver
                      accountHolder: david smith
                      accountType: Debit
                      accountNumbers:
                        type: Account
                        number: '14293919644182'
                        bankCode: 416-982
                    - id: 736d90a5-f836-4ae0-a161-1e8056f39701
                      name: Standard Variable Rate Home Loan
                      holder: david smith
                      type: Credit
                      balance:
                        available: 6940.31
                        current: 6940.31
                      identifiers:
                        type: Loan
                        number: '14293919644183'
                        bankCode: 416-982
                      currency: AUD
                      institution:
                        id: AU00000
                        name: Hooli Bank
                      modifiedDate: '2022-10-28T07:14:48Z'
                      sourceModifiedDate: '2022-10-27T13:00:00Z'
                      accountName: Standard Variable Rate Home Loan
                      accountHolder: david smith
                      accountType: Credit
                      accountNumbers:
                        type: Loan
                        number: '14293919644183'
                        bankCode: 416-982
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 4
                    _links:
                      current:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2
                      self:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts
                      next:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2
                Plaid:
                  value:
                    results:
                    - id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                      name: Plaid Silver Standard 0.1% Interest Saving
                      informalName: Plaid Saving
                      type: Debit
                      balance:
                        available: 200
                        current: 210
                      identifiers:
                        type: Depository
                        number: '1111222233331111'
                        bankCode: '00021'
                        maskedAccountNumber: '1111'
                      currency: CAD
                      institution:
                        id: ins_100533
                        name: American Express (CA)
                      modifiedDate: '2022-10-27T10:50:16Z'
                      accountName: Plaid Silver Standard 0.1% Interest Saving
                      accountType: Debit
                      accountNumbers:
                        type: Depository
                        number: '1111222233331111'
                        bankCode: '00021'
                        maskedAccountNumber: '1111'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 1
                    _links:
                      current:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2
                      self:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts
        '400':
          $ref: '#/components/responses/Malformed-Query'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
  /companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}:
    get:
      tags:
      - Bank statements
      summary: Get account
      operationId: get-banking-account
      x-speakeasy-group: banking.accounts
      description: 'The *Get account* endpoint returns a single account for a given accountId.


        [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.


        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).'
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/connectionId'
      - $ref: '#/components/parameters/accountingAccountId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankingAccount'
              examples:
                Basiq:
                  value:
                    id: 4811e776-6187-48d9-afee-635fb0d89d93
                    name: Hooli Saver
                    holder: david smith
                    type: Debit
                    balance:
                      available: 2932.85
                      current: 2932.85
                    identifiers:
                      type: Account
                      number: '14293919644182'
                      bankCode: 416-982
                    currency: AUD
                    institution:
                      id: AU00000
                      name: Hooli Bank
                    modifiedDate: '2022-10-28T07:14:48Z'
                    sourceModifiedDate: '2022-10-27T13:00:00Z'
                    accountName: Hooli Saver
                    accountHolder: david smith
                    accountType: Debit
                    accountNumbers:
                      type: Account
                      number: '14293919644182'
                      bankCode: 416-982
                Plaid:
                  value:
                    id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                    name: Plaid Silver Standard 0.1% Interest Saving
                    informalName: Plaid Saving
                    type: Debit
                    balance:
                      available: 200
                      current: 210
                    identifiers:
                      type: Depository
                      number: '1111222233331111'
                      bankCode: '00021'
                      maskedAccountNumber: '1111'
                    currency: CAD
                    institution:
                      id: ins_100533
                      name: American Express (CA)
                    modifiedDate: '2022-10-27T10:50:16Z'
                    accountName: Plaid Silver Standard 0.1% Interest Saving
                    accountType: Debit
                    accountNumbers:
                      type: Depository
                      number: '1111222233331111'
                      bankCode: '00021'
                      maskedAccountNumber: '1111'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
  /companies/{companyId}/connections/{connectionId}/data/banking-transactions:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      tags:
      - Bank statements
      operationId: list-banking-transactions
      x-speakeasy-group: banking.transactions
      summary: List transactions
      description: "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: Success
          content:
            application/json:
              x-speakeasy-usage-example: true
              schema:
                $ref: '#/components/schemas/BankingTransactions'
              examples:
                Basiq:
                  value:
                    results:
                    - id: 00017a94-c681-448d-ba8d-585a81b4128f
                      accountId: feb76128-7650-4b02-a323-e1606146be0c
                      description: 'RENTALCARTOLLPH131865 PARRAMATTA  AU Card xx0399 Value Date: 25/07/2019'
                      amount: -14.26
                      currency: AUD
                      postedDate: '2019-07-31T00:00:00Z'
                      code: Unknown
                      merchantName: ''
                      transactionCategoryRef:
                        id: payment
                        name: Payment
                      modifiedDate: '2022-10-28T07:15:10Z'
                    - id: 0023c431-35c8-41f5-b75e-9239413cde7e
                      accountId: 4811e776-6187-48d9-afee-635fb0d89d93
                      description: Transfer from xx9263 CommBank app Shop
                      amount: 191
                      currency: AUD
                      postedDate: '2018-07-31T00:00:00Z'
                      code: Unknown
                      merchantName: ''
                      transactionCategoryRef:
                        id: transfer
                        name: Transfer
                      modifiedDate: '2022-10-28T07:15:10Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 3319
                    _links:
                      current:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=1&pageSize=2
                      self:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions
                      next:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=2&pageSize=2
                Plaid:
                  value:
                    results:
                    - id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513
                      accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                      description: CREDIT CARD 3333 PAYMENT *//
                      amount: -25
                      currency: CAD
                      postedDate: '2021-05-10T00:00:00'
                      authorizedDate: '2021-05-09T00:00:00'
                      code: Unknown
                      transactionCategoryRef:
                        id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER
                        name: TRANSFER_OUT_ACCOUNT_TRANSFER
                      modifiedDate: '2022-10-27T10:50:25Z'
                    - id: 1514wvMMajumgG7xWA1Bt8oDLxlpm3i3zraD7_6DB63D1DACF6F5824C80F8BE2E066DB5
                      accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                      description: CREDIT CARD 3333 PAYMENT *//
                      amount: -25
                      currency: CAD
                      postedDate: '2022-10-02T00:00:00'
                      authorizedDate: '2022-10-01T00:00:00'
                      code: Unknown
                      transactionCategoryRef:
                        id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER
                        name: TRANSFER_OUT_ACCOUNT_TRANSFER
                      modifiedDate: '2022-10-27T10:50:25Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 49
                    _links:
                      current:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=1&pageSize=2
                      self:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions
                      next:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=2&pageSize=2
        '400':
          $ref: '#/components/responses/Malformed-Query'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
  /companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    - schema:
        type: string
      name: transactionId
      in: path
      required: true
      description: The unique identifier for a transaction
    get:
      summary: Get bank transaction
      tags:
      - Bank statements
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankingTransaction'
              examples:
                Basiq:
                  value:
                    id: 00017a94-c681-448d-ba8d-585a81b4128f
                    accountId: feb76128-7650-4b02-a323-e1606146be0c
                    description: 'RENTALCARTOLLPH131865 PARRAMATTA  AU Card xx0399 Value Date: 25/07/2019'
                    amount: -14.26
                    currency: AUD
                    postedDate: '2019-07-31T00:00:00Z'
                    code: Unknown
                    merchantName: ''
                    transactionCategoryRef:
                      id: payment
                      name: Payment
                    modifiedDate: '2022-10-28T07:15:10Z'
                Plaid:
                  value:
                    id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513
                    accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB
                    description: CREDIT CARD 3333 PAYMENT *//
                    amount: -25
                    currency: CAD
                    postedDate: '2021-05-10T00:00:00'
                    authorizedDate: '2021-05-09T00:00:00'
                    code: Unknown
                    transactionCategoryRef:
                      id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER
                      name: TRANSFER_OUT_ACCOUNT_TRANSFER
                    modifiedDate: '2022-10-27T10:50:25Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      description: 'The *Get transaction* endpoint returns a single transaction for a given transactionId.


        [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.


        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).

        '
      operationId: get-banking-transaction
      x-speakeasy-group: banking.transactions
  /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      tags:
      - Bank statements
      operationId: list-banking-transaction-categories
      x-speakeasy-group: banking.transaction-categories
      summary: List transaction categories
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankingTransactionCategories'
              examples:
                Basiq:
                  value:
                    results:
                    - id: bank-fee
                      name: Bank Fee
                      hasChildren: false
                      status: Active
                      modifiedDate: '2022-10-28T07:14:46'
                    - id: cash-withdrawal
                      name: Cash Withdrawal
                      hasChildren: false
                      status: Active
                      modifiedDate: '2022-10-28T07:14:46'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 9
                    _links:
                      current:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=1&pageSize=2
                      self:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories
                      next:
                        href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=2&pageSize=2
                Plaid:
                  value:
                    results:
                    - id: BANK_FEES
                      name: BANK_FEES
                      hasChildren: true
                      status: Active
                      modifiedDate: '2022-10-27T10:50:17'
                    - id: BANK_FEES.BANK_FEES_ATM_FEES
                      name: BANK_FEES_ATM_FEES
                      parentId: BANK_FEES
                      hasChildren: false
                      status: Active
                      modifiedDate: '2022-10-27T10:50:17'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 120
                    _links:
                      current:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=1&pageSize=2
                      self:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories
                      next:
                        href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=2&pageSize=2
        '400':
          $ref: '#/components/responses/Malformed-Query'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      description: "The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection.\n\n[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
  /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    - schema:
        type: string
      name: transactionCategoryId
      in: path
      required: true
      description: The unique identifier for a banking transaction category
    get:
      tags:
      - Bank statements
      operationId: get-banking-transaction-category
      x-speakeasy-group: banking.transaction-categories
      summary: Get transaction category
      description: 'The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.


        [Transaction categories](https://docs.codat.io/lending-api#/schemas/Transactio

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/openapi/codat-bank-statements-api-openapi.yml
Codat Bank statements API

Documentation

Specifications

Other Resources

OpenAPI Specification
