Data Formats

Currency

Our API represents currency values using a structured format to ensure clarity and precision. Each currency field includes:

  • label → A human-readable formatted amount with the currency symbol (e.g., "12.000 USD").

  • value → The numeric value of the currency (e.g., 12).

  • currency → The corresponding currency code following the ISO 4217 standard (e.g., "USD").

"customFields": {
    "currency": 
        {
            "label": "12.000 USD",
            "value": 12,
            "currency": "USD"
        }
}        

This format ensures consistency across different currency representations, making it easy for clients to parse and display amounts accurately.

Date and Datetime

Our API returns all date and date-time values in ISO 8601 (RFC 3339 "full-date") format, ensuring consistency across time zones and systems.

Date Format (YYYY-MM-DD)

  • All dates are represented in the full-date format (YYYY-MM-DD).

  • Example: December 30, 2024 is represented as "2024-12-30".

Date-Time Format (YYYY-MM-DDTHH:mm:ss.sssZ)

  • All date-time values are represented in UTC (Coordinated Universal Time) using the YYYY-MM-DDTHH:mm:ss.sssZ format.

  • Example: December 1, 2024, at 18:18:40 UTC is represented as "2024-12-01T18:18:40.599Z".

{
    "customFields" : {
        "dueDate": "2024-12-30",
    },
    "createdAt": "2024-12-01T18:18:40.599Z",
    "updatedAt": "2023-12-01T18:18:40.740Z",
}

Timezone

  • All dates and date-time values follow UTC (Coordinated Universal Time).

  • The "Z" at the end of date-time values (2024-12-01T18:18:40.599Z) indicates that the timestamp is in UTC.

By using ISO 8601 and UTC, our API ensures accurate time representation, making it easier for applications to handle global time differences.

Last updated

Was this helpful?