Loan writeback

Create bank account transactions

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

Bank account transactions are records of money that has moved in and out of an SMB's bank account.

Integration-specific behavior

Required data may vary by integration. To see what data to post, first call Get create bank transaction model.

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

Request

  • Base URL: https://api.codat.io
  • URL: https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions
  • Auth: API key in header Authorization

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

Unique identifier for a bank account.

transactionsCreateBankAccountTransaction[] (unresolved $ref)

Response

Success

changesPushOperationChange[] nullable(unresolved $ref)

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

dataTypeDataType (unresolved $ref)
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

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.

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

No recorded changes to this operation across all 54 revisions of this API.