{"openapi":"3.0.2","info":{"title":"Accumulation API","description":"Api specification of Accumulation API","version":"2026.03.b"},"servers":[{"url":"https://{host}/platform/accumulation/v1/","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com"}}}],"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["json","curl","python","java","csharp","node"],"proxy-enabled":true,"samples-enabled":true},"paths":{"/jobs":{"post":{"tags":["Accumulation Jobs"],"summary":"Create accumulation job","operationId":"createAccumulationJob","parameters":[{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. Operation is assigned to this resource group's quota. See [Resource Groups](doc:resource-management)","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PortfolioAccumulationRequest"},{"$ref":"#/components/schemas/PortfolioVariationAccumulationRequest"},{"$ref":"#/components/schemas/AccountAccumulationRequest"},{"$ref":"#/components/schemas/AccountVariationAccumulationRequest"},{"$ref":"#/components/schemas/BusinessHierarchyAccumulationRequest"}],"discriminator":{"propertyName":"resourceType","mapping":{"portfolio":"#/components/schemas/PortfolioAccumulationRequest","portfolioVariation":"#/components/schemas/PortfolioVariationAccumulationRequest","account":"#/components/schemas/AccountAccumulationRequest","accountVariation":"#/components/schemas/AccountVariationAccumulationRequest","businessHierarchy":"#/components/schemas/BusinessHierarchyAccumulationRequest"},"required":true}}}}},"responses":{"201":{"description":"Success","headers":{"Location":{"description":"location of the job with jobId","schema":{"type":"string","format":"uri","example":"https://api-use1.rms.com/platform/v1/jobs/23112"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Accumulation Jobs"],"summary":"Search accumulation jobs","operationId":"getAccumulationJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. See [Filtering Responses](doc:response-filtering)","schema":{"type":"string"}},{"name":"include-input","in":"query","required":false,"description":"If `true`, analysis returns accumulation analysis settings and data","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSearchResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/jobs/{jobId}":{"get":{"tags":["Accumulation Jobs"],"summary":"Get accumulation job","operationId":"getAccumulationJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Accumulation Jobs"],"summary":"Update accumulation job","operationId":"updateAccumulationJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"requestBody":{"description":"Accumulation job settings","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"Status of accumulation job","type":"string","enum":["CANCELED"]},"priority":{"type":"string","description":"Priority of accumulation job","enum":["high","medium","low","veryhigh","verylow"]}}}}}},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/profiles":{"get":{"tags":["Accumulation Profiles"],"summary":"Search accumulation profiles","operationId":"getAccumulationProfiles","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending). Supported properties include: `createdBy`, `dateCreated`, `dateUpdated`, `id`, `name`, `type`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32"}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationProfileSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/profiles/{profileId}":{"get":{"tags":["Accumulation Profiles"],"summary":"Get accumulation profile","operationId":"getAccumulationProfile","parameters":[{"$ref":"#/components/parameters/ProfileIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulationProfile"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/bulk-batches":{"post":{"tags":["Accumulation Bulk Batches"],"summary":"Create accumulation jobs as bulk batches","operationId":"createAccumulationJobBulkBatches","parameters":[{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. Operation is assigned to this resource group's quota. See [Resource Groups](doc:resource-management)","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBatchAccumulationRequest"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBatchAccumulationResponse"}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBatchAccumulationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"parameters":{"AutoRunParam":{"name":"autorun","in":"query","description":"runs the job immediately if the settings are valid","schema":{"type":"boolean","default":true}},"JobIdParam":{"name":"jobId","in":"path","description":"ID of job.","schema":{"type":"string"},"required":true},"ProfileIdParam":{"name":"profileId","in":"path","description":"ID of accumulation profile","schema":{"type":"number","format":"int64"},"required":true}},"schemas":{"Task":{"type":"object","properties":{"taskId":{"type":"string","format":"int32","description":"ID of task."},"guid":{"type":"string","format":"uuid","description":"Unique ID of task."},"jobId":{"type":"string","description":"ID of job. See [Platform Jobs](ref:platform-jobs).","format":"int64"},"status":{"type":"string","description":"Status of job. One of `PENDING`, `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `CANCEL_REQUESTED`, `CANCELLING`, `CANCELLED`."},"submittedAt":{"type":"string","description":"Time job was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"createdAt":{"type":"string","description":"Time job was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"name":{"type":"string","description":"Name of job."},"percentComplete":{"type":"integer","description":"Percent of job completion.","format":"int32"},"priorTaskGuids":{"type":"array","description":"List of tasks in job.","items":{"type":"string","format":"uuid"}},"output":{"type":"object","properties":{"summary":{"type":"string"},"errors":{"type":"array","description":"List of error messages.","items":{"type":"object","properties":{"message":{"type":"string"}}}},"log":{"type":"object","description":"Log of task processing.","properties":{"accountVariationId":{"type":"integer","format":"int64","description":"RIID of the variation."},"accountVariationGuid":{"type":"string","format":"uuid","description":"UUID of the variation."},"profileId":{"type":"integer","format":"int64","description":"Profile ID."},"profileName":{"type":"string","description":"Name of the profile."},"exposureResourceId":{"type":"integer","format":"int64","description":"RIID of the account (live)."},"exposureResourceType":{"type":"string","enum":["account","portfolio"],"description":"Type of the exposure resource (account or portfolio)."},"exposureResourceName":{"type":"string","description":"Name of the exposure resource (either portfolio or account name)."},"perilCode":{"type":"string","description":"Code representing the peril."},"exposureName":{"type":"string","description":"Name of the exposure (database/EDM name)."},"exposureId":{"type":"integer","format":"int64","description":"RIID of the EDM."},"analysisName":{"type":"string","description":"Name of the accumulation analysis."},"analysisId":{"type":"integer","format":"int64","description":"RIID of the accumulation analysis."},"noOfLocations":{"type":"integer","format":"int32","description":"Total number of locations."}}}}}}},"JobMessage":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"}}},"JobSummary":{"type":"object","properties":{"jobId":{"type":"string","description":"ID of job. See [Platform Jobs](ref:platform-jobs).","format":"int64"},"priority":{"type":"string","description":"Priority of job.","enum":["verylow","low","medium","high","veryhigh"]},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"status":{"type":"string","description":"Status of job.","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string","description":"Time job was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"startedAt":{"type":"string","description":"Time job was started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"endedAt":{"type":"string","description":"Time job ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"name":{"type":"string","description":"Name of job."},"type":{"type":"string","description":"Type of job. See [Platform Jobs](doc:platform-jobs)."},"progress":{"type":"integer","format":"int32","description":"Percent of job completion."},"details":{"type":"object","description":"Detailed information about job and child tasks.","properties":{"resources":{"type":"array","description":"List of <<glossary:resource URI>>s.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}},"summary":{"type":"string"}}}}},"Job":{"type":"object","allOf":[{"$ref":"#/components/schemas/JobSummary"},{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}]},"JobSearchResult":{"type":"array","items":{"$ref":"#/components/schemas/JobSummary"}},"AccumulationProfileSearchResults":{"type":"array","items":{"$ref":"#/components/schemas/AccumulationProfile"}},"NewAccumulationProfile":{"type":"object","properties":{"name":{"type":"string"},"analysisType":{"type":"string","example":"accumulation"},"analysisSubType":{"type":"string","example":"geopoliticalAccumulation"},"profileType":{"type":"string","example":"accumulation"},"profileSubtype":{"type":"string","example":"geopolitical"},"details":{"type":"array","items":{"type":"object","properties":{"detailName":{"type":"string","nullable":true},"properties":{"type":"array","items":{"type":"object","properties":{"propertyKey":{"type":"string"},"propertyValues":{"type":"array","items":{"type":"string"}}}}}}}}}},"AccumulationProfileSummary":{"type":"object","properties":{"profileId":{"type":"number","format":"int64"},"profileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created accumulation profile, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"}}},"AccumulationProfile":{"type":"object","allOf":[{"$ref":"#/components/schemas/AccumulationProfileSummary"}]},"PortfolioAccumulationRequest":{"allOf":[{"type":"object","required":["resourceType","resourceUri","settings"],"properties":{"resourceType":{"type":"string","description":"Type of exposure resource of accumulation analysis. One of `businessHierarchy`, `portfolio`, `portfolioVariation`, `account`, `accountVariation`","enum":["portfolio"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"description":"Settings for portfolio accumulation analysis job.","$ref":"#/components/schemas/PortfolioAccumulationSettings"}}}]},"PortfolioVariationAccumulationRequest":{"allOf":[{"type":"object","required":["resourceType","resourceUri","settings"],"properties":{"resourceType":{"type":"string","description":"Type of exposure resource of accumulation analysis. One of `businessHierarchy`, `portfolio`, `portfolioVariation`, `account`, `accountVariation`","enum":["portfolioVariation"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"description":"Settings for portfolio accumulation analysis job.","$ref":"#/components/schemas/PortfolioVariationAccumulationSettings"}}}]},"AccountAccumulationRequest":{"allOf":[{"type":"object","required":["resourceType","resourceUri","settings"],"properties":{"resourceType":{"type":"string","description":"Type of exposure resource of accumulation analysis. One of `businessHierarchy`, `portfolio`, `portfolioVariation`, `account`, `accountVariation`","enum":["account"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"description":"Settings for account accumulation analysis job.","$ref":"#/components/schemas/AccountAccumulationSettings"}}}]},"AccountVariationAccumulationRequest":{"allOf":[{"type":"object","required":["resourceType","resourceUri","settings"],"properties":{"resourceType":{"type":"string","description":"Type of exposure resource of accumulation analysis. One of `businessHierarchy`, `portfolio`, `portfolioVariation`, `account`, `accountVariation`","enum":["accountVariation"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"description":"Settings for account accumulation analysis job.","$ref":"#/components/schemas/AccountVariationAccumulationSettings"}}}]},"BusinessHierarchyAccumulationRequest":{"allOf":[{"type":"object","required":["resourceType","resourceUri","settings"],"properties":{"resourceType":{"type":"string","enum":["businessHierarchy"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/BusinessHierarchyAccumulationSettings"}}}]},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"}}},"RiskdataResourceRequestObject":{"type":"object","properties":{"resourceUri":{"$ref":"#/components/schemas/RiskdataResource"}}},"RiskdataResource":{"type":"string","description":"URI of exposure resource, e.g. `/platform/riskdata/v1/exposures/123/{exposureType}/12`. See [Resource URIs](doc:resource-uris)","format":"uri"},"PortfolioAccumulationSettings":{"type":"object","required":["portfolioProperties","currency","profileIds","financialPerspectives","eventInfo","name"],"properties":{"portfolioProperties":{"type":"object","description":"Treaties and geocoding engine used in analysis.","properties":{"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"string","format":"int64"}},"geoCodingVersion":{"type":"string","description":"Version of geocoding data used to geocode exposure.","enum":["18.0","18.1","21","22","24"]}}},"name":{"type":"string","description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"message":{"type":"string","description":"Description of the accumulation analysis job."},"currency":{"type":"object","description":"Currency scheme with the version of exchange rates used in the accumulation analysis","properties":{"currency":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"2022-06-01T00:00:00.000Z"}}},"profileIds":{"type":"array","description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","items":{"type":"integer","format":"int32"}},"financialPerspectives":{"description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","type":"array","items":{"type":"string"}},"notes":{"type":"string"},"eventInfo":{"type":"object","properties":{"eventDateBehavior":{"description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable locations, policies, and treaties. \n\n- If `ignore`, the effective dates of locations, policies, and treaties are ignored. All locations are modeled, and all policies and treaties are applicable to events.\n- If `location`, `policyAndLocation`, or `treatyAndPolicyAndLocation`, locations are only modeled if the `eventDate` matches the location's effective dates. \n- If `policy`, `policyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty`, `treatyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","type":"string","enum":["ignore","location","policy","policyAndLocation","treaty","treatyAndLocation","treatyAndPolicy","treatyAndPolicyAndLocation"]},"eventDate":{"description":"Date of event.\n\nDate may filter applicable locations, policies, or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"PortfolioVariationAccumulationSettings":{"type":"object","required":["portfolioProperties","currency","profileIds","financialPerspectives","eventInfo","name"],"properties":{"portfolioProperties":{"type":"object","description":"Treaties and geocoding engine used in analysis.","properties":{"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"string","format":"int64"}}}},"name":{"type":"string","description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"message":{"type":"string","description":"Description of the accumulation analysis job."},"currency":{"type":"object","description":"Currency scheme used in the accumulation analysis.","properties":{"currency":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Vintage of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"2022-06-01T00:00:00.000Z"}}},"profileIds":{"type":"array","description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","items":{"type":"integer","format":"int32"}},"financialPerspectives":{"description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","type":"array","items":{"type":"string"}},"notes":{"type":"string"},"eventInfo":{"type":"object","properties":{"eventDateBehavior":{"description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable locations, policies, and treaties. \n\n- If `ignore`, the effective dates of locations, policies, and treaties are ignored. All locations are modeled, and all policies and treaties are applicable to events.\n- If `location`, `policyAndLocation`, or `treatyAndPolicyAndLocation`, locations are only modeled if the `eventDate` matches the location's effective dates. \n- If `policy`, `policyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty`, `treatyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","type":"string","enum":["ignore","location","policy","policyAndLocation","treaty","treatyAndLocation","treatyAndPolicy","treatyAndPolicyAndLocation"]},"eventDate":{"description":"Date of event.\n\nDate may filter applicable locations, policies, or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"AccountAccumulationSettings":{"type":"object","required":["currency","profileIds","financialPerspectives","eventInfo","name"],"properties":{"name":{"type":"string","description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"message":{"type":"string","description":"Description of the accumulation analysis job."},"currency":{"type":"object","description":"Currency scheme with the version of exchange rates used in the accumulation analysis","properties":{"currency":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"2022-06-01T00:00:00.000Z"}}},"profileIds":{"type":"array","description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","items":{"type":"integer","format":"int32"}},"financialPerspectives":{"description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","type":"array","items":{"type":"string"}},"accountProperties":{"type":"object","description":"Account accumulation job configurations.\n\nDefines list of treaty IDs. Treaty losses are calculated as part of accumulation analysis.","properties":{"treatyIds":{"type":"array","description":"List of treaty IDs.\n\nIf specified, reinsurance treaty is included in accumulation analysis. Supports working excess, surplus share, and quota share treaties.","items":{"type":"integer","format":"int32"}}}},"additionalOutputOptions":{"type":"object","description":"Optional output configurations.","properties":{"includeLossByTreaty":{"type":"boolean","description":"If `true`,  accumulation analysis includes breakdown of losses by treaty.","default":false}},"additionalProperties":false},"notes":{"type":"string"},"eventInfo":{"type":"object","properties":{"eventDateBehavior":{"description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable locations, policies, and treaties. \n\n- If `ignore`, the effective dates of locations, policies, and treaties are ignored. All locations are modeled, and all policies and treaties are applicable to events.\n- If `location`, `policyAndLocation`, or `treatyAndPolicyAndLocation`, locations are only modeled if the `eventDate` matches the location's effective dates. \n- If `policy`, `policyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty`, `treatyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","type":"string","enum":["ignore","location","policy","policyAndLocation","treaty","treatyAndLocation","treatyAndPolicy","treatyAndPolicyAndLocation"]},"eventDate":{"description":"Date of event.\n\nDate may filter applicable locations, policies, or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"AccountVariationAccumulationSettings":{"type":"object","required":["currency","profileIds","financialPerspectives","eventInfo","name"],"properties":{"name":{"type":"string","description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"message":{"type":"string","description":"Description of the accumulation analysis job."},"currency":{"type":"object","description":"Currency scheme used in the accumulation analysis.","properties":{"currency":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Vintage of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"2022-06-01T00:00:00.000Z"}}},"profileIds":{"type":"array","description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","items":{"type":"integer","format":"int32"}},"financialPerspectives":{"description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","type":"array","items":{"type":"string"}},"notes":{"type":"string"},"eventInfo":{"type":"object","properties":{"eventDateBehavior":{"description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable locations, policies, and treaties. \n\n- If `ignore`, the effective dates of locations, policies, and treaties are ignored. All locations are modeled, and all policies and treaties are applicable to events.\n- If `location`, `policyAndLocation`, or `treatyAndPolicyAndLocation`, locations are only modeled if the `eventDate` matches the location's effective dates. \n- If `policy`, `policyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty`, `treatyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","type":"string","enum":["ignore","location","policy","policyAndLocation","treaty","treatyAndLocation","treatyAndPolicy","treatyAndPolicyAndLocation"]},"eventDate":{"description":"Date of event.\n\nDate may filter applicable locations, policies, or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"BusinessHierarchyAccumulationSettings":{"type":"object","required":["profileIds","currency","financialPerspectives","eventInfo","name"],"properties":{"name":{"type":"string","description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"message":{"type":"string","description":"Description of the accumulation analysis job."},"currency":{"type":"object","description":"Currency scheme with the version of exchange rates used in the accumulation analysis","required":["currency","currencySchemeName","currencyVersion","asOfDate"],"properties":{"currency":{"type":"string","description":"Code that identifies currency used to calculate losses. Corresponds to value in currency scheme. If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.\n","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Vintage of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"014-09-10T00:00:00.000Z"}}},"profileIds":{"description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","type":"array","items":{"type":"string","format":"int32"}},"financialPerspectives":{"type":"array","description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","items":{"type":"string"}},"notes":{"type":"string"},"eventInfo":{"type":"object","required":["eventDateBehavior","eventDate"],"properties":{"eventDateBehavior":{"type":"string","description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable policies and treaties.\n\n- If `ignore`, the effective dates of policies and treaties are ignored. Events are covered by all policies and treaties. \n- If `policy` or `treatyAndPolicy`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty` or `treatyAndPolicy`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","enum":["ignore","policy","treaty","treatyAndPolicy"]},"eventDate":{"description":"Date of event. \n\nDate may filter applicable policies or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"BulkBatchAccumulationRequest":{"type":"object","required":["settings","resources"],"properties":{"settings":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/BulkBatchSettings"}},"resources":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/BulkBatchResource"}}}},"BulkBatchSettings":{"type":"object","required":["currency","profileIds","financialPerspectives","eventInfo"],"properties":{"currency":{"type":"object","description":"Currency scheme with the version of exchange rates used in the accumulation analysis","properties":{"currency":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyVersion":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"},"asOfDate":{"type":"string","description":"Effective date of currency vintage.","example":"2022-06-01T00:00:00.000Z"}}},"eventInfo":{"type":"object","properties":{"eventDateBehavior":{"description":"Basis for including events in analysis. \n\nEvents can be excluded based on the effective dates of applicable locations, policies, and treaties. \n\n- If `ignore`, the effective dates of locations, policies, and treaties are ignored. All locations are modeled, and all policies and treaties are applicable to events.\n- If `location`, `policyAndLocation`, or `treatyAndPolicyAndLocation`, locations are only modeled if the `eventDate` matches the location's effective dates. \n- If `policy`, `policyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a policy is applicable to events if the `eventDate` matches the policy's effective dates. \n- If `treaty`, `treatyAndLocation`, `treatyAndPolicy` or `treatyAndPolicyAndLocation`, a treaty is applicable to events if the `eventDate` matches the treaty's effective dates.","type":"string","enum":["ignore","location","policy","policyAndLocation","treaty","treatyAndLocation","treatyAndPolicy","treatyAndPolicyAndLocation"]},"eventDate":{"description":"Date of event.\n\nDate may filter applicable locations, policies, or treaties depending on the value of `eventDateBehavior`.","type":"string","example":"2021-06-14"}}},"financialPerspectives":{"description":"List of financial perspectives. See [Financial Perspectives](doc:financial-perspectives).","type":"array","items":{"type":"string"}},"name":{"type":"string","nullable":true,"description":"Name of accumulation results.\n\n- If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.\n- If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis."},"notes":{"type":"string"},"profileIds":{"type":"array","description":"List of accumulation profiles.\n\nEach accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.","items":{"type":"string"}},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}},"applyProfileTags":{"type":"boolean","default":false}}},"BulkBatchResource":{"type":"object","required":["resourceType","resourceUri"],"properties":{"resourceType":{"type":"string","description":"Type of exposure resource of accumulation analysis. One of `portfolio`, `portfolioVariation`","enum":["portfolio","portfolioVariation"]},"resourceUri":{"type":"string","description":"URI of exposure resource, e.g. `/platform/riskdata/v1/exposures/123/{exposureType}/12`. See [Resource URIs](doc:resource-uris)","format":"uri"},"portfolioProperties":{"$ref":"#/components/schemas/BulkBatchPortfolioProperties"}}},"BulkBatchPortfolioProperties":{"type":"object","properties":{"variationName":{"type":"string"},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int64"}}}},"BulkBatchAccumulationResponse":{"type":"array","items":{"$ref":"#/components/schemas/BulkBatchResourceResult"}},"BulkBatchResourceResult":{"type":"object","required":["resourceUri","status"],"properties":{"resourceUri":{"type":"string","description":"URI of exposure resource, e.g. `/platform/riskdata/v1/exposures/123/{exposureType}/12`. See [Resource URIs](doc:resource-uris)","format":"uri"},"jobId":{"type":"integer","description":"ID of job. See [Platform Jobs](ref:platform-jobs).","format":"int64"},"status":{"type":"string","enum":["accepted","rejected"]},"error":{"$ref":"#/components/schemas/ErrorMessage"}}}},"securitySchemes":{"rms_bearer_token":{"type":"http","description":"RMS tenant specific bearer token to make authorized requests with temporary life span","scheme":"bearer","bearerFormat":"JWT"},"rms_api_key":{"type":"apiKey","name":"Authorization","description":"RMS tenant specific api key to make authorized requests","in":"header"}}}}