Codat

Codat Transactions API

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

GitHub OpenAPI

Operations 17

POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions Create bank transactions #
GET /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions Get create bank transactions model #
GET /companies/{companyId}/push/{pushOperationKey} Get create operation #
GET /companies/{companyId}/push List create operations #
GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions List account transactions #
GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId} Get account transaction #
GET /companies/{companyId}/connections/{connectionId}/data/directCosts List direct costs #
GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId} Get direct cost #
GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId} Get direct cost attachment #
GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download Download direct cost attachment #
GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments List direct cost attachments #
GET /companies/{companyId}/data/journalEntries List journal entries #
GET /companies/{companyId}/data/journalEntries/{journalEntryId} Get journal entry #
GET /companies/{companyId}/data/journals List journals #
GET /companies/{companyId}/data/journals/{journalId} Get journal #
GET /companies/{companyId}/connections/{connectionId}/data/transfers List transfers #
GET /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId} Get transfer #

Documentation

📖
Documentation
https://docs.codat.io/using-the-api/overview
📖
APIReference
https://docs.codat.io/platform-api
📖
Documentation
https://docs.codat.io/lending/overview
📖
APIReference
https://docs.codat.io/lending-api
📖
Documentation
https://docs.codat.io/bank-feeds/overview
📖
APIReference
https://docs.codat.io/bank-feeds-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/openapi/codat-transactions-api-openapi.yml

Other Resources

🔗
OpenAPI Source
https://github.com/codatio/oas
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/graphql/codat-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/codat-transactions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

codat-transactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Codat Transactions API
  version: 3.0.0
  contact:
    email: support@codat.io
    name: Codat
  termsOfService: https://www.codat.io/legals/
  description: 'Operations tagged Transactions across 2 of this provider''s published API definitions: codat-bank-feeds-openapi.json, codat-lending-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: Production
  url: https://api.codat.io
security:
- auth_header: []
tags:
- name: Transactions
  description: Create new bank account transactions for a company's connections, and see previous operations.
paths:
  /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions:
    post:
      tags:
      - Transactions
      summary: Create bank transactions
      description: "\uFEFFThe *Create bank transactions* endpoint creates new [bank transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) are records of monetary amounts that have moved in and out of an SMB's bank account.\n\n**Integration-specific behavior**\n\nThe required properties may vary based on the integration. For detailed requirements specific to each accounting software, refer to the API reference examples.\nAlternatively, you can view the [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bank-transactions-model) for more information."
      operationId: create-bank-transactions
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/connectionId'
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/timeoutInMinutes'
      - name: allowSyncOnPushComplete
        in: query
        schema:
          type: boolean
          default: true
        description: Allow a sync upon push completion.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBankTransactions'
            examples:
              Xero:
                value:
                  accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653
                  transactions:
                  - id: '716422529'
                    date: '2023-08-22T10:21:00'
                    description: Repayment of Credit Card
                    counterparty: Bank of Example
                    reference: Ref-12345
                    reconciled: true
                    amount: 100
                    balance: 100
                    transactionType: Credit
                  - id: '716422530'
                    date: '2023-08-22T10:22:00'
                    description: Amazon Purchase
                    counterparty: Amazon
                    reference: Ref-12346
                    reconciled: false
                    amount: -100
                    balance: 0
                    transactionType: Debit
                  - id: '716422531'
                    date: '2023-08-22T10:23:00'
                    description: Office Supplies
                    counterparty: Office Mart
                    reference: Ref-12347
                    reconciled: false
                    amount: -60
                    balance: -60
                    transactionType: Debit
              QuickBooks Online Bank Feeds:
                value:
                  accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653
                  transactions:
                  - id: '716422529'
                    date: '2023-08-22T10:21:00'
                    description: Repayment of Credit Card
                    amount: 100
                    balance: 100
                    transactionType: Credit
                  - id: '716422530'
                    date: '2023-08-22T10:22:00'
                    description: Amazon Purchase
                    amount: -100
                    balance: 0
                    transactionType: Debit
                  - id: '716422531'
                    date: '2023-08-22T10:23:00'
                    description: Office Supplies
                    amount: -60
                    balance: -60
                    transactionType: Debit
              FreeAgent:
                value:
                  accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653
                  transactions:
                  - id: '716422529'
                    date: '2023-08-22T10:21:00'
                    description: Repayment of Credit Card
                    amount: 100
                    transactionType: Credit
                  - id: '716422530'
                    date: '2023-08-22T10:22:00'
                    description: Amazon Purchase
                    amount: -100
                    transactionType: Debit
                  - id: '716422531'
                    date: '2023-08-22T10:23:00'
                    description: Office Supplies
                    amount: -60
                    transactionType: Debit
              Sage:
                value:
                  accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653
                  transactions:
                  - id: '716422529'
                    date: '2023-08-22T10:21:00'
                    description: Repayment of Credit Card
                    counterparty: Bank of Example
                    reference: Ref-12345
                    amount: 100
                    balance: 100
                    transactionType: Credit
                  - id: '716422530'
                    date: '2023-08-22T10:22:00'
                    description: Amazon Purchase
                    counterparty: Amazon
                    reference: Ref-12346
                    amount: -100
                    balance: 0
                    transactionType: Debit
                  - id: '716422531'
                    date: '2023-08-22T10:23:00'
                    description: Office Supplies
                    counterparty: Office Mart
                    reference: Ref-12347
                    amount: -60
                    balance: -60
                    transactionType: Debit
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBankTransactionsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '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'
    servers:
    - description: Production
      url: https://api.codat.io
  /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions:
    get:
      tags:
      - Transactions
      summary: Get create bank transactions model
      description: 'The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) for a given company and integration.


        [Bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB''s bank account.


        **Integration-specific behavior**


        See the *response examples* for integration-specific indicative models.'
      operationId: get-create-bank-transactions-model
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/connectionId'
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushOption'
              examples: {}
        '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'
    servers:
    - description: Production
      url: https://api.codat.io
  /companies/{companyId}/push/{pushOperationKey}:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - schema:
        type: string
        format: uuid
      name: pushOperationKey
      in: path
      required: true
      description: Push operation key.
    get:
      summary: Get create operation
      tags:
      - Transactions
      operationId: get-create-operation
      x-speakeasy-name-override: get-create-operation
      description: 'The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company.


        Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.


        For bank feeds, your push operations will only relate to the `bankTransactions` data type.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushOperation'
              examples: {}
        '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'
    servers:
    - description: Production
      url: https://api.codat.io
  /companies/{companyId}/push:
    parameters:
    - $ref: '#/components/parameters/companyId'
    get:
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      summary: List create operations
      tags:
      - Transactions
      operationId: list-create-operations
      x-speakeasy-name-override: list-create-operations
      description: "The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company.\n\nWrite operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. \n\nFor bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type."
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushOperations'
              examples: {}
        '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'
    servers:
    - description: Production
      url: https://api.codat.io
  /companies/{companyId}/connections/{connectionId}/data/accountTransactions:
    get:
      tags:
      - Transactions
      summary: List account transactions
      description: "The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection.\n\n[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
      operationId: list-accounting-account-transactions
      x-speakeasy-group: transactions.account-transactions
      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/AccountingAccountTransactions'
              examples:
                Clear Books:
                  value:
                    results:
                    - id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285
                      transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1
                      note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197
                      bankAccountRef:
                        id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
                        name: Undeposited Funds
                      date: '2022-04-19T00:00:00'
                      status: Unreconciled
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197
                        recordRef:
                          id: 38e8c917-0afc-4583-8ffe-1b53ad601197
                          dataType: directIncomes
                        amount: 188.33
                      totalAmount: 188.33
                      modifiedDate: '2023-04-26T12:38:18'
                      sourceModifiedDate: '2022-05-13T01:06:00'
                      metadata:
                        isDeleted: false
                    - id: f2656119-9521-4d51-a24d-003b44c1410b
                      transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946
                      note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8
                      bankAccountRef:
                        id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
                        name: Undeposited Funds
                      date: '2022-04-19T00:00:00'
                      status: Void
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8
                        recordRef:
                          id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8
                          dataType: directIncomes
                        amount: 32095.91
                      totalAmount: 32095.91
                      modifiedDate: '2023-04-26T12:38:18'
                      sourceModifiedDate: '2023-02-13T00:34:00'
                      metadata:
                        isDeleted: false
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 1745
                    _links:
                      current:
                        href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2
                      self:
                        href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions
                      next:
                        href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2
                QuickBooks Desktop:
                  value:
                    results:
                    - id: D7B-933784104
                      transactionId: D7B-933784104
                      bankAccountRef:
                        id: 20000-933270541
                        name: Checking
                      date: '2022-12-01T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - recordRef:
                          id: D7B-933784104
                          dataType: directCosts
                        amount: -1200
                      totalAmount: -1200
                      modifiedDate: '2023-04-26T09:13:23'
                      sourceModifiedDate: '2023-12-16T05:04:10'
                      metadata:
                        isDeleted: false
                    - id: DFA-933785132
                      transactionId: DFA-933785132
                      bankAccountRef:
                        id: 20000-933270541
                        name: Checking
                      date: '2022-12-05T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - recordRef:
                          id: DFA-933785132
                          dataType: directCosts
                        amount: -35
                      totalAmount: -35
                      modifiedDate: '2023-04-26T09:13:23'
                      sourceModifiedDate: '2023-12-16T05:04:11'
                      metadata:
                        isDeleted: false
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 652
                    _links:
                      current:
                        href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2
                      self:
                        href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions
                      next:
                        href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2
                QuickBooks Online Sandbox:
                  value:
                    results:
                    - id: '85'
                      transactionId: '85'
                      note: Opening Balance from Bank
                      bankAccountRef:
                        id: '57'
                        name: Visa Credit Card
                      date: '2015-08-12T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - description: Opening Balance from Bank
                        recordRef:
                          id: PUR-85
                          dataType: directCosts
                        amount: -3831.8
                      totalAmount: -3831.8
                      modifiedDate: '2023-04-26T09:37:16'
                      sourceModifiedDate: '2016-09-12T18:13:07Z'
                      metadata:
                        isDeleted: false
                    - id: '5'
                      transactionId: '5'
                      bankAccountRef:
                        id: '81'
                        name: Current
                      date: '2015-11-24T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - description: contribution to start business
                        recordRef:
                          id: 5-1
                          dataType: directIncomes
                        amount: 10000
                      - description: funds borrowed to start business
                        recordRef:
                          id: 5-2
                          dataType: directIncomes
                        amount: 25000
                      totalAmount: 35000
                      modifiedDate: '2023-04-26T09:37:17'
                      sourceModifiedDate: '2016-09-12T15:26:26Z'
                      metadata:
                        isDeleted: false
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 9141
                    _links:
                      current:
                        href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2
                      self:
                        href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions
                      next:
                        href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2
                QuickBooks Online:
                  value:
                    results:
                    - id: '1'
                      transactionId: '1'
                      note: Opening Balance from Bank
                      bankAccountRef:
                        id: '61'
                        name: Dave PP Current
                      date: '2018-09-21T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - recordRef:
                          id: '1'
                          dataType: directIncomes
                        amount: 170.23
                      totalAmount: 170.23
                      modifiedDate: '2023-01-18T11:03:12'
                      sourceModifiedDate: '2018-12-17T14:56:20Z'
                    - id: '15'
                      transactionId: '15'
                      note: Payment to Google
                      bankAccountRef:
                        id: '61'
                        name: Dave PP Current
                      date: '2018-09-21T00:00:00'
                      status: Unknown
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - description: Payment to Google
                        recordRef:
                          id: PUR-15
                          dataType: directCosts
                        amount: -1.59
                      totalAmount: -1.59
                      modifiedDate: '2023-01-18T11:03:11'
                      sourceModifiedDate: '2018-12-17T14:56:44Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 5984
                    _links:
                      current:
                        href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2
                      self:
                        href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions
                      next:
                        href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2
                Xero:
                  value:
                    results:
                    - id: 74004690-82a1-4810-aaca-6ce575af94b4
                      transactionId: 74004690-82a1-4810-aaca-6ce575af94b4
                      bankAccountRef:
                        id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4
                        name: Business Bank Account
                      date: '2021-12-20T00:00:00'
                      status: Reconciled
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - recordRef:
                          id: 74004690-82a1-4810-aaca-6ce575af94b4
                          dataType: billPayments
                        amount: -7267.2
                      totalAmount: -7267.2
                      modifiedDate: '2023-03-15T20:37:10'
                      sourceModifiedDate: '2021-01-02T22:51:40'
                      metadata:
                        isDeleted: false
                    - id: 65b746c8-9a5d-4a95-8096-d2316fcff592
                      transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592
                      bankAccountRef:
                        id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4
                        name: Business Bank Account
                      date: '2022-02-17T00:00:00'
                      status: Reconciled
                      currency: GBP
                      currencyRate: 1
                      lines:
                      - recordRef:
                          id: 65b746c8-9a5d-4a95-8096-d2316fcff592
                          dataType: payments
                        amount: 4200
                      totalAmount: 4200
                      modifiedDate: '2023-03-15T20:37:10'
                      sourceModifiedDate: '2021-01-02T22:50:58'
                      metadata:
                        isDeleted: false
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 70
                    _links:
                      current:
                        href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2
                      self:
                        href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions
                      next:
                        href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?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'
    servers:
    - description: Production
      url: https://api.codat.io
  /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}:
    get:
      tags:
      - Transactions
      summary: Get account transaction
      operationId: get-accounting-account-transaction
      x-speakeasy-group: transactions.account-transactions
      description: 'The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.


        [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.


        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'
      - name: accountTransactionId
        in: path
        required: true
        schema:
          type: string
        description: Unique identifier for an account transaction.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingAccountTransaction'
              examples:
                Clear Books:
                  value:
                    id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285
                    transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1
                    note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197
                    bankAccountRef:
                      id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
                      name: Undeposited Funds
                    date: '2022-04-19T00:00:00'
                    status: Unreconciled
                    currency: GBP
                    currencyRate: 1
                    lines:
                    - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197
                      recordRef:
                        id: 38e8c917-0afc-4583-8ffe-1b53ad601197
                        dataType: directIncomes
                      amount: 188.33
                    totalAmount: 188.33
                    modifiedDate: '2023-04-26T12:38:18'
                    sourceModifiedDate: '2022-05-13T01:06:00'
                    metadata:
                      isDeleted: false
                QuickBooks Desktop:
                  value:
                    id: D7B-933784104
                    transactionId: D7B-933784104
                    bankAccountRef:
                      id: 20000-933270541
                      name: Checking
                    date: '2022-12-01T00:00:00'
                    status: Unknown
                    currency: GBP
                    currencyRate: 1
                    lines:
                    - recordRef:
                        id: D7B-933784104
                        dataType: directCosts
                      amount: -1200
                    totalAmount: -1200
                    modifiedDate: '2023-04-26T09:13:23'
                    sourceModifiedDate: '2023-12-16T05:04:10'
                    metadata:
                      isDeleted: false
                QuickBooks Online Sandbox:
                  value:
                    id: '85'
                    transactionId: '85'
                    note: Opening Balance from Bank
                    bankAccountRef:
                      id: '57'
                      name: Visa Credit Card
                    date: '2015-08-12T00:00:00'
                    status: Unknown
                    currency: GBP
                    currencyRate: 1
                    lines:
                    - description: Opening Balance from Bank
                      recordRef:
                        id: PUR-85
                        dataType: directCosts
                      amount: -3831.8
                    totalAmount: -3831.8
                    modifiedDate: '2023-04-26T09:37:16'
                    sourceModifiedDate: '2016-09-12T18:13:07Z'
                    metadata:
                      isDeleted: false
                QuickBooks Online:
                  value:
                    id: '1'
                    transactionId: '1'
                    note: Opening Balance from Bank
                    bankAccountRef:
                      id: '61'
                      name: Dave PP Current
                    date: '2018-09-21T00:00:00'
                    status: Unknown
                    currency: GBP
                    currencyRate: 1
                    lines:
                    - recordRef:
                        id: '1'
                        dataType: directIncomes
                      amount: 170.23
                    totalAmount: 170.23
                    modifiedDate: '2023-01-18T11:03:12'
                    sourceModifiedDate: '2018-12-17T14:56:20Z'
                Xero:
                  value:
                    id: 74004690-82a1-4810-aaca-6ce575af94b4
                    transactionId: 74004690-82a1-4810-aaca-6c

# --- truncated at 32 KB (354 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/openapi/codat-transactions-api-openapi.yml