Data formats

This page describes common formats used throughout the APIs.

Dates and times

Vitesse stores all dates and times in UTC (Zulu time).

The API returns date and time values in ISO 8601 format using UTC.

For example:

{
  "CreatedOn": "2019-08-08T15:07:50.1968569Z"
}

The trailing Z indicates Coordinated Universal Time (UTC).

When supplying dates to the API, use one of the following formats:

• YYYY-MM-DD (preferred)
• YYYY/MM/DD
• YYYYMMDD

Dates in batch files

When uploading CSV or Excel files, date interpretation may depend on your regional settings.

For example, the value 06/02/2021 may be interpreted as:

• 6 February 2021 (DD/MM/YYYY) - UK
• 2 June 2021 (MM/DD/YYYY) - US

To avoid ambiguity, always use one of the following formats:

• YYYY-MM-DD
• YYYY/MM/DD
• YYYYMMDD

Currency amounts

The API represents currency amounts as JSON numbers.

For example:

{
  "Balance": 100.39
}

Trailing decimal places are omitted when they are not required. For example:

Currency codes

The API represents currencies using ISO 4217 three-letter currency codes.

For example:

{
  "Currency": "GBP"
}

Country codes

The API represents countries using ISO 3166-1 alpha-2 country codes.

For example:

{
  "Country": "GB"
}