Currency API

The Currency API manages everything related to currencies and exchange rates in the SoftwareOne Marketplace.

With this API, you can define currencies, create currency pairs (for example, EUR:USD), and define and manage exchange rates for those pairs. You can also perform additional operations, including:

  • Updating the currency to modify fields like name, code, precision (not status).

  • Delete a currency (only if not used by a pair), currency pair, or rate.

  • Modify the externalId and notes within a currency pair.

  • Modify the currency rate, for example, to override a rate for hedging.

Core Concepts

The Currency API is built around the following core resources:

  • Currency - Represents the currency that sellers use on the platform to invoice their products.

  • Pairs - Represents a currency pair, for example GBP:EUR.

  • Rates - Represents an exchange rate between two currencies, used by sellers to invoice their products.

Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Currency

Capability
Client
Vendor
Operations
Exchange Module

List currencies

Get currency details

Create currency

Modify currency

Delete currency

Pairs

Capability
Client
Vendor
Operations
Exchange Module

List pairs

Get pair details

Create pair

Modify pair

Delete pair

Rates

Capability
Client
Vendor
Operations
Exchange Module

List rates for a pair

Get specific rate for a pair

Create rate for a pair

Modify rate for a pair

Delete rate for a pair

Last updated

Was this helpful?