Skip to main content
POST
Store amortisation rates.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. AmortisationRateData must be non-empty and each row supplies a service AssetId, date-only market date, and non-negative decimal amortisation rate.

Submits dated amortisation-rate observations.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadAmortisationRatesRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

amortisation_rate_data
object[] | null

Dated asset amortisation-rate observations to upload.

Response

Returns whether all rates were stored and errors for invalid providers, empty asset identifiers, negative rates, or write failures.

Returns the success flag and error messages from an amortisation-rate upload.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadAmortisationRatesResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.