Transactions

Create bank transactions

Changed on Nov 12, 2024

The Create bank transactions endpoint creates new bank transactions for a given company's connection.

Bank transactions are records of monetary amounts that have moved in and out of an SMB's bank account.

Integration-specific behavior

The required properties may vary based on the integration. For detailed requirements specific to each accounting software, refer to the API reference examples. Alternatively, you can view the Get create bank transaction model for more information.

post/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions

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.

accountIdstring required

Example:13d946f0-c5d5-42bc-b092-97ece17923ab

Unique identifier for an account.

Query parameters

timeoutInMinutesinteger

Time limit for the push operation to complete before it is timed out.

allowSyncOnPushCompleteboolean

Allow a sync upon push completion.

Request body

accountIdstring required

Unique identifier for a bank account.

Example request

{
  "accountId": "13d946f0-c5d5-42bc-b092-97ece17923ab",
  "transactions": [
    {
      "id": "716422529",
      "date": "2023-08-22T10:21:00",
      "description": "Debit for Payment Id sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60",
      "counterparty": "ACME INC",
      "reference": "reference for transaction",
      "amount": 999.99,
      "balance": -999.99
    }
  ]
}

Response

Success

changesPushOperationChange[] nullable(unresolved $ref)

Contains a single entry that communicates which record has changed and the manner in which it changed.

Available data types

companyIdSchema required(unresolved $ref)

pushOperationKeystring uuid required

A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.

dataConnectionKeySchema required(unresolved $ref)

requestedOnUtcstring required

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
Unqualified local time: 2021-11-15T01:00:00
UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

completedOnUtcstring

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
Unqualified local time: 2021-11-15T01:00:00
UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required(unresolved $ref)

errorMessagestring nullable

A message about the error.

validationValidation (unresolved $ref)

statusCodeinteger required

Push status code.

Changes

Nov 12, 2024899965fc1d3b Revision changes
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- info
  the request property // became optional
- info
  the request property // became optional
- info
  the request property // became optional
May 30, 20244537fc0e985d Revision changes
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  the request property became required
- breaking
  the request property became required
- warning
  removed subschema #1 from the / request property allOf list
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- 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
  removed subschema #1 from the /// response property allOf list for the response status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status

Operation history