Skip to content

Get all exchange rates

POST
/api/connector/v1/exchangeRates/getAll

Returns all available exchange rates among currencies of the Enterprise.

CurrencyAcceptanceFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Ids

Unique identifiers of the Exchange Rates. If not specified, the operation returns all exchange rates.

Array<string>
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns the exchange rates for all enterprises within scope of the Access Token.

Array<string>
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0"
}

OK

ExchangeRateResult
object
ExchangeRates
required

The available exchange rates.

Array<object>
Exchange rate
object
Id
required

Unique identifier of the Exchange Rate.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise to which the Exchange Rate belongs.

string format: uuid
SourceCurrency
required

ISO-4217 code of the source Currency.

string format: currency
>= 1 characters
TargetCurrency
required

ISO-4217 code of the target Currency.

string format: currency
>= 1 characters
Value
required

The exchange rate from the source currency to the target currency.

number format: double
Example
{
"ExchangeRates": [
{
"SourceCurrency": "EUR",
"TargetCurrency": "GBP",
"Value": 0.8505342
},
{
"SourceCurrency": "GBP",
"TargetCurrency": "EUR",
"Value": 1.1757317
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable