COcodatio
Account transactions

List account transactions

Changed on

The List account transactions endpoint returns a list of account transactions for a given company's connection.

Account transactions 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.

get/companies/{companyId}/connections/{connectionId}/data/accountTransactions

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

connectionIdstring uuid required

Unique identifier for a company's data connection.

Example:2e9d2c44-f675-40ba-8049-353bfcb5e171

Unique identifier for a connection.

Query parameters

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring
Example:-modifiedDate

Field to order results by. Read more.

Response

Success

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

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

  • 4bfab0afa6caRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0fcc5f736d86Revision changes
    • warning

      added the new bankTransactions enum value to the /////// response property for the response status

    • warning

      added the new billCreditNotes enum value to the /////// response property for the response status

    • warning

      added the new billPayments enum value to the /////// response property for the response status

    • warning

      added the new bills enum value to the /////// response property for the response status

    • warning

      added the new creditNotes enum value to the /////// response property for the response status

    • warning

      added the new directCosts enum value to the /////// response property for the response status

    • warning

      added the new directIncomes enum value to the /////// response property for the response status

    • warning

      added the new invoices enum value to the /////// response property for the response status

    • warning

      added the new journalEntries enum value to the /////// response property for the response status

    • warning

      added the new payments enum value to the /////// response property for the response status

    • warning

      added the new transfers enum value to the /////// response property for the response status