COcodatio
Bank statements

Start upload session

Changed on

Use the Start upload session endpoint to initiate a bank statement upload session for a given company.

A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded.

You can only have one active session per data type at a time. You can complete or cancel a session using the End upload session endpoint.

post/companies/{companyId}/connections/{connectionId}/bankStatements/upload/startSession

Request

Request body

dataType'banking-accounts' | 'banking-transactions'

A key for a Codat data type.

Response

Success

idstring uuid required

Unique identifier of the pull operation.

companyIdstring uuid required

Unique identifier of the company associated to this pull operation.

connectionIdstring uuid required

Unique identifier of the connection associated to this pull operation.

dataTypestring required

The data type you are requesting in a pull operation.

status'Initial' | 'Queued' | 'Fetching' | 'MapQueued' | 'Mapping' | 'Complete' | 'FetchError' | 'MapError' | 'InternalError' | 'ProcessingQueued' | 'Processing' | 'ProcessingError' | 'ValidationQueued' | 'Validating' | 'ValidationError' | 'AuthError' | 'Cancelled' | 'NotSupported' | 'RateLimitError' | 'PermissionsError' | 'PrerequisiteNotMet' required

The current status of the dataset.

statusDescriptionstring nullable

Additional information about the dataset status.

errorMessagestring nullable

A message about a transient or persistent error returned by Codat or the source platform.

requestedstring 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.

completedstring

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.

progressinteger required

An integer signifying the progress of the pull operation.

isCompletedboolean required

True if the pull operation is completed successfully. The isCompleted property is not queryable. To filter failed pull operations, query by status!=Complete&&status!=NotSupported instead.

isErroredboolean required

True if the pull operation entered an error state.

Example response

{
  "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
  "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
  "connectionId": "51baa045-4836-4317-a42e-3542e991e581",
  "dataType": "invoices",
  "status": "Initial",
  "statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
  "requested": "2022-11-14T11:18:37.2798351Z",
  "progress": 10,
  "isCompleted": false,
  "isErrored": false
}

Changes

  • ce287d49c3ddRevision changes
    • info

      removed the Routing enum value from the response property for the response status

    • info

      removed the RoutingError enum value from the response property for the response status

  • 378cddcac7a6Revision changes
    • info

      endpoint added