Files

Download all files for a company

The Download files endpoint downloads all files that have been uploaded by to SMB to Codat. A date may be specified to download any files uploaded on the date provided.

get/companies/{companyId}/files/download

Query parameters

datestring

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.

Example:2022-10-23T00:00:00Z

Only download files uploaded on this date.

Response

Success

Changes

Changed in 6 of the 41 revisions of this API.119

Feb 13, 202400025c1df5948See the full diff
- ○
  added the optional property validation to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 402 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 503 status
  response-optional-property-added
Oct 23, 2023d0e6b2e557614See the full diff
- ○
  added the non-success response with the status 402
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
May 26, 20231d0250d3c13a4See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Mar 29, 2023ea6bdbe0b7e011See the full diff
- ●
  deleted the path request parameter companyId
  request-parameter-removed
- ○
  added the media type application/octet-stream for the response with the status 200
  response-media-type-added
Mar 23, 2023a5a1dee958dc1See the full diff
- ○
  for the query request parameter date, the type/format was generalized from string/date-time to string/
  request-parameter-type-generalized
Mar 3, 20234b5d9db87ec11See the full diff
- ○
  the endpoint scheme security API_Key was removed from the API
  api-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history