Formats

Some fields have custom formats. These are indicated throughout the API documentation. Hers is a compiled list of all the formats used in the API and examples of how they look.

Type	Format	Description	Examples
string	date	Used for dates, regardless of time.	2024-12-05
string	date-time	Used for dates with a local time, without time zone offset information.	2024-12-05T16:29:27.419
string	offset-date-time	Used for dates with a time in the specified time zone offset.	2024-12-05T16:29:27.419+01:00 2024-12-05T15:29:27.419Z
string	email-address	Used for email addresses.	john.doe@viskan.com
string	url	Used for URLs.	https://viskan.com
string	uuid	Mostly used for various identifiers.	46128c1e-49c6-4c5a-8da8-5d2e2500c13b
decimal	money	Used to represent monetary values. Always two decimals.	199.90
decimal	tax-rate	Used to represent tax rate values. Always a value between 0 and 1, up to 8 decimals.	0.25 (25%) 0.08375 (8.375%)