ores.refdata Messaging Reference

Table of Contents

NATS messaging reference for ores.refdata. All subjects use the refdata.v1.> namespace. See ores.nats for transport details.

Each entity follows the standard pattern: list, save, delete, history.

Countries

Subject Description
refdata.v1.countries.list Retrieve all countries
refdata.v1.countries.save Create or update a country
refdata.v1.countries.delete Delete one or more countries
refdata.v1.countries.history Retrieve version history for a country

Currencies

Subject Description
refdata.v1.currencies.list Retrieve all currencies
refdata.v1.currencies.save Create or update a currency
refdata.v1.currencies.delete Delete one or more currencies
refdata.v1.currencies.history Retrieve version history for a currency

Message types

Request/reply payloads are JSON serialisations of the structs in ores.refdata.api/messaging/currency_protocol.hpp and ores.refdata.api/messaging/currency_history_protocol.hpp:

Subject Request type Request fields Response type Response fields
...currencies.list get_currencies_request offset (int, 0), limit (int, 100) get_currencies_response currencies (currency[]), total_available_count (int)
...currencies.save save_currency_request data (currency) save_currency_response success (bool), message (string)
...currencies.delete delete_currency_request iso_codes (string[]) delete_currency_response success (bool), message (string)
...currencies.history get_currency_history_request iso_code (string) get_currency_history_response success (bool), message (string), history.versions (currency_version[])

Events

Change notification is a single event per entity, not per-operation saved=/=deleted subjects. Defined in ores.refdata.api/eventing/currency_changed_event.hpp:

Event name Payload Published when
ores.refdata.currency_changed timestamp (UTC time point), iso_codes (string[]), tenant_id (string) Any currency is created, updated or deleted; iso_codes may carry several codes for batch operations.

Subscribers receive the event through the ores.nats event channel machinery (ores.eventing.api event_bus / event_channel_registry) and can use timestamp to query for changes since that point.

Parties

Subject Description
refdata.v1.parties.list Retrieve all parties
refdata.v1.parties.save Create or update a party
refdata.v1.parties.delete Delete one or more parties
refdata.v1.parties.history Retrieve version history for a party

Counterparties

Subject Description
refdata.v1.counterparties.list Retrieve all counterparties
refdata.v1.counterparties.save Create or update a counterparty
refdata.v1.counterparties.delete Delete one or more counterparties
refdata.v1.counterparties.history Retrieve version history for a counterparty

Books

Subject Description
refdata.v1.books.list Retrieve all books
refdata.v1.books.save Create or update a book
refdata.v1.books.delete Delete one or more books
refdata.v1.books.history Retrieve version history for a book

Portfolios

Subject Description
refdata.v1.portfolios.list Retrieve all portfolios
refdata.v1.portfolios.save Create or update a portfolio
refdata.v1.portfolios.delete Delete one or more portfolios
refdata.v1.portfolios.history Retrieve version history for a portfolio

Business Units

Subject Description
refdata.v1.business-units.list Retrieve all business units
refdata.v1.business-units.save Create or update a business unit
refdata.v1.business-units.delete Delete one or more business units
refdata.v1.business-units.history Retrieve version history for a business unit

Contact Types

Subject Description
refdata.v1.contact-types.list Retrieve all contact types
refdata.v1.contact-types.save Create or update a contact type
refdata.v1.contact-types.delete Delete one or more contact types
refdata.v1.contact-types.history Retrieve version history for a contact type

Monetary Natures

Subject Description
refdata.v1.monetary-natures.list Retrieve all monetary natures
refdata.v1.monetary-natures.save Create or update a monetary nature
refdata.v1.monetary-natures.delete Delete one or more monetary natures
refdata.v1.monetary-natures.history Retrieve version history for a monetary nature

Rounding Types

Subject Description
refdata.v1.rounding-types.list Retrieve all rounding types
refdata.v1.rounding-types.save Create or update a rounding type
refdata.v1.rounding-types.delete Delete one or more rounding types
refdata.v1.rounding-types.history Retrieve version history for a rounding type

Business Centres

Subject Description
refdata.v1.business-centres.list Retrieve all business centres
refdata.v1.business-centres.save Create or update a business centre
refdata.v1.business-centres.delete Delete one or more business centres
refdata.v1.business-centres.history Retrieve version history for a business centre

Useful Pages