Data types
Below is a list of common data types that are used by the Soldo Business API to create consistency across all endpoints.
Amounts
The amounts returned by the Soldo Business API are represented as float numbers following the JSON Schema definition (e.g. 12.34). There are no thousand separators and the decimal separator is a dot.
For transactions, we don't specify the sign as part of the number, so all numbers appear as positive. The sign is specified on a dedicated field called transaction_sign as it applies to any amount that can be found on a transaction.
Example:
# Snippet of response returned by Transactions endpoint
...
"transaction_sign": "Negative",
"amount": 20.12,
"amount_currency": "GBP",
"tx_amount": 23.10,
"tx_amount_currency": "EUR",
"fee_amount": 0.20,
"fee_currency": "GBP",
...
Countries
The country codes returned by the Soldo Business API adhere to the ISO 3166-1 alpha-3 standard. This means that they're represented with three letters (e.g. GBR).
Example:
# Response returned by Addresses endpoint
{
"public_id": "4a66c8c0-a099-11eb-8e7f-06ee2c6f6fb5",
"addressee_name": "John",
"addressee_surname": "Doe",
"line1": "Soldo Software Ltd",
"line2": "C/O WEWORK",
"line3": "119 MARYLEBONE ROAD",
"country": "GBR",
"county": "",
"city": "London",
"post_code": "NW1 5PU",
"default_shipping": true,
"address_type": "REGISTERED",
"address_category": "COMPANY",
"creation_time": "2023-08-22T15:36:09Z",
"last_update": "2024-11-12T16:03:34Z"
}
Currencies
The currencies returned by the Soldo Business API adhere to the ISO 4217 standard. This means that they're represented with three letters (e.g. GBP).
Example:
# Response returned by Wallets endpoint
{
"id": "7a358051-19ba-11e7-b7cf-06f210f068eb",
"name": "GBP",
"currency_code": "GBP",
"available_amount": 1234567.89,
"blocked_amount": 0.0,
"primary_user_type": "main",
"label": "AA",
"visible": true,
"creation_time": "2020-09-22T11:22:19Z",
"last_update": "2022-11-22T20:37:47Z"
}
Dates and times
The date and time fields returned by the Soldo Business API adhere to the ISO 8601 standard. They are represented like this:
| Type | Format | Example |
|---|---|---|
| Date | yyyy-MM-dd | 2024-02-15 |
| Datetime | yyyy-MM-ddTHH:mm:ssZ | 2024-02-15T12:14:00Z |
The API timezone is UTC (GMT+0)
The timezone applied to all date and time fields returned by the Soldo Business API is UTC (GMT+0). You'll need to make your own time conversion to get the date and time in your local timezone.
Example:
# Snippet of response returned by Transactions endpoint
...
"date": "2024-01-06T13:47:00",
"settlement_date": "2024-01-08T19:34:42Z",
"update_time": "2024-01-19T13:35:52Z",
...
Time zones
The time zones returned by the Soldo Business API follow the tz database format (e.g. Europe/London).
Example:
# Response returned by Company endpoint
{
"name": "Soldo Software Ltd",
"vat_number": "204213566",
"company_account_id": "ABCD1234",
"shipping_address": {
"public_id": "4a66c8c0-a099-11eb-8e7f-06ee2c6f6fb5",
"addressee_name": "John",
"addressee_surname": "Doe",
"line1": "Soldo Software Ltd",
"line2": "C/O WEWORK",
"line3": "119 MARYLEBONE ROAD",
"country": "GBR",
"county": "",
"city": "London",
"post_code": "NW1 5PU",
"default_shipping": true,
"address_type": "REGISTERED",
"address_category": "COMPANY",
"creation_time": "2023-08-22T15:36:09Z",
"last_update": "2024-11-12T16:03:34Z"
},
"time_zone": "Europe/London",
"market": "GBR"
}
Updated 9 months ago