{ "swagger": "2.0", "info": { "title": "Socotra API Reference", "description": "Socotra REST API Description", "version": "2026.15" }, "paths": { "/products/": { "get": { "operationId": "getProductsUsingGET", "parameters": [ { "in": "path", "name": "configVersion", "required": true, "type": "integer" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductConfigurationResponse" } }, "description": "OK" } }, "deprecated": false } }, "/products/{configVersion}": { "get": { "operationId": "getProductsUsingGET", "parameters": [ { "in": "path", "name": "configVersion", "required": true, "type": "integer" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductConfigurationResponse" } }, "description": "OK" } }, "deprecated": false } }, "/payments/{paymentLocator}": { "patch": { "operationId": "updatePaymentUsingPATCH", "parameters": [ { "in": "body", "name": "paymentActionRequest", "required": true, "schema": { "$ref": "#/definitions/PaymentActionRequest" } }, { "in": "path", "name": "paymentLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getPaymentUsingGET", "parameters": [ { "in": "path", "name": "paymentLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentResponse" }, "description": "OK" } }, "deprecated": false } }, "/roles": { "post": { "operationId": "addRolesUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/RoleCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RoleResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getRolesUsingGET", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/RolesResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks/{name}/diverted/{transactionId}/resend": { "post": { "operationId": "resendDivertedEventsUsingPOST", "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" }, { "in": "path", "name": "transactionId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/cashBalances/{cashBalanceLocator}/disbursements": { "post": { "operationId": "createDisbursementUsingPOST", "parameters": [ { "in": "path", "name": "cashBalanceLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/DisbursementCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DisbursementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/issueNextInvoice": { "post": { "operationId": "issueNextInvoiceUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/users/{userUuid}/assignRoles": { "post": { "operationId": "assignRoleUsingPOST", "parameters": [ { "in": "body", "name": "roleList", "required": true, "schema": { "$ref": "#/definitions/RoleList" } }, { "in": "path", "name": "userUuid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/cancellations/{locator}/price": { "get": { "operationId": "priceCancellationUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{locator}/cancellations": { "post": { "operationId": "createCancellationUsingPOST", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/CancellationRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "listCancellationsUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CancellationResponse" } }, "description": "OK" } }, "deprecated": false } }, "/auxData/{locator}/{key}": { "delete": { "operationId": "deleteAuxDataUsingDELETE", "parameters": [ { "in": "path", "name": "key", "required": true, "type": "string" }, { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getAuxDataUsingGET", "parameters": [ { "in": "path", "name": "key", "required": true, "type": "string" }, { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AuxDataResponse" }, "description": "OK" } }, "deprecated": false } }, "/claim/{claimLocator}/discard": { "post": { "operationId": "discardClaimUsingPOST", "parameters": [ { "in": "path", "name": "claimLocator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/lapse/{lapseLocator}": { "get": { "operationId": "getLapseByLocatorUsingGET", "parameters": [ { "in": "path", "name": "lapseLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/cancellationValue": { "get": { "operationId": "getCancellationValueUsingGET", "parameters": [ { "in": "query", "name": "coverageEndTimestamp", "required": true, "type": "string" }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationValueResponse" }, "description": "OK" } }, "deprecated": false } }, "/payments/{paymentLocator}/reverse": { "post": { "operationId": "reversePaymentUsingPOST", "parameters": [ { "in": "body", "name": "invoicePaymentReversalRequest", "required": false, "schema": { "$ref": "#/definitions/InvoicePaymentReversalRequest" } }, { "in": "path", "name": "paymentLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/{reportLocator}/status": { "get": { "operationId": "getReportStatusUsingGET", "parameters": [ { "in": "path", "name": "reportLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReportStatusResponse" }, "description": "OK" } }, "deprecated": false } }, "/tables/{locator}": { "get": { "operationId": "getTablesByLocator", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/TableResponse" }, "description": "OK" } }, "deprecated": false }, "delete": { "operationId": "deleteTables", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TableResponse" } }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/automatedUnderwritingResult": { "get": { "operationId": "getAutomatedUnderwritingResultUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/{policyholderLocator}/policies": { "get": { "operationId": "getPoliciesForPolicyholder4UsingGET", "parameters": [ { "in": "path", "name": "policyholderLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PolicyResponse" } }, "description": "OK" } }, "deprecated": false } }, "/account/unlock": { "post": { "operationId": "unlockAccountUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/AccountUnlockRequest" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/claim": { "post": { "operationId": "createClaimUsingPOST", "parameters": [ { "in": "body", "name": "createRequest", "required": true, "schema": { "$ref": "#/definitions/ClaimCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClaimResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/quote": { "patch": { "operationId": "quoteEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/repair": { "post": { "operationId": "RepairProductionConfigurationUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "tenantName", "required": true, "type": "string" }, { "in": "formData", "name": "version", "required": true, "type": "integer" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployProductionAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/premiumReports/{premiumReportLocator}/reverse": { "patch": { "operationId": "reversePremiumReportUsingPATCH", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/assets/v1/deploy": { "post": { "operationId": "DeployProductionConfigurationWithoutProductVersioningUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "tenantName", "required": true, "type": "string" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployProductionAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/issue": { "patch": { "operationId": "issueEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/claim": { "post": { "operationId": "runClaimsReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ClaimsReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/price": { "get": { "operationId": "getPolicyPriceUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GetPolicyPriceResponse" }, "description": "OK" } }, "deprecated": false }, "post": { "operationId": "pricePolicyUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceResponse" }, "description": "OK" } }, "deprecated": false } }, "/cancellations/{locator}/issue": { "patch": { "operationId": "issueCancellationUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationResponse" }, "description": "OK" } }, "deprecated": false } }, "/calculation/checkPerilPremium": { "post": { "operationId": "checkPerilPremiumUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/CheckPerilPremiumRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalculationResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/update": { "patch": { "operationId": "updatesEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/endorse": { "post": { "operationId": "issueEndorsementUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyEndorsementIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/auxData/{locator}": { "get": { "operationId": "getAuxDataKeySetUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "query", "name": "page", "required": true, "type": "integer" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AuxDataKeySetResponse" }, "description": "OK" } }, "deprecated": false }, "put": { "operationId": "setAuxDataSetUsingPut", "parameters": [ { "in": "body", "name": "dataSet", "required": true, "schema": { "$ref": "#/definitions/AuxDataSetCreateRequest" } }, { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/gracePeriods": { "get": { "operationId": "getGracePeriodsByPolicyUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GracePeriodResponse" } }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/accept": { "patch": { "operationId": "acceptPolicyQuoteUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/withdraw": { "post": { "operationId": "issueWithdrawalUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/document/renderPolicyDocument": { "post": { "operationId": "renderPolicyDocument", "parameters": [ { "in": "body", "name": "PolicyDocumentRenderRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyDocumentRenderRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DocumentRenderResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/deploy": { "post": { "operationId": "DeployProductionConfigurationWithProductVersioningUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "tenantName", "required": true, "type": "string" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployProductionAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/endorsements": { "get": { "operationId": "getAllEndorsementsByPolicyLocatorUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/EndorsementResponse" } }, "description": "OK" } }, "deprecated": false }, "post": { "operationId": "createEndorsementUsingPOST", "parameters": [ { "in": "body", "name": "endorsementCreateRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementCreateRequest" } }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/paymentSchedule": { "post": { "operationId": "changePaymentScheduleUsingPOST", "parameters": [ { "in": "body", "name": "paymentScheduleChangeRequest", "required": true, "schema": { "$ref": "#/definitions/PaymentScheduleChangeRequest" } }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/discard": { "patch": { "operationId": "discardRenewalUsingPATCH", "parameters": [ { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/cancel": { "post": { "operationId": "issueCancellationUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyCancellationIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatements/{locator}": { "patch": { "operationId": "updateReinstatementUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/ReinstatementUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getReinstatementUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/{policyholderLocator}/invoices": { "get": { "operationId": "getInvoicesForPolicyholderUsingGET", "parameters": [ { "in": "path", "name": "policyholderLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PolicyInvoiceResponse" } }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/quotes": { "get": { "operationId": "getAllQuotesByPolicyLocatorUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PolicyQuoteResponse" } }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/quote": { "patch": { "operationId": "storePolicyQuotePriceUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}/invoice": { "post": { "operationId": "invoiceReinstatementUsingPOST", "parameters": [ { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ReinstatementInvoiceRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/v1/account": { "post": { "operationId": "addAccountUsingPOST", "parameters": [ { "in": "body", "name": "accountRequest", "required": true, "schema": { "$ref": "#/definitions/AccountAddRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountResponse" }, "description": "OK" } }, "deprecated": false } }, "/eventstream/events": { "get": { "operationId": "getEventsUsingGET", "parameters": [ { "in": "query", "name": "endTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "eventType", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "startTimestamp", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EventPageResponse" }, "description": "OK" } }, "deprecated": false } }, "/deployments/versions": { "get": { "operationId": "getVersionsUsingGET", "parameters": [], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationVersionResponse" } }, "description": "OK" } }, "deprecated": false } }, "/configuration/products/{productName}/resources/{resourcesType}/{locator}": { "delete": { "operationId": "deleteResourceByLocatorUsingDELETE", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "path", "name": "productName", "required": true, "type": "string" }, { "in": "path", "name": "resourcesType", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ResourceTimestampResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getResourceByLocatorUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "path", "name": "productName", "required": true, "type": "string" }, { "in": "path", "name": "resourcesType", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ResourceResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy": { "post": { "operationId": "createPolicyUsingPOST", "parameters": [ { "in": "body", "name": "createRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyCreateRequest" } }, { "in": "query", "name": "entities", "required": false, "type": "string" }, { "in": "query", "name": "entitiesAsOfTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "includeReplacedCharacteristics", "required": false, "type": "boolean" }, { "in": "query", "name": "summarizeQuotes", "required": false, "type": "boolean" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks": { "get": { "operationId": "getAllWebhooksUsingGET", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/WebhooksResponse" }, "description": "OK" } }, "deprecated": false }, "put": { "operationId": "putWebhookUsingPUT", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/WebhookRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/WebhookResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/automatedUnderwritingResult": { "get": { "operationId": "getOneEndorsementAutomatedUnderwritingResultUsingGET", "parameters": [ { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "description": "OK" } }, "deprecated": false } }, "/staticDocuments/": { "get": { "operationId": "getStaticDocuments", "parameters": [ { "in": "formData", "name": "effectiveTimestamp", "required": false, "type": "string" }, { "in": "formData", "name": "fileName", "required": false, "type": "string" }, { "in": "formData", "name": "matchMode", "required": false, "schema": { "type": "string", "enum": [ "startsWith", "contains", "equals", "all" ] } } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/StaticDocumentResponse" } }, "description": "OK" } }, "deprecated": false }, "put": { "operationId": "putStaticDocuments", "parameters": [ { "in": "body", "name": "StaticDocumentRequest", "required": true, "schema": { "$ref": "#/definitions/StaticDocumentRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GroupStaticDocumentResponse" }, "description": "OK" } }, "deprecated": false } }, "/calculation/checkExistingPerilPremium": { "post": { "operationId": "checkExistingPerilPremiumUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/CheckExistingPerilPremiumRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalculationResponse" }, "description": "OK" } }, "deprecated": false } }, "/catchUps": { "get": { "operationId": "listCatchUpsUsingGET", "parameters": [ { "in": "query", "name": "cashBalanceLocator", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "string" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "policyholderLocator", "required": false, "type": "string" }, { "in": "query", "name": "policyLocator", "required": false, "type": "string" }, { "in": "query", "name": "totalDue", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CatchUpPagedResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/{userLocator}/roles": { "patch": { "operationId": "updateAccountRolesUsingPATCH", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/AccountRoleUpdateRequest" } }, { "in": "path", "name": "userLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RolesResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/users/{userUuid}/roles": { "get": { "operationId": "getRolesForUserUsingGET", "parameters": [ { "in": "header", "name": "Authorization", "required": true, "type": "string" }, { "in": "path", "name": "userUuid", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SsoRoleModel" } }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/price": { "get": { "operationId": "getOneEndorsementPriceChangeUsingGET", "parameters": [ { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/previewEndorsementPrice": { "post": { "operationId": "previewEndorsementPriceUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyEndorsementIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatements/{locator}/invalidate": { "patch": { "operationId": "invalidateReinstatementUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/integrations/autofill": { "put": { "operationId": "addAutofillOperationUsingPUT", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/AutofillIntegrationCreateRequest" } } ], "responses": { "200": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getAutofillOperationsUsingGET", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/AutofillIntegrationResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/addDocument": { "post": { "operationId": "addDocumentUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "query", "name": "displayName", "required": true, "type": "string" }, { "in": "formData", "name": "document", "required": true, "type": "file" }, { "in": "query", "name": "documentType", "required": true, "type": "string" }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/deployTest": { "post": { "operationId": "DeployTestConfigurationWithoutProductVersioningUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "tenantNameSuffix", "required": false, "type": "string" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployTestAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/scripts/upload": { "post": { "operationId": "updateScriptsUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "file", "required": true, "type": "file" }, { "in": "query", "name": "tenantLocator", "required": false, "type": "string" }, { "in": "query", "name": "tenantName", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/catchUps/{catchupLocator}/invalidate": { "patch": { "operationId": "invalidateCatchUpInvoiceForCashBalanceAccountUsingPATCH", "parameters": [ { "in": "path", "name": "catchupLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CatchUpInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/v1/accounts/password": { "patch": { "operationId": "setOwnPasswordUsingPATCH", "parameters": [ { "in": "body", "name": "passwordRequest", "required": true, "schema": { "$ref": "#/definitions/PasswordChangeRequest" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/account/authenticateAdmin": { "post": { "operationId": "authenticateAdminUsingPOST", "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/AuthenticateRequest" } }, { "in": "query", "name": "hostName", "required": false, "type": "string" }, { "in": "query", "name": "tenantLocator", "required": false, "type": "string" }, { "in": "query", "name": "tenantName", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AuthenticateResponse" }, "description": "OK" } }, "deprecated": false } }, "/integrations/{integrationName}": { "put": { "operationId": "updateExternalServiceIntegrationUsingPUT", "parameters": [ { "in": "path", "name": "integrationName", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ExternalServiceIntegrationUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ExternalServiceIntegrationsResponse" }, "description": "OK" } }, "deprecated": false }, "delete": { "operationId": "deleteExternalServiceIntegrationUsingDELETE", "parameters": [ { "in": "path", "name": "integrationName", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ExternalServiceIntegrationsResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/authenticate": { "post": { "operationId": "authenticateUsingPOST", "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/AuthenticateRequest" } }, { "in": "query", "name": "hostName", "required": false, "type": "string" }, { "in": "query", "name": "tenantName", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AuthenticateResponse" }, "description": "OK" } }, "deprecated": false } }, "/claim/{claimLocator}/update": { "post": { "operationId": "updateClaimUsingPOST", "parameters": [ { "in": "path", "name": "claimLocator", "required": true, "type": "string" }, { "in": "body", "name": "updateRequest", "required": true, "schema": { "$ref": "#/definitions/ClaimUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClaimResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/renewals": { "post": { "operationId": "createRenewalUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "renewalCreateRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getAllRenewalsByPolicyLocatorUsingGET", "parameters": [ { "in": "query", "name": "perilPrices", "required": false, "type": "string" }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "query", "name": "renewalStates", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RenewalResponse" } }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}/close": { "post": { "operationId": "closeReinstatementUsingPOST", "parameters": [ { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}": { "get": { "operationId": "getPolicyQuoteByLocatorUsingGET", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false }, "patch": { "operationId": "updateQuoteUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" }, { "in": "body", "name": "updateRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyQuoteUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false } }, "/disbursements": { "get": { "operationId": "listDisbursementsUsingGET", "parameters": [ { "in": "query", "name": "amount", "required": false, "type": "string" }, { "in": "query", "name": "cashBalanceLocator", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "string" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "policyholderLocator", "required": false, "type": "string" }, { "in": "query", "name": "policyLocator", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DisbursementsPagedResponse" }, "description": "OK" } }, "deprecated": false } }, "/invoice/{invoiceLocator}/writeOff": { "patch": { "operationId": "writeOffUsingPATCH", "parameters": [ { "in": "path", "name": "invoiceLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/cashBalances/{cashBalanceLocator}/invoices": { "post": { "operationId": "createCatchUpInvoiceForCashBalanceAccountUsingPOST", "parameters": [ { "in": "path", "name": "cashBalanceLocator", "required": true, "type": "string" }, { "in": "body", "name": "catchUpInvoiceIssueRequest", "required": true, "schema": { "$ref": "#/definitions/CatchUpInvoiceIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CatchUpInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/cashBalances/{cashBalanceLocator}": { "get": { "operationId": "getCashBalanceByLocatorUsingGET", "parameters": [ { "in": "path", "name": "cashBalanceLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CashBalanceResponse" }, "description": "OK" } }, "deprecated": false } }, "/premiumReports/{premiumReportLocator}/discard": { "patch": { "operationId": "discardPremiumReportUsingPATCH", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/auth/roles": { "get": { "operationId": "getRolesSsoUsingGET", "parameters": [], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SsoRoleModel" } }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}": { "patch": { "operationId": "updateEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getOneEndorsementByLocatorUsingGET", "parameters": [ { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/roles/{roleName}": { "patch": { "operationId": "updateRoleUsingPATCH", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/RoleUpdateRequest" } }, { "in": "path", "name": "roleName", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RoleResponse" }, "description": "OK" } }, "deprecated": false }, "delete": { "operationId": "deleteRoleUsingDELETE", "parameters": [ { "in": "path", "name": "roleName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/discard": { "patch": { "operationId": "discardPolicyQuoteUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false } }, "/invoice/{invoiceLocator}/financialTransactions": { "get": { "operationId": "getFinancialTransactionsForInvoiceUsingGET", "parameters": [ { "in": "path", "name": "invoiceLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GetInvoiceFinancialTransactionsResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/clients": { "post": { "operationId": "addClientUsingPOST", "parameters": [ { "in": "body", "name": "clientModelIn", "required": true, "schema": { "$ref": "#/definitions/SsoClientResponse" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SsoClientResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/premiumReports": { "get": { "operationId": "getPremiumReportsUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportResponse" } }, "description": "OK" } }, "deprecated": false }, "post": { "operationId": "createPremiumReportUsingPOST", "parameters": [ { "in": "body", "name": "createRequest", "required": true, "schema": { "$ref": "#/definitions/PremiumReportCreateRequest" } }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/premiumReports/{premiumReportLocator}": { "get": { "operationId": "getPremiumReportUsingGET", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false }, "patch": { "operationId": "updatePremiumReportUsingPATCH", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" }, { "in": "body", "name": "updateRequest", "required": true, "schema": { "$ref": "#/definitions/PremiumReportUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/subClaim/{subClaimLocator}/reserves": { "get": { "operationId": "getReservesOfSubClaimUsingGET", "parameters": [ { "in": "path", "name": "subClaimLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReservesResponse" }, "description": "OK" } }, "deprecated": false } }, "/tenantassets/v1/custom": { "post": { "operationId": "addCustomWebAssetsUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "file", "required": true, "type": "file" }, { "in": "query", "name": "hostname", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/TenantAssetsResponse" }, "description": "OK" } }, "deprecated": false } }, "/integrations": { "post": { "operationId": "addExternalServiceIntegrationUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ExternalServiceIntegrationAddRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ExternalServiceIntegrationsResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getExternalServiceIntegrationsUsingGET", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/ExternalServiceIntegrationsResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/accept": { "patch": { "operationId": "acceptEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/studio/deploy": { "post": { "operationId": "DeployTestConfigurationWithProductVersioningUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "recreate", "required": true, "type": "boolean" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployTestAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/update": { "patch": { "operationId": "updatesRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/issue": { "post": { "operationId": "issuePolicyUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/cashBalanceLog/records": { "get": { "operationId": "getCashBalanceLogRecordsUsingGET", "parameters": [ { "in": "query", "name": "cashBalanceLocator", "required": false, "type": "string" }, { "in": "query", "name": "endTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "eventType", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "startTimestamp", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CashBalanceLogsPagedResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/{policyholderLocator}": { "get": { "operationId": "getPolicyholderUsingGET", "parameters": [ { "in": "path", "name": "policyholderLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}": { "get": { "operationId": "getPolicyUsingGET", "parameters": [ { "in": "query", "name": "entities", "required": false, "type": "string" }, { "in": "query", "name": "entitiesAsOfTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "includeReplacedCharacteristics", "required": false, "type": "boolean" }, { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "query", "name": "summarizeQuotes", "required": false, "type": "boolean" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/renewAuthentication": { "post": { "operationId": "renewAuthenticationUsingPOST", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/AuthenticateResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/products/{productName}/resources/{resourcesType}": { "get": { "operationId": "getResourcesUsingGET", "parameters": [ { "in": "query", "name": "effectiveTimestamp", "required": false, "type": "string" }, { "in": "path", "name": "productName", "required": true, "type": "string" }, { "in": "formData", "name": "resourceName", "required": false, "type": "string" }, { "in": "path", "name": "resourcesType", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResourceResponse" } }, "description": "OK" } }, "deprecated": false }, "put": { "operationId": "deployResourcesUsingPUT", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "effectiveTimestamp", "required": false, "type": "string" }, { "in": "path", "name": "productName", "required": true, "type": "string" }, { "in": "path", "name": "resourcesType", "required": true, "type": "string" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResourceDeployResponse" } }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/createNew": { "post": { "operationId": "createQuoteFromExistingUsingPOST", "parameters": [ { "in": "body", "name": "addedChanges", "required": false, "schema": { "$ref": "#/definitions/PolicyQuoteUpdateRequest" } }, { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/paidFinancialTransaction": { "post": { "operationId": "runPaidFinancialTransactionReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/FinancialTransactionReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/{policyholderLocator}/overwriteData": { "patch": { "operationId": "overwritePolicyholderDataUsingPATCH", "parameters": [ { "in": "body", "name": "overwriteDataRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyholderOverwriteDataRequest" } }, { "in": "path", "name": "policyholderLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderOverwriteDataResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}/addDocument": { "post": { "operationId": "addDocumentToReinstatementUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "query", "name": "displayName", "required": true, "type": "string" }, { "in": "formData", "name": "document", "required": true, "type": "file" }, { "in": "query", "name": "documentType", "required": true, "type": "string" }, { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/claims/payables": { "post": { "operationId": "createPayableOnSubClaimUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/SubClaimPayableCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SubClaimPayableResponse" }, "description": "OK" } }, "deprecated": false } }, "/payments": { "get": { "operationId": "listPaymentsUsingGET", "parameters": [ { "in": "query", "name": "createdBeforeTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "invoiceLocator", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "policyholderLocator", "required": false, "type": "string" }, { "in": "query", "name": "policyLocator", "required": false, "type": "string" }, { "in": "query", "name": "postedAfterTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "state", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPageResponse" }, "description": "OK" } }, "deprecated": false }, "post": { "operationId": "createPaymentUsingPOST", "parameters": [ { "in": "body", "name": "paymentCreateRequest", "required": true, "schema": { "$ref": "#/definitions/PaymentCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/invalidate": { "patch": { "operationId": "invalidateRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/gracePeriod/{gracePeriodLocator}": { "get": { "operationId": "getGracePeriodUsingGET", "parameters": [ { "in": "path", "name": "gracePeriodLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GracePeriodResponse" }, "description": "OK" } }, "deprecated": false }, "patch": { "operationId": "updateGracePeriodUsingPATCH", "parameters": [ { "in": "path", "name": "gracePeriodLocator", "required": true, "type": "string" }, { "in": "body", "name": "gracePeriodUpdateRequest", "required": true, "schema": { "$ref": "#/definitions/GracePeriodUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GracePeriodResponse" }, "description": "OK" } }, "deprecated": false } }, "/invoice/{invoiceLocator}": { "get": { "operationId": "getInvoiceUsingGET", "parameters": [ { "in": "path", "name": "invoiceLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/previewRenewalPrice": { "post": { "operationId": "previewRenewalPriceUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/RenewalIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/clients/{clientUuid}/regenerateSecret": { "put": { "operationId": "regenerateClientSecretUsingPUT", "parameters": [ { "in": "path", "name": "clientUuid", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "string" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/upgrade": { "patch": { "operationId": "upgradeUsingPATCH", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/PolicyConfigUpgradeRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyConfigUpgradeResponse" }, "description": "OK" } }, "deprecated": false } }, "/tables/": { "get": { "operationId": "getTables", "parameters": [ { "in": "formData", "name": "effectiveTimestamp", "required": false, "type": "string" }, { "in": "formData", "name": "matchMode", "required": false, "schema": { "type": "string", "enum": [ "startsWith", "contains", "equals", "all" ] } }, { "in": "formData", "name": "tableName", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TableResponse" } }, "description": "OK" } }, "deprecated": false }, "put": { "operationId": "deployTables", "parameters": [ { "in": "body", "name": "TableRequest", "required": true, "schema": { "$ref": "#/definitions/TableRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/GroupTableResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/financialTransaction": { "post": { "operationId": "runFinancialTransactionReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/FinancialTransactionReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/disbursements/{disbursementLocator}": { "patch": { "operationId": "updateDisbursementUsingPATCH", "parameters": [ { "in": "path", "name": "disbursementLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/DisbursementActionRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DisbursementResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getDisbursementUsingGET", "parameters": [ { "in": "path", "name": "disbursementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DisbursementResponse" }, "description": "OK" } }, "deprecated": false } }, "/cancellations/{locator}/rescind": { "patch": { "operationId": "rescindCancellationUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationResponse" }, "description": "OK" } }, "deprecated": false } }, "/invoice/{invoiceLocator}/pay": { "post": { "operationId": "payInvoiceUsingPOST", "parameters": [ { "in": "path", "name": "invoiceLocator", "required": true, "type": "string" }, { "in": "body", "name": "invoicePaymentRequest", "required": false, "schema": { "$ref": "#/definitions/InvoicePaymentRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatements/{locator}/accept": { "patch": { "operationId": "acceptReinstatementUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/premiumReports/{premiumReportLocator}/issue": { "patch": { "operationId": "issuePremiumReportUsingPATCH", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/automatedUnderwritingResult": { "get": { "operationId": "getOneRenewalAutomatedUnderwritingResultUsingGET", "parameters": [ { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/select": { "patch": { "operationId": "selectPolicyQuoteUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/deployments/{configVersion}": { "get": { "operationId": "getConfigZipUrlUsingGET", "parameters": [ { "in": "path", "name": "configVersion", "required": true, "type": "integer" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/TenantAssetsUrlResponse" }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/price": { "get": { "operationId": "fetchPolicyQuotePriceUsingGET", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/invalidate": { "patch": { "operationId": "invalidateEndorsementUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/EndorsementActionRequest" } }, { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/cancellations/{locator}": { "get": { "operationId": "getCancellationUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationResponse" }, "description": "OK" } }, "deprecated": false }, "patch": { "operationId": "updateCancellationUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/CancellationUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CancellationResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/unearnedPremium/accountsReceivable": { "post": { "operationId": "runUnearnedPremiumAccountsReceivableReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/UnearnedPremiumReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/media/{locator}": { "get": { "operationId": "getMediaUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/Media" }, "description": "OK" } }, "deprecated": false } }, "/claim/{claimLocator}": { "get": { "operationId": "getClaimUsingGET", "parameters": [ { "in": "path", "name": "claimLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClaimResponse" }, "description": "OK" } }, "deprecated": false } }, "/cashBalances/{sourceCashBalanceLocator}": { "patch": { "operationId": "doCashBalanceTransferUsingPATCH", "parameters": [ { "in": "body", "name": "cashBalanceTransferRequest", "required": true, "schema": { "$ref": "#/definitions/CashBalanceTransferRequest" } }, { "in": "path", "name": "sourceCashBalanceLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CashBalanceTransferResponse" }, "description": "OK" } }, "deprecated": false } }, "/staticDocuments/{locator}": { "delete": { "operationId": "deleteStaticDocument", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/StaticDocumentResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getStaticDocumentByLocator", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/StaticDocumentResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/users/{userUuid}/unassignRoles": { "post": { "operationId": "unassignRoleUsingPOST", "parameters": [ { "in": "body", "name": "roleList", "required": true, "schema": { "$ref": "#/definitions/RoleList" } }, { "in": "path", "name": "userUuid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/configuration/products/{productName}/resources": { "put": { "operationId": "deployBulkResourcesUsingPUT", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "effectiveTimestamp", "required": false, "type": "string" }, { "in": "path", "name": "productName", "required": true, "type": "string" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResourceDeployResponse" } }, "description": "OK" } }, "deprecated": false } }, "/report/claim/reserves": { "post": { "operationId": "runReservesReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ReservesReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks/{name}/unsuspend": { "patch": { "operationId": "unsuspendWebhookUsingPATCH", "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/WebhookResponse" }, "description": "OK" } }, "deprecated": false } }, "/products/policyholder": { "get": { "operationId": "getLatestPolicyholderConfigurationUsingGET", "parameters": [], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderConfigurationResponse" }, "description": "OK" } }, "deprecated": false } }, "/configuration/studio/repair": { "post": { "operationId": "RepairTestConfigurationUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "version", "required": true, "type": "integer" }, { "in": "formData", "name": "zipFile", "required": true, "type": "file" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeployProductionAssetResponse" }, "description": "OK" } }, "deprecated": false } }, "/catchUps/{catchupLocator}": { "get": { "operationId": "getCatchUpInvoiceForCashBalanceAccountUsingGET", "parameters": [ { "in": "path", "name": "catchupLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CatchUpInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/subClaim/{subClaimLocator}/payables": { "get": { "operationId": "getPayablesOfSubClaimUsingGET", "parameters": [ { "in": "path", "name": "subClaimLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SubClaimPayableListsResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/issueRenewal": { "post": { "operationId": "issueRenewalUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/RenewalIssueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks/{name}/diverted": { "get": { "operationId": "getDivertedEventsUsingGET", "parameters": [ { "in": "query", "name": "limit", "required": false, "type": "integer" }, { "in": "path", "name": "name", "required": true, "type": "string" }, { "in": "query", "name": "offset", "required": false, "type": "integer" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/WebhookDivertedEventsResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/discard": { "post": { "operationId": "discardPolicyUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/report/allPolicies": { "post": { "operationId": "runAllPoliciesReportAsyncUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/accept": { "patch": { "operationId": "acceptRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/lambda": { "post": { "operationId": "executeLambdaUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/LambdaRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LambdaResponse" }, "description": "OK" } }, "deprecated": false } }, "/search": { "post": { "operationId": "getSearchResponseUsingPOST", "parameters": [ { "in": "body", "name": "searchRequest", "required": true, "schema": { "$ref": "#/definitions/SearchRequestApi" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SearchResponseApi" }, "description": "OK" } }, "deprecated": false } }, "/document/renderPolicyDocumentFromConfig": { "post": { "operationId": "renderPolicyDocumentFromConfig", "parameters": [ { "in": "body", "name": "PolicyDocumentRenderRequest2", "required": true, "schema": { "$ref": "#/definitions/PolicyDocumentRenderRequest2" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DocumentRenderResponse" }, "description": "OK" } }, "deprecated": false } }, "/claims": { "get": { "operationId": "listClaimsUsingGET", "parameters": [ { "in": "query", "name": "createdAfterTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "createdBeforeTimestap", "required": false, "type": "integer" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClaimPageResponse" }, "description": "OK" } }, "deprecated": false } }, "/subClaim/{subClaimLocator}/summary": { "get": { "operationId": "getSummaryOfSubClaimUsingGET", "parameters": [ { "in": "path", "name": "subClaimLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SubClaimSummary" }, "description": "OK" } }, "deprecated": false } }, "/report/onRisk": { "post": { "operationId": "runOnRiskReportAsyncUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}": { "get": { "operationId": "getReinstatementByLocatorUsingGET", "parameters": [ { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/create": { "post": { "operationId": "createPolicyholderUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyholderCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderResponse" }, "description": "OK" } }, "deprecated": false } }, "/scripts/queryLogs": { "post": { "operationId": "queryUsingPOST", "parameters": [ { "in": "body", "name": "query", "required": true, "schema": { "$ref": "#/definitions/QueryRequest" } }, { "in": "query", "name": "tenantLocator", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/QueryResponse" }, "description": "OK" } }, "deprecated": false } }, "/premiumReports/{premiumReportLocator}/replace": { "post": { "operationId": "replacePremiumReportUsingPOST", "parameters": [ { "in": "path", "name": "premiumReportLocator", "required": true, "type": "string" }, { "in": "body", "name": "replaceRequest", "required": true, "schema": { "$ref": "#/definitions/PremiumReportReplacementRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PremiumReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/snapshot": { "post": { "operationId": "getPolicySnapshotUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicySnapshotRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicySnapshotResponse" }, "description": "OK" } }, "deprecated": false } }, "/account/sso/authenticateClient": { "post": { "operationId": "authenticateClientSsoUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/SsoClientAuthenticateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AuthenticateAdminResponse" }, "description": "OK" } }, "deprecated": false } }, "/integrations/autofill/{locator}": { "get": { "operationId": "getAutofillOperationUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/AutofillCallResponse" }, "description": "OK" } }, "deprecated": false }, "delete": { "operationId": "deleteAutofillOperationUsingDELETE", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/reinstatements/{locator}/price": { "get": { "operationId": "priceReinstatementUsingGET", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks/{name}": { "delete": { "operationId": "deleteWebhookUsingDELETE", "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getWebhookByNameUsingGET", "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/WebhookResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/clients/{clientUuid}": { "delete": { "operationId": "removeClientUsingDELETE", "parameters": [ { "in": "path", "name": "clientUuid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getClientUsingGET", "parameters": [ { "in": "path", "name": "clientUuid", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SsoClientResponse" }, "description": "OK" } }, "deprecated": false } }, "/eventstream/attributedEvents": { "get": { "operationId": "getAttributedEventsUsingGET", "parameters": [ { "in": "query", "name": "endTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "eventType", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "startTimestamp", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EventPageResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/issue": { "patch": { "operationId": "issueRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/removeDocument": { "post": { "operationId": "removeDocumentUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PolicyDocumentRemoveRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/claims/payables/{payableLocator}": { "get": { "operationId": "getPayableByLocatorUsingGET", "parameters": [ { "in": "path", "name": "payableLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SubClaimPayableResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}/removeDocument": { "post": { "operationId": "removeDocumentFromReinstatementUsingPOST", "parameters": [ { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ReinstatementDocumentRemoveRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholders": { "get": { "operationId": "getPolicyholdersUsingGET", "parameters": [ { "in": "query", "name": "createdAfterTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "createdBeforeTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderPageResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/graceLapseReinstatements": { "get": { "operationId": "getGraceLapseReinstatementsUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GraceLapseReinstatementResponse" } }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/claims": { "get": { "operationId": "getClaimsByPolicyUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClaimResponse" } }, "description": "OK" } }, "deprecated": false } }, "/cashBalanceLog/attributedRecords": { "get": { "operationId": "getAttributedCashBalanceLogRecordsUsingGET", "parameters": [ { "in": "query", "name": "cashBalanceLocator", "required": false, "type": "string" }, { "in": "query", "name": "endTimestamp", "required": false, "type": "string" }, { "in": "query", "name": "eventType", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "required": false, "type": "integer" }, { "in": "query", "name": "pagingToken", "required": false, "type": "string" }, { "in": "query", "name": "startTimestamp", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CashBalanceLogsPagedResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/checkInvoices": { "get": { "operationId": "checkInvoicesUsingGET", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CheckInvoicesResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}": { "patch": { "operationId": "updateRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false }, "get": { "operationId": "getOneRenewalByLocatorUsingGET", "parameters": [ { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/search/{searchToken}/{pageNumber}": { "get": { "operationId": "getSearchResponseByPageUsingGET", "parameters": [ { "in": "path", "name": "pageNumber", "required": true, "type": "string" }, { "in": "path", "name": "searchToken", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SearchResponseApi" }, "description": "OK" } }, "deprecated": false } }, "/reinstatements/{locator}/issue": { "patch": { "operationId": "issueReinstatementUsingPATCH", "parameters": [ { "in": "path", "name": "locator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/payableCommissions": { "post": { "operationId": "runPayableCommissionsReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/PayableCommissionsReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/finalize": { "post": { "operationId": "finalizePolicyUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/discard": { "patch": { "operationId": "discardEndorsementUsingPATCH", "parameters": [ { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/EndorsementResponse" }, "description": "OK" } }, "deprecated": false } }, "/policies/{policyLocator}/coverageSummary": { "post": { "operationId": "getPolicyCoverageAtCertainPointInTimeUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/CoverageSummaryRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyCoverageSummaryResponse" }, "description": "OK" } }, "deprecated": false } }, "/reinstatement/{reinstatementLocator}/amountDue": { "post": { "operationId": "getReinstatementAmountDueUsingPOST", "parameters": [ { "in": "path", "name": "reinstatementLocator", "required": true, "type": "string" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ReinstatementAmountDueRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementAmountDueResponse" }, "description": "OK" } }, "deprecated": false } }, "/catchUps/{catchupLocator}/writeOff": { "patch": { "operationId": "writeOffCatchUpInvoiceForCashBalanceAccountUsingPATCH", "parameters": [ { "in": "path", "name": "catchupLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/CatchUpInvoiceResponse" }, "description": "OK" } }, "deprecated": false } }, "/quotes/{quoteLocator}/invalidate": { "patch": { "operationId": "invalidatePolicyQuoteUsingPATCH", "parameters": [ { "in": "path", "name": "quoteLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyQuoteResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/createReinstatement": { "post": { "operationId": "createReinstatementUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/LapseReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/auth/tenants": { "get": { "operationId": "getTenantsUsingGET", "parameters": [], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SsoTenantResponse" } }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/policyWhenIssued": { "get": { "operationId": "getPolicyWithAcceptedRenewalAsIssuedUsingGET", "parameters": [ { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/products/resources/timestamps/": { "get": { "operationId": "getResourcesTimestampsUsingGET", "parameters": [ { "in": "query", "name": "productName", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResourceTimestampResponse" } }, "description": "OK" } }, "deprecated": false } }, "/claims/payables/reversals": { "post": { "operationId": "reversePayableOnSubClaimUsingPOST", "parameters": [ { "in": "body", "name": "reversalRequest", "required": true, "schema": { "$ref": "#/definitions/SubClaimPayableReverseRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/SubClaimPayableResponse" }, "description": "OK" } }, "deprecated": false } }, "/cancellations/{cancellationLocator}/reinstate": { "patch": { "operationId": "reinstateCancellationUsingPATCH", "parameters": [ { "in": "path", "name": "cancellationLocator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/ReinstatementCreateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/ReinstatementResponse" }, "description": "OK" } }, "deprecated": false } }, "/media": { "post": { "operationId": "uploadMediaUsingPOST", "consumes": [ "multipart/form-data" ], "parameters": [ { "in": "formData", "name": "file", "required": true, "type": "file" }, { "in": "query", "name": "fileName", "required": false, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/Media" }, "description": "OK" } }, "deprecated": false } }, "/endorsements/{endorsementLocator}/policyWhenIssued": { "get": { "operationId": "getPolicyWithAcceptedEndorsementAsIssuedUsingGET", "parameters": [ { "in": "path", "name": "endorsementLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/fees": { "patch": { "operationId": "updateFeesUsingPATCH", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "req", "required": true, "schema": { "$ref": "#/definitions/FeeUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyFeeSummaryResponse" }, "description": "OK" } }, "deprecated": false } }, "/policyholder/update": { "post": { "operationId": "updatePolicyholderUsingPOST", "parameters": [ { "in": "body", "name": "updateRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyholderUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyholderResponse" }, "description": "OK" } }, "deprecated": false } }, "/report/claim/payables": { "post": { "operationId": "runClaimsPayablesReportUsingPOST", "parameters": [ { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/ClaimsPayablesReportRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RunReportResponse" }, "description": "OK" } }, "deprecated": false } }, "/webhooks/{name}/diverted/{transactionId}": { "delete": { "operationId": "deleteDivertedEventsUsingDELETE", "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" }, { "in": "path", "name": "transactionId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/price": { "get": { "operationId": "getOneRenewalPriceChangeUsingGET", "parameters": [ { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "description": "OK" } }, "deprecated": false } }, "/renewals/{renewalLocator}/quote": { "patch": { "operationId": "quoteRenewalUsingPATCH", "parameters": [ { "in": "body", "name": "actionRequest", "required": true, "schema": { "$ref": "#/definitions/RenewalActionRequest" } }, { "in": "path", "name": "renewalLocator", "required": true, "type": "string" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/RenewalResponse" }, "description": "OK" } }, "deprecated": false } }, "/deployments/status": { "get": { "operationId": "getCurrentDeploymentStatusUsingGET", "parameters": [ { "in": "query", "name": "tenantName", "required": true, "type": "string" }, { "in": "query", "name": "version", "required": false, "type": "integer" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/DeploymentStatusResponse" }, "description": "OK" } }, "deprecated": false } }, "/policy/{policyLocator}/update": { "post": { "operationId": "updatePolicyUsingPOST", "parameters": [ { "in": "path", "name": "policyLocator", "required": true, "type": "string" }, { "in": "body", "name": "updateRequest", "required": true, "schema": { "$ref": "#/definitions/PolicyUpdateRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/PolicyResponse" }, "description": "OK" } }, "deprecated": false } } }, "definitions": { "PaymentReversalPluginData": { "type": "object", "required": [ "gracePeriodDays", "invoiceAmount", "invoiceDueTimestamp", "invoiceIssueTimestamp", "invoiceLocator", "operationType", "paymentLocator", "policy", "tenantTimeZone" ], "properties": { "gracePeriodDays": { "type": "integer" }, "invoiceAmount": { "type": "number" }, "invoiceDueTimestamp": { "type": "string" }, "invoiceIssueTimestamp": { "type": "string" }, "invoiceLocator": { "type": "string" }, "operationType": { "type": "string", "enum": [ "payment_reversal", "payment_invalidation" ] }, "paymentLocator": { "type": "string" }, "policy": { "$ref": "#/definitions/PluginPolicyInfo" }, "tenantTimeZone": { "type": "string" } } }, "CancellationUpdateRequest": { "type": "object", "properties": { "cancellationCategory": { "type": "string" }, "cancellationComments": { "type": "string" }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "effectiveTimestamp": { "type": "string" }, "name": { "type": "string" } } }, "ValidationFieldError": { "type": "object", "required": [ "code", "ontologyUri", "validatorUri" ], "properties": { "code": { "type": "integer" }, "debug": { "type": "string" }, "message": { "type": "string" }, "ontologyUri": { "type": "string" }, "validatorUri": { "type": "string" } } }, "AccountAddRequest": { "type": "object", "required": [ "email", "name", "password", "type", "username" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "RatingPluginCommissionsResponse": { "type": "object", "required": [ "recipient" ], "properties": { "exactAmount": { "type": "string" }, "recipient": { "type": "string" }, "yearlyAmount": { "type": "string" } } }, "DraftPolicyExposureUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "addPerils", "exposureLocator", "removeFieldGroups", "removePerils", "updateFieldGroups", "updatePerils" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateRequest" } }, "exposureLocator": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "removePerils": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/PerilUpdateRequest" } } } }, "PolicyholderResponse": { "type": "object", "required": [ "createdTimestamp", "entity", "locator", "updatedTimestamp", "version" ], "properties": { "createdTimestamp": { "type": "string" }, "entity": { "$ref": "#/definitions/EntityResponse2" }, "locator": { "type": "string" }, "updatedTimestamp": { "type": "string" }, "version": { "type": "integer" } } }, "SubClaimCreateRequest": { "type": "object", "required": [ "fieldGroups", "perilLocator" ], "properties": { "expenseReserve": { "$ref": "#/definitions/ReserveSetRequest" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "lossReserve": { "$ref": "#/definitions/ReserveSetRequest" }, "perilLocator": { "type": "string" } } }, "DeploymentStatusResponse": { "type": "object", "required": [ "deploymentStatus" ], "properties": { "deploymentStatus": { "type": "string", "enum": [ "INPROGRESS", "DEPLOYED" ] }, "deploymentTimestamp": { "type": "string" }, "version": { "type": "integer" } } }, "EventStreamPolicyQuoteUpdateData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "EventStreamCatchUpInvalidateData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "ReserveVersionResponse": { "type": "object", "required": [ "amount", "timestamp" ], "properties": { "amount": { "type": "number" }, "timestamp": { "type": "string" } } }, "PerilValidationErrors": { "type": "object", "required": [ "hasErrors", "name" ], "properties": { "fieldErrors": { "$ref": "#/definitions/FieldErrors" }, "hasErrors": { "type": "boolean" }, "message": { "type": "string" }, "name": { "type": "string" } } }, "SsoTenantResponse": { "type": "object", "required": [ "hostname", "locator", "name", "timeCreatedInMillisSinceEpoch" ], "properties": { "hostname": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "timeCreatedInMillisSinceEpoch": { "type": "integer" }, "useRolesAndPermissions": { "type": "boolean" } } }, "EventStreamCancellationRescindData": { "type": "object", "required": [ "cancellationLocator", "effectiveDate", "modificationName", "policyLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "effectiveDate": { "type": "integer" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "StaticDocumentResponse": { "type": "object", "required": [ "effectiveTimestamp", "locator", "StaticDocumentName", "url", "urlExpirationTimestamp" ], "properties": { "effectiveTimestamp": { "type": "string" }, "locator": { "type": "string" }, "StaticDocumentName": { "type": "string" }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "ReinstatementConfigurationResponse": { "type": "object", "required": [ "documents" ], "properties": { "defaultDeadlineDays": { "type": "integer" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } } } }, "PolicyCoverageSummaryResponse": { "type": "object", "required": [ "coverageReferenceTimestamp", "documents", "exposures", "locator", "policyHistoryTimestamp", "policyholderLocator", "productName" ], "properties": { "characteristics": { "$ref": "#/definitions/PolicyCharacteristicsResponse" }, "coverageReferenceTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCoverageSummaryResponse" } }, "locator": { "type": "string" }, "policyHistoryTimestamp": { "type": "string" }, "policyholderLocator": { "type": "string" }, "productName": { "type": "string" } } }, "FailureHandlingRequest": { "type": "object", "properties": { "actOnStatusCodes": { "type": "array", "items": { "type": "string" } }, "actOnTimeout": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "none", "divert", "suspend" ] } } }, "ExposureConfigurationResponse": { "type": "object", "required": [ "displayName", "externalDataCalls", "fields", "name", "perils" ], "properties": { "displayName": { "type": "string" }, "externalDataCalls": { "type": "array", "items": { "$ref": "#/definitions/FrontendExternalDataCallConfiguration" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "name": { "type": "string" }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilConfigurationResponse" } } } }, "CheckExistingPerilPremiumRequest": { "type": "object", "required": [ "calculation", "perilDisplayId" ], "properties": { "calculation": { "type": "string" }, "perilDisplayId": { "type": "string" } } }, "ExternalServiceIntegrationsResponse": { "type": "object", "required": [ "externalServiceIntegrations" ], "properties": { "externalServiceIntegrations": { "type": "array", "items": { "$ref": "#/definitions/ExternalServiceIntegrationResponse" } } } }, "ClaimPageResponse": { "type": "object", "required": [ "claims" ], "properties": { "claims": { "type": "array", "items": { "$ref": "#/definitions/ClaimResponse" } }, "pagingToken": { "type": "string" } } }, "SubClaimUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "locator", "removeFieldGroups", "updateFieldGroups" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "expenseReserve": { "$ref": "#/definitions/ReserveSetRequest" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "locator": { "type": "string" }, "lossReserve": { "$ref": "#/definitions/ReserveSetRequest" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "EventStreamPolicyQuoteQuotedData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "EventStreamPolicyUpgradeData": { "type": "object", "required": [ "newConfigVersion", "originalConfigVersion", "policyLocator" ], "properties": { "newConfigVersion": { "type": "integer" }, "originalConfigVersion": { "type": "integer" }, "policyLocator": { "type": "string" } } }, "SecuritySpecification": { "type": "object", "properties": { "hmacEnabled": { "type": "boolean" }, "secret": { "type": "string" }, "secureSSL": { "type": "boolean" }, "tag": { "type": "string" } } }, "CancellationConfigurationResponse": { "type": "object", "properties": { "reasons": { "type": "array", "items": { "$ref": "#/definitions/CancellationReasonConfigurationResponse" } } } }, "PolicyInvoicingConfiguration": { "type": "object", "required": [ "generatingEvent" ], "properties": { "generatingEvent": { "type": "string", "enum": [ "quote", "accept", "issue" ] } } }, "EndorsementCreateRequest": { "type": "object", "required": [ "endorsementName" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "endExposures": { "type": "array", "items": { "type": "string" } }, "endorsementName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "newPolicyEndTimestamp": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "reprice": { "type": "boolean" }, "startTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "application", "quoted", "accepted", "issued" ] }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/EndorsementExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "PremiumReportingInvoiceResponse": { "type": "object", "required": [ "createdTimestamp", "displayId", "documents", "dueTimestamp", "endTimestamp", "invoiceType", "locator", "payments", "policyholderLocator", "policyLocator", "premiumReportLocator", "premiumReportName", "settlementStatus", "startTimestamp", "statuses", "totalDue", "transactionIssued", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportingDocumentResponse" } }, "dueTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "invoiceType": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "cancellation", "reinstatement", "installment", "premiumReporting", "catchUp", "other" ] }, "locator": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportingPaymentResponse" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" }, "premiumReportName": { "type": "string" }, "settlementStatus": { "type": "string", "enum": [ "outstanding", "settled" ] }, "settlementType": { "type": "string", "enum": [ "paid", "writtenOff", "zeroDue", "invalidated", "carriedForward" ] }, "startTimestamp": { "type": "string" }, "statuses": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportingInvoiceStatusAndTimeResponse" } }, "totalDue": { "type": "number" }, "totalDueCurrency": { "type": "string" }, "transactionIssued": { "type": "boolean" }, "updatedTimestamp": { "type": "string" } } }, "UnearnedPremiumReportRequest": { "type": "object", "required": [ "reportTimestamp" ], "properties": { "reportTimestamp": { "type": "string" } } }, "LookupFieldConfiguration": { "type": "object", "required": [ "name", "order", "table", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "match": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "public": { "type": "boolean" }, "table": { "type": "string" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "EventStreamPolicyholderCreateData": { "type": "object", "required": [ "policyholderLocator" ], "properties": { "policyholderLocator": { "type": "string" } } }, "PostIssuancePluginData": { "type": "object", "required": [ "documents", "operation", "policy", "policyLocator" ], "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/PostIssuancePluginDocument" } }, "operation": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "reinstatement", "cancellation" ] }, "policy": { "$ref": "#/definitions/PluginPolicyInfo" }, "policyLocator": { "type": "string" } } }, "EventStreamRenewalInvalidateData": { "type": "object", "required": [ "policyLocator", "renewalLocator" ], "properties": { "policyLocator": { "type": "string" }, "renewalLocator": { "type": "string" } } }, "DateFieldConfiguration": { "type": "object", "required": [ "name", "order", "precision", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "maximum": { "type": "string" }, "maximumOffset": { "$ref": "#/definitions/DateOffsetConfiguration" }, "minimum": { "type": "string" }, "minimumOffset": { "$ref": "#/definitions/DateOffsetConfiguration" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "precision": { "type": "string", "enum": [ "year", "month", "day", "second" ] }, "showCalendar": { "type": "boolean" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "EventStreamPremiumReportEffectiveData": { "type": "object", "required": [ "effectiveTimestamp", "policyLocator", "premiumReportLocator" ], "properties": { "effectiveTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "ExposureCoverageSummaryResponse": { "type": "object", "required": [ "characteristics", "locator", "name", "perils" ], "properties": { "characteristics": { "$ref": "#/definitions/ExposureCharacteristicsResponse" }, "locator": { "type": "string" }, "name": { "type": "string" }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilCoverageSummaryResponse" } } } }, "InvoicePaymentRequest": { "type": "object", "properties": { "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "payment": { "$ref": "#/definitions/PaymentCreateRequest" }, "paymentLocator": { "type": "string" } } }, "EventStreamReinstatementInvoiceData": { "type": "object", "required": [ "invoiceLocator", "policyLocator", "reinstatementLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "FinancialTransactionReportRequest": { "type": "object", "required": [ "endTimestamp", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "RatingPluginCharacteristics": { "type": "object", "required": [ "exposureCharacteristicsLocator", "perilCharacteristicsLocator", "policyCharacteristicsLocator" ], "properties": { "exposureCharacteristicsLocator": { "type": "string" }, "perilCharacteristicsLocator": { "type": "string" }, "policyCharacteristicsLocator": { "type": "string" } } }, "EventStreamEndorsementInvalidateData": { "type": "object", "required": [ "endorsementLocator", "policyLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PerilConfigurationResponse": { "type": "object", "required": [ "displayName", "externalDataCalls", "fields", "name" ], "properties": { "deductible": { "type": "number" }, "displayName": { "type": "string" }, "externalDataCalls": { "type": "array", "items": { "$ref": "#/definitions/FrontendExternalDataCallConfiguration" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "indemnityInAggregate": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "lumpSumPayment": { "type": "number" }, "name": { "type": "string" } } }, "AutofillPayload": { "type": "object", "required": [ "operation", "operationType", "policyholderLocator", "productName", "updates" ], "properties": { "configVersion": { "type": "integer" }, "endorsementLocator": { "type": "string" }, "operation": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "reinstatement", "cancellation", "manual", "feeAssessment" ] }, "operationType": { "type": "string", "enum": [ "create", "update" ] }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "productName": { "type": "string" }, "quoteLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "updates": { "$ref": "#/definitions/AutofillUpdateRequest" } } }, "EventStreamPremiumReportInvoicePaymentData": { "type": "object", "required": [ "invoiceLocator", "paymentLocator", "policyholderLocator", "policyLocator", "premiumReportLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "paymentLocator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "EventStreamClaimCloseData": { "type": "object", "required": [ "claimLocator", "policyLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "CoverageSummaryRequest": { "type": "object", "required": [ "coverageReferenceTimestamp" ], "properties": { "coverageReferenceTimestamp": { "type": "string" }, "policyHistoryTimestamp": { "type": "string" } } }, "DeployTestConfigurationResponse": { "type": "object", "required": [ "hostname", "logfile", "success", "tenantName" ], "properties": { "hostname": { "type": "string" }, "logfile": { "type": "string" }, "success": { "type": "boolean" }, "tenantName": { "type": "string" } } }, "AutofillIntegrationResponse": { "type": "object", "required": [ "calls" ], "properties": { "calls": { "type": "array", "items": { "$ref": "#/definitions/AutofillCallResponse" } } } }, "FailureMessage": { "type": "object", "required": [ "actualStatus", "eventData", "expectedStatus", "url", "webhookName" ], "properties": { "actualStatus": { "type": "string" }, "eventData": { "$ref": "#/definitions/EventStreamData" }, "expectedStatus": { "type": "string" }, "url": { "type": "string" }, "webhookName": { "type": "object" } } }, "EventStreamPolicyQuoteDeclinedData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "EventStreamReinstatementCreateData": { "type": "object", "required": [ "cancellationLocator", "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "CancellationRequest": { "type": "object", "required": [ "effectiveTimestamp", "name" ], "properties": { "cancellationCategory": { "type": "string" }, "cancellationComments": { "type": "string" }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "effectiveTimestamp": { "type": "string" }, "issue": { "type": "boolean" }, "name": { "type": "string" } } }, "TableResponse": { "type": "object", "required": [ "effectiveTimestamp", "locator", "tableName", "url", "urlExpirationTimestamp" ], "properties": { "effectiveTimestamp": { "type": "string" }, "locator": { "type": "string" }, "tableName": { "type": "string" }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "EventStreamCancellationUpdateData": { "type": "object", "required": [ "cancellationLocator", "effectiveDate", "modificationName", "policyLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "effectiveDate": { "type": "integer" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "RatingPluginPriceResponse": { "type": "object", "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/RatingPluginCommissionsResponse" } }, "exactPremium": { "type": "string" }, "exactTechnicalPremium": { "type": "string" }, "yearlyPremium": { "type": "string" }, "yearlyTechnicalPremium": { "type": "string" } } }, "PreGracePluginData": { "type": "object", "required": [ "defaultGracePeriodDays", "invoiceLocator", "policy", "tenantTimeZone" ], "properties": { "defaultGracePeriodDays": { "type": "integer" }, "invoiceLocator": { "type": "string" }, "policy": { "$ref": "#/definitions/PluginPolicyInfo" }, "tenantTimeZone": { "type": "string" } } }, "PaymentSchedulePluginData": { "type": "object", "required": [ "charges", "coverageEndTimestamp", "coverageStartTimestamp", "defaultPaymentTerms", "operation", "paymentScheduleName", "plannedInvoices", "policy", "productName", "tenantTimeZone", "transactionType" ], "properties": { "charges": { "type": "array", "items": { "$ref": "#/definitions/PaymentSchedulePluginCharge" } }, "coverageEndTimestamp": { "type": "string" }, "coverageStartTimestamp": { "type": "string" }, "defaultPaymentTerms": { "$ref": "#/definitions/PaymentTermsResponse" }, "oldPaymentScheduleName": { "type": "string" }, "operation": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "reinstatement", "cancellation", "manual", "feeAssessment" ] }, "paymentScheduleName": { "type": "string" }, "plannedInvoices": { "type": "array", "items": { "$ref": "#/definitions/FutureInvoiceResponse" } }, "policy": { "$ref": "#/definitions/PolicyResponse" }, "productName": { "type": "string" }, "tenantTimeZone": { "type": "string" }, "transactionType": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "reinstatement", "cancellation", "manual", "feeAssessment" ] } } }, "QueryRequest": { "type": "object", "properties": { "limit": { "type": "integer" }, "maxTimestamp": { "type": "string" }, "minTimestamp": { "type": "string" }, "oldestComeFirst": { "type": "boolean" }, "position": { "type": "string" }, "requestId": { "type": "string" }, "searchPhrase": { "type": "string" } } }, "WebhooksResponse": { "type": "object", "required": [ "webhooks" ], "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/definitions/WebhookResponse" } } } }, "AutofillExposureUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "addPerils", "exposureLocator", "removeFieldGroups", "removePerils", "updateFieldGroups", "updatePerils" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/AutofillPerilCreateRequest" } }, "exposureLocator": { "type": "string" }, "exposureName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "removePerils": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateRequest" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/AutofillPerilUpdateRequest" } } } }, "AuxDataKeySetResponse": { "type": "object", "required": [ "keys", "page" ], "properties": { "keys": { "type": "array", "items": { "$ref": "#/definitions/AuxDataKeyResponse" } }, "page": { "type": "integer" } } }, "ReinstatementResponse": { "type": "object", "required": [ "cancellationLocator", "createdTimestamp", "documents", "effectiveTimestamp", "locator", "state", "updatedTimestamp" ], "properties": { "cancellationLocator": { "type": "string" }, "createdTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "effectiveTimestamp": { "type": "string" }, "invoiceLocator": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "price": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "reinstatementDeadlineTimestamp": { "type": "string" }, "reinstatementPaymentAmount": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "accepted", "issued", "expired" ] }, "updatedTimestamp": { "type": "string" } } }, "AuxDataCreateRequest": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string" }, "uiType": { "type": "string", "enum": [ "normal", "hidden", "readonly" ] }, "value": { "type": "string" } } }, "PaymentUpdateRequest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "AutofillUpdateRequest": { "type": "object", "required": [ "policyEndTimestamp", "policyStartTimestamp" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/AutofillExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "endorsementEffectiveTimestamp": { "type": "string" }, "endorsementName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "policyEndTimestamp": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "removeExposures": { "type": "array", "items": { "type": "string" } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/AutofillExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateRequest" } } } }, "EndorsementExposureUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "addPerils", "endPerils", "exposureLocator", "removeFieldGroups", "updateFieldGroups", "updatePerils" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateRequest" } }, "endPerils": { "type": "array", "items": { "type": "string" } }, "exposureLocator": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/PerilUpdateRequest" } } } }, "PerilSnapshotResponse": { "type": "object", "required": [ "characteristics", "locator", "name", "renewalGroup" ], "properties": { "characteristics": { "type": "array", "items": { "$ref": "#/definitions/PerilCharacteristicsResponse" } }, "locator": { "type": "string" }, "name": { "type": "string" }, "renewalGroup": { "type": "string" } } }, "QuoteSummaryResponse": { "type": "object", "required": [ "notDiscarded", "selected" ], "properties": { "notDiscarded": { "type": "array", "items": { "$ref": "#/definitions/QuoteSummaryResponseItem" } }, "selected": { "type": "string" } } }, "ReinstatementStatusAndTimeResponse": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "open", "closed", "invoiced", "issued" ] }, "timestamp": { "type": "string" } } }, "WebhookDivertedEventResponse": { "type": "object", "required": [ "data", "eventId", "eventType", "timestamp", "transactionId" ], "properties": { "data": { "$ref": "#/definitions/EventStreamData" }, "eventId": { "type": "string" }, "eventType": { "type": "string", "enum": [ "cancellation.create", "cancellation.update", "cancellation.rescind", "cancellation.issue", "cancellation.effective", "claim.close", "claim.create", "claim.discard", "claim.open", "claim.update", "policy.gracePeriod", "policy.gracePeriod.update", "invoice.issue", "invoice.invalidate", "invoice.pastDue", "invoice.writtenOff", "payment.pay", "policy.cancel", "policy.create", "policy.discard", "policy.endorse", "policy.finalize", "policy.issue", "policy.lapse", "policy.reinstatement.close", "policy.reinstatement.invoice", "policy.reinstatement.issue", "policy.reinstatement.open", "policy.renew", "policy.update", "policy.upgrade", "subClaim.open", "subClaim.update", "subClaim.close", "subClaim.reopen", "subClaim.updateReserve", "policy.end.reminder", "subClaim.createPayable", "subClaim.reversePayable", "endorsement.create", "endorsement.update", "endorsement.quote", "endorsement.accept", "endorsement.issue", "endorsement.invalidate", "endorsement.discard", "endorsement.effective", "reinstatement.accept", "reinstatement.create", "reinstatement.issue", "reinstatement.invalidate", "reinstatement.deadlineReached", "reinstatement.effective", "renewal.create", "renewal.update", "renewal.quote", "renewal.accept", "renewal.issue", "renewal.invalidate", "renewal.discard", "renewal.effective", "policy.effective", "policy.end", "policy.quote.create", "policy.quote.discard", "policy.quote.update", "policy.quote.quoted", "policy.quote.accept", "policy.quote.declined", "policy.quote.invalidate", "premiumReport.create", "premiumReport.update", "premiumReport.issue", "premiumReport.discard", "premiumReport.reverse", "premiumReport.replace", "premiumReport.effective", "premiumReport.pay", "login.success", "login.failure", "policyholder.create", "policyholder.update", "payment.reverse", "payment.update", "payment.ready", "payment.discard", "payment.return", "payment.decline", "payment.draft", "policy.gracePeriod.satisfied", "disbursement.issue", "disbursement.create", "disbursement.update", "catchUp.issue", "catchUp.writtenOff", "catchUp.pay", "catchUp.pay.reverse", "catchUp.invalidate", "catchUp.pastDue", "cash.transfer" ] }, "timestamp": { "type": "string" }, "transactionId": { "type": "string" }, "username": { "type": "string" } } }, "EventStreamPolicyholderUpdateData": { "type": "object", "required": [ "policyholderLocator" ], "properties": { "policyholderLocator": { "type": "string" } } }, "SubClaimPayableReverseRequest": { "type": "object", "required": [ "payableLocator" ], "properties": { "comment": { "type": "string" }, "payableLocator": { "type": "string" } } }, "EventStreamLoginFailureData": { "type": "object", "required": [ "username" ], "properties": { "username": { "type": "string" } } }, "DisbursementResponse": { "type": "object", "required": [ "amount", "amountCurrency", "cashBalanceLocator", "createdTimestamp", "displayId", "documents", "fieldValues", "locator", "mediaByLocator", "policyLocator", "state", "updatedTimestamp" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "cashBalanceLocator": { "type": "string" }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "policyLocator": { "type": "string" }, "state": { "type": "string", "enum": [ "draft", "issued", "discarded" ] }, "updatedTimestamp": { "type": "string" } } }, "CashBalanceTransferRequest": { "type": "object", "required": [ "amount", "name", "targetCashBalanceLocator" ], "properties": { "amount": { "type": "number" }, "details": { "type": "string" }, "name": { "type": "string" }, "targetCashBalanceLocator": { "type": "string" } } }, "GetPerilPriceResponse": { "type": "object", "required": [ "commissions", "grossCommissions", "grossTaxes", "locator", "name", "premium", "taxes", "total" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "grossCommissions": { "type": "number" }, "grossCommissionsCurrency": { "type": "string" }, "grossTaxes": { "type": "number" }, "grossTaxesCurrency": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "premium": { "type": "number" }, "premiumCurrency": { "type": "string" }, "taxes": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "technicalPremium": { "type": "number" }, "technicalPremiumCurrency": { "type": "string" }, "total": { "type": "number" }, "totalCurrency": { "type": "string" } } }, "PaymentPageResponse": { "type": "object", "required": [ "payments" ], "properties": { "pagingToken": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentResponse" } } } }, "PerilResponse": { "type": "object", "required": [ "characteristics", "createdTimestamp", "displayId", "exposureLocator", "locator", "name", "policyholderLocator", "policyLocator", "productLocator", "renewalGroup", "updatedTimestamp" ], "properties": { "characteristics": { "type": "array", "items": { "$ref": "#/definitions/PerilCharacteristicsResponse" } }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "exposureLocator": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "productLocator": { "type": "string" }, "renewalGroup": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "ILocatable": { "type": "object", "required": [ "locator" ], "properties": { "locator": { "type": "string" } } }, "EventStreamCancellationEffectiveData": { "type": "object", "required": [ "cancellationLocator", "cancellationName", "effectiveTimestamp", "modificationName", "policyLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "cancellationName": { "type": "string" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "SubClaimValidationErrors": { "type": "object", "required": [ "errors", "locator" ], "properties": { "errors": { "$ref": "#/definitions/FieldErrors" }, "locator": { "type": "string" } } }, "PolicyCharacteristicsResponse": { "type": "object", "required": [ "createdTimestamp", "endTimestamp", "fieldGroupsByLocator", "fieldValues", "locator", "mediaByLocator", "policyEndTimestamp", "policyholderLocator", "policyLocator", "policyStartTimestamp", "productLocator", "startTimestamp", "taxGroups", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "grossPremium": { "type": "number" }, "grossPremiumCurrency": { "type": "string" }, "grossTaxes": { "type": "number" }, "grossTaxesCurrency": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "policyEndTimestamp": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "productLocator": { "type": "string" }, "replacedTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "updatedTimestamp": { "type": "string" } } }, "PolicyFeeSummaryResponse": { "type": "object", "required": [ "fees" ], "properties": { "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } } } }, "PolicyDocumentResponse": { "type": "object", "required": [ "displayName", "fileName", "locator", "type" ], "properties": { "createdTimestamp": { "type": "string" }, "displayName": { "type": "string" }, "fileName": { "type": "string" }, "locator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "type": { "type": "string", "enum": [ "pdf", "html" ] }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "GeneratedInvoiceResponse": { "type": "object", "required": [ "financialTransactions", "invoice" ], "properties": { "financialTransactions": { "type": "array", "items": { "$ref": "#/definitions/FinancialTransactionResponse" } }, "invoice": { "$ref": "#/definitions/PolicyInvoiceResponse" } } }, "EventResponse": { "type": "object", "required": [ "data", "id", "timestamp", "type" ], "properties": { "data": { "$ref": "#/definitions/EventStreamData" }, "id": { "type": "string" }, "timestamp": { "type": "string" }, "type": { "type": "string", "enum": [ "cancellation.create", "cancellation.update", "cancellation.rescind", "cancellation.issue", "cancellation.effective", "claim.close", "claim.create", "claim.discard", "claim.open", "claim.update", "policy.gracePeriod", "policy.gracePeriod.update", "invoice.issue", "invoice.invalidate", "invoice.pastDue", "invoice.writtenOff", "payment.pay", "policy.cancel", "policy.create", "policy.discard", "policy.endorse", "policy.finalize", "policy.issue", "policy.lapse", "policy.reinstatement.close", "policy.reinstatement.invoice", "policy.reinstatement.issue", "policy.reinstatement.open", "policy.renew", "policy.update", "policy.upgrade", "subClaim.open", "subClaim.update", "subClaim.close", "subClaim.reopen", "subClaim.updateReserve", "policy.end.reminder", "subClaim.createPayable", "subClaim.reversePayable", "endorsement.create", "endorsement.update", "endorsement.quote", "endorsement.accept", "endorsement.issue", "endorsement.invalidate", "endorsement.discard", "endorsement.effective", "reinstatement.accept", "reinstatement.create", "reinstatement.issue", "reinstatement.invalidate", "reinstatement.deadlineReached", "reinstatement.effective", "renewal.create", "renewal.update", "renewal.quote", "renewal.accept", "renewal.issue", "renewal.invalidate", "renewal.discard", "renewal.effective", "policy.effective", "policy.end", "policy.quote.create", "policy.quote.discard", "policy.quote.update", "policy.quote.quoted", "policy.quote.accept", "policy.quote.declined", "policy.quote.invalidate", "premiumReport.create", "premiumReport.update", "premiumReport.issue", "premiumReport.discard", "premiumReport.reverse", "premiumReport.replace", "premiumReport.effective", "premiumReport.pay", "login.success", "login.failure", "policyholder.create", "policyholder.update", "payment.reverse", "payment.update", "payment.ready", "payment.discard", "payment.return", "payment.decline", "payment.draft", "policy.gracePeriod.satisfied", "webhook.suspended", "disbursement.issue", "disbursement.create", "disbursement.update", "catchUp.issue", "catchUp.writtenOff", "catchUp.pay", "catchUp.pay.reverse", "catchUp.invalidate", "catchUp.pastDue", "cash.transfer" ] }, "username": { "type": "string" } } }, "EventStreamRenewalQuoteData": { "type": "object", "required": [ "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "ClaimConfigurationResponse": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "searchSummary": { "type": "array", "items": { "type": "string" } }, "subClaimConfiguration": { "$ref": "#/definitions/SubClaimConfigurationResponse" } } }, "PolicyConfigUpgradeResponse": { "type": "object", "required": [ "newConfigVersion", "oldConfigVersion", "policyLocator" ], "properties": { "newConfigVersion": { "type": "integer" }, "oldConfigVersion": { "type": "integer" }, "policyLocator": { "type": "string" } } }, "RenewalPolicyUpdateRequest": { "type": "object", "required": [ "addExposures", "addFieldGroups", "endExposures", "removeFieldGroups", "updateExposures", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/RenewalExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "PolicyCancellationIssueRequest": { "type": "object", "required": [ "coverageEndTimestamp" ], "properties": { "coverageEndTimestamp": { "type": "string" } } }, "EventStreamCatchUpWrittenOffData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "FeeUpdateRequest": { "type": "object", "required": [ "newFees", "reverseFees" ], "properties": { "newFees": { "type": "array", "items": { "$ref": "#/definitions/FeeCreateRequest" } }, "reverseFees": { "type": "array", "items": { "type": "string" } } } }, "CashBalanceLogResponse": { "type": "object", "required": [ "data", "id", "timestamp", "type" ], "properties": { "data": { "$ref": "#/definitions/CashBalanceLogData" }, "id": { "type": "string" }, "timestamp": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "CatchUpPagedResponse": { "type": "object", "required": [ "catchUps" ], "properties": { "catchUps": { "type": "array", "items": { "$ref": "#/definitions/CatchUpInvoiceResponse" } }, "pagingToken": { "type": "string" } } }, "SubClaimResponse": { "type": "object", "required": [ "claimLocator", "createdTimestamp", "currentStatus", "expenseReserve", "exposureLocator", "fieldGroupsByLocator", "fieldValues", "locator", "lossReserve", "perilLocator", "reserveCurrency", "updatedTimestamp" ], "properties": { "claimLocator": { "type": "string" }, "createdTimestamp": { "type": "string" }, "currentStatus": { "type": "string", "enum": [ "open", "closed" ] }, "expenseLedger": { "type": "array", "items": { "$ref": "#/definitions/LedgerLineItem" } }, "expenseReserve": { "$ref": "#/definitions/ReserveResponse" }, "exposureLocator": { "type": "string" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "locator": { "type": "string" }, "lossLedger": { "type": "array", "items": { "$ref": "#/definitions/LedgerLineItem" } }, "lossReserve": { "$ref": "#/definitions/ReserveResponse" }, "perilLocator": { "type": "string" }, "reserveCurrency": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "EventStreamPremiumReportIssueData": { "type": "object", "required": [ "policyLocator", "premiumReportLocator" ], "properties": { "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "InvoicePaymentReversalRequest": { "type": "object", "properties": { "details": { "type": "string" }, "name": { "type": "string" } } }, "PolicyInvoiceResponse": { "type": "object", "required": [ "createdTimestamp", "displayId", "documents", "dueTimestamp", "endTimestamp", "invoiceType", "locator", "payments", "policyLocator", "settlementStatus", "startTimestamp", "statuses", "totalDue", "totalDueCurrency", "transactionIssued", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "dueTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "invoiceType": { "type": "string", "enum": [ "newBusiness", "endorsement", "renewal", "cancellation", "reinstatement", "installment", "premiumReporting", "catchUp", "other" ] }, "locator": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentResponse" } }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "premiumReportName": { "type": "string" }, "settlementStatus": { "type": "string", "enum": [ "outstanding", "settled" ] }, "settlementType": { "type": "string", "enum": [ "paid", "writtenOff", "zeroDue", "invalidated", "carriedForward" ] }, "startTimestamp": { "type": "string" }, "statuses": { "type": "array", "items": { "$ref": "#/definitions/PolicyInvoiceStatusAndTimeResponse" } }, "totalDue": { "type": "number" }, "totalDueCurrency": { "type": "string" }, "transactionIssued": { "type": "boolean" }, "updatedTimestamp": { "type": "string" } } }, "EventStreamPaymentReadyData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "CommissionResponse": { "type": "object", "required": [ "amount", "recipient" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "recipient": { "type": "string" } } }, "SubClaimSummary": { "type": "object", "required": [ "expensePayableAmount", "expenseReserveAmount", "lossPayableAmount", "lossReserveAmount", "reserveCurrency" ], "properties": { "expensePayableAmount": { "type": "number" }, "expenseReserveAmount": { "type": "number" }, "lossPayableAmount": { "type": "number" }, "lossReserveAmount": { "type": "number" }, "reserveCurrency": { "type": "string" } } }, "EventStreamReinstatementCloseData": { "type": "object", "required": [ "policyLocator", "reinstatementLocator" ], "properties": { "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "ClaimUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "addSubClaims", "removeFieldGroups", "updateFieldGroups", "updateSubClaims" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "addSubClaims": { "type": "array", "items": { "$ref": "#/definitions/SubClaimCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "incidentTimestamp": { "type": "string" }, "notificationTimestamp": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } }, "updateSubClaims": { "type": "array", "items": { "$ref": "#/definitions/SubClaimUpdateRequest" } } } }, "EndorsementExposureUpdateResponse": { "type": "object", "required": [ "addFieldGroups", "addPerils", "endPerils", "exposureLocator", "fieldValues", "removeFieldGroups", "updateFieldGroups", "updatePerils" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateResponse" } }, "endPerils": { "type": "array", "items": { "type": "string" } }, "exposureLocator": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/PerilUpdateRequest" } } } }, "RenewalCreateRequest": { "type": "object", "required": [ "renewalEndTimestamp" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "renewalEndTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "application", "quoted", "accepted", "issued" ] }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/RenewalExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "EventPageResponse": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "items": { "$ref": "#/definitions/EventResponse" } }, "pagingToken": { "type": "string" } } }, "EventStreamPolicyInvoiceIssueData": { "type": "object", "required": [ "invoiceLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "CancellationValueResponse": { "type": "object", "required": [ "balanceAfterCancellation", "commissions", "exposurePrices", "grossCommissionsChange", "grossFeesChange", "grossPremiumChange", "grossTaxesChange", "newGrossCommissions", "newGrossFees", "newGrossPremium", "newGrossTaxes", "newTotal", "taxGroups", "totalChange", "value" ], "properties": { "balanceAfterCancellation": { "type": "number" }, "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionChangeResponse" } }, "exposurePrices": { "type": "array", "items": { "$ref": "#/definitions/ExposurePriceChangeResponse" } }, "grossCommissionsChange": { "type": "number" }, "grossFeesChange": { "type": "number" }, "grossPremiumChange": { "type": "number" }, "grossTaxesChange": { "type": "number" }, "newGrossCommissions": { "type": "number" }, "newGrossFees": { "type": "number" }, "newGrossPremium": { "type": "number" }, "newGrossTaxes": { "type": "number" }, "newTotal": { "type": "number" }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxChangeResponse" } }, "totalChange": { "type": "number" }, "value": { "type": "number" } } }, "PolicyDocumentRenderRequest": { "type": "object", "required": [ "policyDisplayId", "template" ], "properties": { "policyDisplayId": { "type": "string" }, "template": { "type": "string" }, "transactionLocator": { "type": "string" }, "transactionType": { "type": "string", "enum": [ "renewal", "endorsement", "cancellation", "reinstatement", "premium_report" ] } } }, "EventStreamPaymentUpdateData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "RoleList": { "type": "object", "required": [ "roles" ], "properties": { "roles": { "type": "array", "items": { "type": "string" } } } }, "WebhookDivertedEventsResponse": { "type": "object", "required": [ "events", "webhookName" ], "properties": { "events": { "type": "array", "items": { "$ref": "#/definitions/WebhookDivertedEventResponse" } }, "webhookName": { "type": "string" } } }, "EventStreamPolicyCancelData": { "type": "object", "required": [ "effectiveDate", "modificationName", "policyLocator" ], "properties": { "effectiveDate": { "type": "integer" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "DeployTestAssetResponse": { "type": "object", "required": [ "hostname", "logfile", "success", "tenantName" ], "properties": { "hostname": { "type": "string" }, "logfile": { "type": "string" }, "success": { "type": "boolean" }, "tenantName": { "type": "string" } } }, "TaxChangeResponse": { "type": "object", "required": [ "change", "name", "newAmount" ], "properties": { "change": { "type": "number" }, "name": { "type": "string" }, "newAmount": { "type": "number" } } }, "ExceptionResponse": { "type": "object", "required": [ "apiErrorCode", "httpErrorCode", "httpStatus" ], "properties": { "apiErrorCode": { "type": "integer" }, "claimFieldErrors": { "$ref": "#/definitions/ClaimFieldErrors" }, "commit": { "type": "string" }, "fieldErrors": { "type": "array", "items": { "$ref": "#/definitions/ValidationFieldError" } }, "httpErrorCode": { "type": "integer" }, "httpStatus": { "type": "integer" }, "message": { "type": "string" }, "paymentFieldErrors": { "$ref": "#/definitions/FieldErrors" }, "policyFieldErrors": { "$ref": "#/definitions/PolicyValidationErrors" }, "referenceId": { "type": "string" }, "requestMethod": { "type": "string" }, "requestUri": { "type": "string" }, "throwable": { "type": "string" }, "version": { "type": "string" } } }, "PostIssuancePluginDocument": { "type": "object", "required": [ "displayName", "fileName", "locator" ], "properties": { "createdTimestamp": { "type": "string" }, "displayName": { "type": "string" }, "fileName": { "type": "string" }, "locator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "EventStreamPolicyCreateData": { "type": "object", "required": [ "policyLocator" ], "properties": { "policyLocator": { "type": "string" } } }, "AuxDataSetCreateRequest": { "type": "object", "required": [ "auxData" ], "properties": { "auxData": { "type": "array", "items": { "$ref": "#/definitions/AuxDataCreateRequest" } } } }, "PaymentActionRequest": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "draft", "ready", "decline", "return", "discard" ] }, "paymentUpdate": { "$ref": "#/definitions/PaymentUpdateRequest" } } }, "EventStreamPaymentPayData": { "type": "object", "required": [ "invoiceLocator", "paymentLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "paymentLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamRenewalCreateData": { "type": "object", "required": [ "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "FinancialTransactionResponse": { "type": "object", "required": [ "amount", "endTimestamp", "policyModificationLocator", "postedTimestamp", "startTimestamp", "type" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "commissionLocator": { "type": "string" }, "commissionRecipient": { "type": "string" }, "endTimestamp": { "type": "string" }, "feeLocator": { "type": "string" }, "feeName": { "type": "string" }, "holdbackLocator": { "type": "string" }, "perilCharacteristicsLocator": { "type": "string" }, "perilName": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "postedTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "taxLocator": { "type": "string" }, "taxName": { "type": "string" }, "type": { "type": "string", "enum": [ "premium", "tax", "fee", "commission", "holdback", "cash" ] } } }, "ReinstatementUpdateRequest": { "type": "object", "properties": { "effectiveTimestamp": { "type": "string" }, "reinstatementDeadlineTimestamp": { "type": "string" } } }, "EventStreamEndorsementDiscardData": { "type": "object", "required": [ "endorsementLocator", "policyLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PaymentSchedulePluginResponse": { "type": "object", "required": [ "installments" ], "properties": { "installments": { "type": "array", "items": { "$ref": "#/definitions/PaymentSchedulePluginInstallmentResponse" } } } }, "ReinstatementCreateRequest": { "type": "object", "properties": { "effectiveTimestamp": { "type": "string" }, "issue": { "type": "boolean" }, "reinstatementDeadlineTimestamp": { "type": "string" } } }, "FrontendExternalDataCallConfiguration": { "type": "object", "required": [ "targetFields", "triggerField" ], "properties": { "targetFields": { "type": "array", "items": { "type": "string" } }, "triggerField": { "type": "string" } } }, "EventStreamDisbursementUpdateData": { "type": "object", "required": [ "cashBalanceLocator", "disbursementLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "disbursementLocator": { "type": "string" } } }, "CashBalanceLogData": { "type": "object", "properties": {} }, "PolicyholderOverwriteDataResponse": { "type": "object", "required": [ "policyholderLocator" ], "properties": { "policyholderLocator": { "type": "string" } } }, "MediaFieldConfiguration": { "type": "object", "required": [ "name", "order", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "repeatable": { "type": "boolean" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "StaticDocumentRequest": { "type": "object", "required": [ "file" ], "properties": { "effectiveTimestamp": { "type": "string" }, "file": { "type": "string" }, "StaticDocumentName": { "type": "string" } } }, "ResourceResponse": { "type": "object", "required": [ "effectiveTimestamp", "locator", "name", "url", "urlExpirationTimestamp" ], "properties": { "effectiveTimestamp": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "RatingPluginData": { "type": "object", "required": [ "operation", "policy", "policyExposurePerils", "tenantTimeZone" ], "properties": { "endorsementLocator": { "type": "string" }, "newPaymentScheduleName": { "type": "string" }, "operation": { "type": "string", "enum": [ "new_business", "endorsement", "renewal", "reinstatement" ] }, "policy": { "$ref": "#/definitions/PolicyResponse" }, "policyExposurePerils": { "type": "array", "items": { "$ref": "#/definitions/RatingPluginCharacteristics" } }, "quoteLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "tenantTimeZone": { "type": "string" } } }, "PaymentReversalPluginResponse": { "type": "object", "properties": { "gracePeriodEndTimestamp": { "type": "string" } } }, "EventStreamEndorsementIssueData": { "type": "object", "required": [ "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "RoleResponse": { "type": "object", "required": [ "displayName", "name", "permissions" ], "properties": { "displayName": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "EventStreamGracePeriodUpdateData": { "type": "object", "required": [ "gracePeriodLocator", "policyLocator" ], "properties": { "cancelEffectiveTimestamp": { "type": "string" }, "gracePeriodLocator": { "type": "string" }, "newEndTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "previousEndTimestamp": { "type": "string" } } }, "PolicyQuoteInvoiceResponse": { "type": "object", "required": [ "endTimestamp", "financialTransactions", "issueTimestamp", "startTimestamp" ], "properties": { "dueTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "financialTransactions": { "type": "array", "items": { "$ref": "#/definitions/FinancialTransactionResponse" } }, "issueTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "PolicyDocumentRemoveRequest": { "type": "object", "required": [ "documentLocator" ], "properties": { "documentLocator": { "type": "string" } } }, "RenewalExposureUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "addPerils", "endPerils", "exposureLocator", "fieldValues", "removeFieldGroups", "updateFieldGroups", "updatePerils" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateRequest" } }, "endPerils": { "type": "array", "items": { "type": "string" } }, "exposureLocator": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/PerilUpdateRequest" } } } }, "EventStreamRenewalEffectiveData": { "type": "object", "required": [ "effectiveTimestamp", "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator" ], "properties": { "effectiveTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" } } }, "EventStreamReinstatementDeadlineReachedData": { "type": "object", "required": [ "cancellationLocator", "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "ReserveSetRequest": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number" } } }, "EventStreamGracePeriodSatisfiedData": { "type": "object", "required": [ "gracePeriodLocator", "policyLocator", "settledTimestamp" ], "properties": { "gracePeriodLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "settledTimestamp": { "type": "string" } } }, "SsoRoleModel": { "type": "object", "required": [ "role" ], "properties": { "accountType": { "type": "string", "enum": [ "account.internal", "account.tenant.employee", "account.tenant.read.only.user", "account.tenant.claims.only.user", "bootstrap", "account.useRoles" ] }, "accountTypeDisplayName": { "type": "string" }, "namespace": { "type": "string" }, "namespaceRoleType": { "type": "string", "enum": [ "", "namespace.owner", "namespace.user" ] }, "namespaceRoleTypeDisplayName": { "type": "string" }, "role": { "type": "string" }, "tenantHostname": { "type": "string" } } }, "DisbursementCreateRequest": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PaymentSchedulePluginInvoiceItemResponse": { "type": "object", "required": [ "amount", "chargeId" ], "properties": { "amount": { "type": "number" }, "chargeId": { "type": "string" } } }, "LapseReinstatementResponse": { "type": "object", "required": [ "createdTimestamp", "currentStatus", "locator", "statuses", "updatedTimestamp", "uploadedDocuments" ], "properties": { "createdTimestamp": { "type": "string" }, "currentStatus": { "type": "string", "enum": [ "open", "closed", "invoiced", "issued" ] }, "invoicedTimestamp": { "type": "string" }, "invoiceLocator": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "reinstatementDocument": { "$ref": "#/definitions/PolicyDocumentResponse" }, "reinstatementTimestamp": { "type": "string" }, "statuses": { "type": "array", "items": { "$ref": "#/definitions/ReinstatementStatusAndTimeResponse" } }, "updatedTimestamp": { "type": "string" }, "uploadedDocuments": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } } } }, "EventStreamGracePeriodCreateData": { "type": "object", "required": [ "gracePeriodLocator", "policyLocator" ], "properties": { "gracePeriodLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PaymentTermsResponse": { "type": "object", "required": [ "amount", "unit" ], "properties": { "amount": { "type": "integer" }, "unit": { "type": "string", "enum": [ "day" ] } } }, "SearchRequestApi": { "type": "object", "properties": { "includeReplaced": { "type": "boolean" }, "products": { "type": "array", "items": { "type": "string" } }, "returnType": { "type": "string" }, "searchString": { "type": "string" }, "searchTerms": { "type": "array", "items": { "$ref": "#/definitions/SearchTermRequestApi" } } } }, "PolicyDocumentConfiguration": { "type": "object", "required": [ "displayName", "fileName", "generatingEvent", "templateName", "type" ], "properties": { "displayName": { "type": "string" }, "fileName": { "type": "string" }, "generatingEvent": { "type": "string", "enum": [ "quote", "accept", "issue" ] }, "pageLayout": { "$ref": "#/definitions/DocumentPageLayout" }, "templateName": { "type": "string" }, "type": { "type": "string", "enum": [ "pdf", "html" ] } } }, "EventStreamPolicyEndorseData": { "type": "object", "required": [ "endorsementName", "modificationLocator", "policyLocator" ], "properties": { "endorsementName": { "type": "string" }, "modificationLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PaymentCreateRequest": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "ExternalRaterCommissionResponse": { "type": "object", "required": [ "recipient" ], "properties": { "exactAmount": { "type": "string" }, "recipient": { "type": "string" }, "yearlyAmount": { "type": "string" } } }, "PolicyholderPageResponse": { "type": "object", "required": [ "policyholders" ], "properties": { "pagingToken": { "type": "string" }, "policyholders": { "type": "array", "items": { "$ref": "#/definitions/PolicyholderResponse" } } } }, "EndorsementUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "removeFieldGroups", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "newPolicyEndTimestamp": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "reprice": { "type": "boolean" }, "startTimestamp": { "type": "string" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/EndorsementExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "EventStreamPolicyQuoteCreateData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "PolicyQuoteUpdateRequest": { "type": "object", "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "name": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "paymentScheduleName": { "type": "string" }, "policyEndTimestamp": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "removeExposures": { "type": "array", "items": { "type": "string" } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "resetOverrideResourcesAsOfTimestamp": { "type": "boolean" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/DraftPolicyExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "PolicyCreateRequest": { "type": "object", "required": [ "policyholderLocator", "productName" ], "properties": { "autofill": { "type": "array", "items": { "type": "string" } }, "configVersion": { "type": "integer" }, "currency": { "type": "string" }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "finalize": { "type": "boolean" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "paymentScheduleName": { "type": "string" }, "policyEndTimestamp": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "premiumReportName": { "type": "string" }, "productName": { "type": "string" } } }, "SubClaimConfigurationResponse": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "searchSummary": { "type": "array", "items": { "type": "string" } } } }, "EventStreamPolicyEffectiveData": { "type": "object", "required": [ "effectiveTimestamp", "policyLocator" ], "properties": { "effectiveTimestamp": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PremiumReportResponse": { "type": "object", "required": [ "commissions", "configVersion", "createdTimestamp", "displayId", "documents", "endTimestamp", "fees", "fieldErrors", "fieldGroupsByLocator", "fieldValues", "grossCommissions", "grossFees", "grossPremium", "grossTaxes", "invoiceDueTimestamp", "issuedTimestamp", "locator", "policyLocator", "premiums", "startTimestamp", "state", "taxGroups", "updatedTimestamp" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "configVersion": { "type": "integer" }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportingDocumentResponse" } }, "endTimestamp": { "type": "string" }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } }, "fieldErrors": { "$ref": "#/definitions/FieldErrors" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "grossCommissions": { "type": "number" }, "grossFees": { "type": "number" }, "grossPremium": { "type": "number" }, "grossTaxes": { "type": "number" }, "invoice": { "$ref": "#/definitions/PremiumReportingInvoiceResponse" }, "invoiceDueTimestamp": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiums": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportPremiumResponse" } }, "replacedByLocator": { "type": "string" }, "replacedTimestamp": { "type": "string" }, "replacementOfLocator": { "type": "string" }, "reversedTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "draft", "discarded", "issued", "reversed" ] }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "updatedTimestamp": { "type": "string" } } }, "CashBalanceResponse": { "type": "object", "required": [ "amount", "currency", "locator", "policyholderLocator", "policyLocator" ], "properties": { "amount": { "type": "number" }, "currency": { "type": "string" }, "locator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamPolicyQuoteInvalidateData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "DeployProductionAssetResponse": { "type": "object", "required": [ "hostname", "logfile", "success", "tenantName" ], "properties": { "hostname": { "type": "string" }, "logfile": { "type": "string" }, "success": { "type": "boolean" }, "tenantName": { "type": "string" } } }, "ClaimsReportRequest": { "type": "object", "required": [ "reportTimestamp" ], "properties": { "reportTimestamp": { "type": "string" } } }, "GracePeriodResponse": { "type": "object", "required": [ "endTimestamp", "invoiceLocator", "locator", "policyholderLocator", "policyId", "policyLocator", "productLocator", "startTimestamp" ], "properties": { "cancelEffectiveTimestamp": { "type": "string" }, "cancellationLocator": { "type": "string" }, "document": { "$ref": "#/definitions/PolicyDocumentResponse" }, "endTimestamp": { "type": "string" }, "invoiceLocator": { "type": "string" }, "locator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyId": { "type": "string" }, "policyLocator": { "type": "string" }, "productLocator": { "type": "string" }, "settledTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "EndorsementConfigurationResponse": { "type": "object", "required": [ "displayName", "documents", "name", "reprice" ], "properties": { "displayName": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } }, "name": { "type": "string" }, "reprice": { "type": "string", "enum": [ "always", "never", "input", "all" ] } } }, "QuoteSummaryResponseItem": { "type": "object", "required": [ "locator", "name", "state" ], "properties": { "locator": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string", "enum": [ "draft", "quoted", "accepted", "declined", "discarded" ] } } }, "ExposureResponse": { "type": "object", "required": [ "characteristics", "createdTimestamp", "displayId", "locator", "name", "perils", "policyholderLocator", "policyLocator", "productLocator", "updatedTimestamp" ], "properties": { "characteristics": { "type": "array", "items": { "$ref": "#/definitions/ExposureCharacteristicsResponse" } }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilResponse" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "productLocator": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "RenewalActionRequest": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "discard", "quote", "accept", "issue", "invalidate", "update" ] }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "renewalUpdate": { "$ref": "#/definitions/RenewalUpdateRequest" } } }, "ExternalRaterPricedCharacteristics": { "type": "object", "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/ExternalRaterCommissionResponse" } }, "exactPremium": { "type": "string" }, "exactTechnicalPremium": { "type": "string" }, "yearlyPremium": { "type": "string" }, "yearlyTechnicalPremium": { "type": "string" } } }, "SubClaimPayableCreateRequest": { "type": "object", "required": [ "amount", "reserveType", "subClaimLocator" ], "properties": { "amount": { "type": "number" }, "comment": { "type": "string" }, "recipient": { "type": "string" }, "reserveType": { "type": "string", "enum": [ "loss", "expense" ] }, "subClaimLocator": { "type": "string" } } }, "EventStreamReinstatementOpenData": { "type": "object", "required": [ "policyLocator", "reinstatementLocator" ], "properties": { "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "LapseResponse": { "type": "object", "required": [ "createdTimestamp", "lapseTimestamp", "locator", "reinstatementPeriodEndTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "document": { "$ref": "#/definitions/PolicyDocumentResponse" }, "lapseTimestamp": { "type": "string" }, "locator": { "type": "string" }, "reinstatementPeriodEndTimestamp": { "type": "string" } } }, "PremiumReportingDocumentResponse": { "type": "object", "required": [ "displayName", "fileName", "locator", "premiumReportLocator", "type", "url", "urlExpirationTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "displayName": { "type": "string" }, "fileName": { "type": "string" }, "locator": { "type": "string" }, "premiumReportLocator": { "type": "string" }, "type": { "type": "string", "enum": [ "pdf", "html" ] }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "RunReportResponse": { "type": "object", "required": [ "locator" ], "properties": { "locator": { "type": "string" } } }, "ExposureSnapshotResponse": { "type": "object", "required": [ "characteristics", "locator", "name", "perils" ], "properties": { "characteristics": { "type": "array", "items": { "$ref": "#/definitions/ExposureCharacteristicsResponse" } }, "locator": { "type": "string" }, "name": { "type": "string" }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilSnapshotResponse" } } } }, "PerilCoverageSummaryResponse": { "type": "object", "required": [ "characteristics", "locator", "name", "renewalGroup" ], "properties": { "characteristics": { "$ref": "#/definitions/PerilCharacteristicsResponse" }, "locator": { "type": "string" }, "name": { "type": "string" }, "renewalGroup": { "type": "string" } } }, "RolesResponse": { "type": "object", "required": [ "roles" ], "properties": { "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleResponse" } } } }, "EventStreamDisbursementCreateData": { "type": "object", "required": [ "cashBalanceLocator", "disbursementLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "disbursementLocator": { "type": "string" } } }, "PolicyExposurePerilPricingRequest": { "type": "object", "required": [ "exposureCharacteristicsLocator", "perilCharacteristicsLocator", "policyCharacteristicsLocator" ], "properties": { "exposureCharacteristicsLocator": { "type": "string" }, "perilCharacteristicsLocator": { "type": "string" }, "policyCharacteristicsLocator": { "type": "string" } } }, "EndorsementPolicyUpdateRequest": { "type": "object", "required": [ "addExposures", "addFieldGroups", "endExposures", "removeFieldGroups", "updateExposures", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/EndorsementExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "UnderwritingPluginResponse": { "type": "object", "required": [ "decision", "notes" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "reject", "none" ] }, "notes": { "type": "array", "items": { "type": "string" } } } }, "UnderwritingPluginData": { "type": "object", "required": [ "operation", "policy", "policyholder" ], "properties": { "operation": { "type": "string", "enum": [ "new_business", "endorsement", "renewal", "reinstatement" ] }, "policy": { "$ref": "#/definitions/PolicyResponse" }, "policyholder": { "$ref": "#/definitions/PolicyholderResponse" } } }, "EventStreamCancellationCreateData": { "type": "object", "required": [ "cancellationLocator", "effectiveDate", "modificationName", "policyLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "effectiveDate": { "type": "integer" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PremiumReportUpdateRequest": { "type": "object", "properties": { "endTimestamp": { "type": "string" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoiceDueTimestamp": { "type": "string" } } }, "PremiumReportCreateRequest": { "type": "object", "required": [ "endTimestamp", "fieldGroups", "fieldValues" ], "properties": { "endTimestamp": { "type": "string" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoiceDueTimestamp": { "type": "string" }, "issue": { "type": "boolean" } } }, "EventStreamCancellationIssueData": { "type": "object", "required": [ "cancellationLocator", "effectiveDate", "modificationName", "policyLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "cancellationName": { "type": "string" }, "effectiveDate": { "type": "integer" }, "effectiveTimestamp": { "type": "string" }, "modificationName": { "type": "string" }, "policyLocator": { "type": "string" } } }, "ProductConfigurationResponse": { "type": "object", "required": [ "name", "policyConfiguration" ], "properties": { "claimConfiguration": { "$ref": "#/definitions/ClaimConfigurationResponse" }, "configVersion": { "type": "integer" }, "name": { "type": "string" }, "policyConfiguration": { "$ref": "#/definitions/PolicyConfigurationResponse" }, "premiumReportingConfiguration": { "type": "array", "items": { "$ref": "#/definitions/PremiumReportingConfigurationResponse" } } } }, "AutomatedUnderwritingResultResponse": { "type": "object", "required": [ "decision", "decisionTimestamp", "notes" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "reject", "none" ] }, "decisionTimestamp": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } } } }, "EndorsementActionRequest": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "discard", "quote", "accept", "issue", "invalidate", "update" ] }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "endorsementUpdate": { "$ref": "#/definitions/EndorsementUpdateRequest" } } }, "AuthenticateResponse": { "type": "object", "required": [ "authorizationToken", "expiresTimestamp" ], "properties": { "authorizationToken": { "type": "string" }, "expiresTimestamp": { "type": "string" } } }, "FeeResponse": { "type": "object", "required": [ "amount", "description", "endTimestamp", "locator", "name", "reversed", "startTimestamp" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "description": { "type": "string" }, "endTimestamp": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "reversed": { "type": "boolean" }, "startTimestamp": { "type": "string" } } }, "EventStreamSubClaimOpenData": { "type": "object", "required": [ "claimLocator", "policyLocator", "subClaimLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "EventStreamClaimOpenData": { "type": "object", "required": [ "claimLocator", "policyLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "QueryResponse": { "type": "object", "required": [ "logEvents", "nextPosition" ], "properties": { "logEvents": { "type": "array", "items": { "$ref": "#/definitions/QueryResponseLineItem" } }, "nextPosition": { "type": "string" } } }, "ExposureCharacteristicsPriceRequest": { "type": "object", "required": [ "fieldGroupsByLocator" ], "properties": { "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PerilUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "fieldValues", "perilLocator", "removeFieldGroups", "updateFieldGroups" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "deductible": { "type": "number" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "indemnityInAggregate": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "lumpSumPayment": { "type": "number" }, "perilLocator": { "type": "string" }, "removeDeductible": { "type": "boolean" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "removeIndemnityInAggregate": { "type": "boolean" }, "removeIndemnityPerEvent": { "type": "boolean" }, "removeIndemnityPerItem": { "type": "boolean" }, "removeLumpSumPayment": { "type": "boolean" }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "EventStreamPolicyEndReminderData": { "type": "object", "required": [ "policyEndTimestamp", "policyLocator", "reminderName" ], "properties": { "policyEndTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "reminderName": { "type": "string" } } }, "CatchUpInvoiceResponse": { "type": "object", "required": [ "createdTimestamp", "displayId", "documents", "dueTimestamp", "invoiceType", "locator", "policyLocator", "settlementStatus", "statuses", "totalDue", "totalDueCurrency", "transactionIssued", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "dueTimestamp": { "type": "string" }, "invoiceType": { "type": "string" }, "locator": { "type": "string" }, "payment": { "$ref": "#/definitions/PaymentResponse" }, "policyLocator": { "type": "string" }, "settlementStatus": { "type": "string", "enum": [ "outstanding", "settled" ] }, "settlementType": { "type": "string", "enum": [ "paid", "writtenOff", "zeroDue", "invalidated", "carriedForward" ] }, "statuses": { "type": "array", "items": { "$ref": "#/definitions/PolicyInvoiceStatusAndTimeResponse" } }, "totalDue": { "type": "number" }, "totalDueCurrency": { "type": "string" }, "transactionIssued": { "type": "boolean" }, "updatedTimestamp": { "type": "string" } } }, "GroupTableResponse": { "type": "object", "required": [ "failedTables", "successfulTables" ], "properties": { "failedTables": { "$ref": "#/definitions/ErrorTableResponse" }, "successfulTables": { "$ref": "#/definitions/TableResponse" } } }, "EventStreamRenewalUpdateData": { "type": "object", "required": [ "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "AuxDataResponse": { "type": "object", "required": [ "key", "locator", "uiType", "value" ], "properties": { "key": { "type": "string" }, "locator": { "type": "string" }, "uiType": { "type": "string", "enum": [ "normal", "hidden", "readonly" ] }, "value": { "type": "string" } } }, "FailureHandlingResponse": { "type": "object", "required": [ "actOnStatusCodes", "actOnTimeout", "mode" ], "properties": { "actOnStatusCodes": { "type": "array", "items": { "type": "string" } }, "actOnTimeout": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "none", "divert", "suspend" ] } } }, "RenewalResponse": { "type": "object", "required": [ "addExposures", "addFieldGroups", "createdTimestamp", "documents", "endExposures", "fieldValues", "locator", "policyholderLocator", "policyLocator", "productLocator", "removeFieldGroups", "renewalEndTimestamp", "renewalStartTimestamp", "state", "updatedTimestamp", "updateExposures", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "automatedUnderwritingResult": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "createdTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoice": { "$ref": "#/definitions/PolicyInvoiceResponse" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "newPaymentScheduleName": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "plannedInvoices": { "type": "array", "items": { "$ref": "#/definitions/FutureInvoiceResponse" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "price": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "productLocator": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "renewalEndTimestamp": { "type": "string" }, "renewalStartTimestamp": { "type": "string" }, "resourcesAsOfTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "application", "quoted", "accepted", "issued", "invalidated", "discarded" ] }, "updatedTimestamp": { "type": "string" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/RenewalExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "FieldConfiguration": { "type": "object", "required": [ "name", "order", "title", "type" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "optional": { "type": "boolean" } } }, "CancellationValidationError": { "type": "object", "required": [ "code", "name" ], "properties": { "code": { "type": "string", "enum": [ "MISSING", "INVALID_FIELD", "INVALID_TYPE", "INVALID_VALUE" ] }, "message": { "type": "string" }, "name": { "type": "string" } } }, "SearchTermRequestApi": { "type": "object", "required": [ "searchTerm" ], "properties": { "absolute": { "type": "string" }, "fieldName": { "type": "string" }, "match": { "type": "string" }, "searchTerm": { "type": "string" } } }, "ExternalRaterPriceResponse": { "type": "object", "required": [ "pricedPerilCharacteristics" ], "properties": { "exceptionMessage": { "type": "string" }, "pricedPerilCharacteristics": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ExternalRaterPricedCharacteristics" } } } }, "AutofillExposureUpdateResponse": { "type": "object", "required": [ "exposureLocator", "fieldValues" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "addPerils": { "type": "array", "items": { "$ref": "#/definitions/AutofillPerilCreateRequest" } }, "exposureLocator": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "removePerils": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateResponse" } }, "updatePerils": { "type": "array", "items": { "$ref": "#/definitions/AutofillPerilUpdateResponse" } } } }, "EventStreamSubClaimReserveUpdateData": { "type": "object", "required": [ "claimLocator", "policyLocator", "reserveCurrency", "reserveType", "subClaimLocator" ], "properties": { "claimLocator": { "type": "string" }, "newAmount": { "type": "number" }, "oldAmount": { "type": "number" }, "policyLocator": { "type": "string" }, "reserveCurrency": { "type": "string" }, "reserveType": { "type": "string", "enum": [ "loss", "expense" ] }, "subClaimLocator": { "type": "string" } } }, "PerilCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "deductible": { "type": "number" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "indemnityInAggregate": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "locator": { "type": "string" }, "lumpSumPayment": { "type": "number" }, "name": { "type": "string" } } }, "PaymentSchedulePluginInstallmentResponse": { "type": "object", "required": [ "dueTimestamp", "endTimestamp", "installmentFees", "invoiceItems", "issueTimestamp", "startTimestamp", "writeOff" ], "properties": { "dueTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "installmentFees": { "type": "array", "items": { "$ref": "#/definitions/InstallmentFee" } }, "invoiceItems": { "type": "array", "items": { "$ref": "#/definitions/PaymentSchedulePluginInvoiceItemResponse" } }, "issueTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "writeOff": { "type": "boolean" } } }, "ReinstatementAmountDueRequest": { "type": "object", "required": [ "reinstatementTimestamp" ], "properties": { "reinstatementTimestamp": { "type": "string" } } }, "EventStreamPaymentDeclineData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "ConfigurationVersionResponse": { "type": "object", "required": [ "deployedTimestamp", "version" ], "properties": { "deployedTimestamp": { "type": "string" }, "version": { "type": "integer" } } }, "PluginPolicyInfo": { "type": "object", "required": [ "currency", "locator", "originalContractStartTimestamp", "policyholderLocator", "productName" ], "properties": { "currency": { "type": "string" }, "locator": { "type": "string" }, "originalContractStartTimestamp": { "type": "string" }, "policyholderLocator": { "type": "string" }, "productName": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "QueryResponseLineItem": { "type": "object", "required": [ "message", "requestId", "timestamp" ], "properties": { "message": { "type": "string" }, "requestId": { "type": "string" }, "timestamp": { "type": "string" } } }, "PerilCreateResponse": { "type": "object", "required": [ "fieldGroups", "fieldValues", "locator", "name" ], "properties": { "deductible": { "type": "number" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "indemnityInAggregate": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "locator": { "type": "string" }, "lumpSumPayment": { "type": "number" }, "name": { "type": "string" } } }, "PerilModificationResponse": { "type": "object", "required": [ "exposureModificationLocator", "locator", "perilLocator", "policyholderLocator", "policyLocator", "productLocator" ], "properties": { "exposureModificationLocator": { "type": "string" }, "locator": { "type": "string" }, "newPerilCharacteristicsLocator": { "type": "string" }, "perilLocator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumChange": { "type": "number" }, "premiumChangeCurrency": { "type": "string" }, "productLocator": { "type": "string" }, "replacedPerilCharacteristicsLocator": { "type": "string" } } }, "TaxGroupResponse": { "type": "object", "required": [ "amount", "name" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "name": { "type": "string" } } }, "TaxConfigurationResponse": { "type": "object", "required": [ "displayName", "name" ], "properties": { "displayName": { "type": "string" }, "name": { "type": "string" } } }, "DocumentPageLayout": { "type": "object", "properties": { "marginBottom": { "type": "number" }, "marginLeft": { "type": "number" }, "marginRight": { "type": "number" }, "marginTop": { "type": "number" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ] }, "pageSize": { "type": "string", "enum": [ "letter", "legal", "tabloid", "a3", "a4", "a5", "b4", "b5" ] } } }, "EventStreamEndorsementEffectiveData": { "type": "object", "required": [ "effectiveTimestamp", "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "effectiveTimestamp": { "type": "string" }, "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "DocumentConsolidation": { "type": "object", "required": [ "displayName", "documentLocators", "fileName" ], "properties": { "deleteSourceDocuments": { "type": "boolean" }, "displayName": { "type": "string" }, "documentLocators": { "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" } } }, "Identifiable": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "ReserveResponse": { "type": "object", "required": [ "createdTimestamp", "currentAmount", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "currentAmount": { "type": "number" }, "updatedTimestamp": { "type": "string" } } }, "LapseConfigurationResponse": { "type": "object", "required": [ "gracePeriodDays", "reinstatementPeriodDays" ], "properties": { "gracePeriodDays": { "type": "integer" }, "reinstatementPeriodDays": { "type": "integer" } } }, "SubClaimPayableResponse": { "type": "object", "required": [ "amount", "claimLocator", "createdTimestamp", "locator", "reserveCurrency", "reserveType", "subClaimLocator" ], "properties": { "amount": { "type": "number" }, "claimLocator": { "type": "string" }, "comment": { "type": "string" }, "createdTimestamp": { "type": "string" }, "locator": { "type": "string" }, "recipient": { "type": "string" }, "reserveCurrency": { "type": "string" }, "reserveType": { "type": "string", "enum": [ "loss", "expense" ] }, "reversalLocator": { "type": "string" }, "reversedLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "AccountResponse": { "type": "object", "required": [ "accountType", "createdTimestamp", "deleted", "email", "id", "locked", "name", "roles", "tenant", "userLocator", "username" ], "properties": { "accountType": { "type": "string", "enum": [ "account.internal", "account.tenant.employee", "account.tenant.read.only.user", "account.tenant.claims.only.user", "bootstrap", "account.useRoles" ] }, "createdTimestamp": { "type": "string" }, "deleted": { "type": "boolean" }, "email": { "type": "string" }, "id": { "type": "string" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleResponse" } }, "tenant": { "type": "string" }, "userLocator": { "type": "string" }, "username": { "type": "string" } } }, "EventStreamEndorsementQuoteData": { "type": "object", "required": [ "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "PaymentSchedulePluginCharge": { "type": "object", "required": [ "amount", "amountCurrency", "chargeId", "coverageEndTimestamp", "coverageStartTimestamp", "isNew", "originalAmount", "policyModificationLocator", "previouslyInvoicedAmount", "type" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "category": { "type": "string", "enum": [ "new", "previously_invoiced", "carried_forward" ] }, "chargeId": { "type": "string" }, "commissionLocator": { "type": "string" }, "commissionRecipient": { "type": "string" }, "coverageEndTimestamp": { "type": "string" }, "coverageStartTimestamp": { "type": "string" }, "feeLocator": { "type": "string" }, "feeName": { "type": "string" }, "isNew": { "type": "boolean" }, "originalAmount": { "type": "number" }, "perilCharacteristicsLocator": { "type": "string" }, "perilLocator": { "type": "string" }, "perilName": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "previouslyInvoicedAmount": { "type": "number" }, "taxLocator": { "type": "string" }, "taxName": { "type": "string" }, "type": { "type": "string", "enum": [ "premium", "tax", "commission", "fee", "technicalPremium", "premiumHoldback", "taxHoldback", "feeHoldback", "commissionHoldback", "premiumHoldbackReversal", "taxHoldbackReversal", "feeHoldbackReversal", "commissionHoldbackReversal" ] } } }, "ValidationFieldError2": { "type": "object", "required": [ "code", "fieldName" ], "properties": { "code": { "type": "string", "enum": [ "MISSING", "INVALID_FIELD", "INVALID_TYPE", "INVALID_VALUE" ] }, "fieldName": { "type": "string" }, "message": { "type": "string" } } }, "PolicyQuoteResponse": { "type": "object", "required": [ "characteristics", "contractEndTimestamp", "contractStartTimestamp", "createdTimestamp", "documents", "exposures", "fees", "invoices", "locator", "name", "policyholderLocator", "policyLocator", "productLocator", "productName", "selected", "state", "updatedTimestamp" ], "properties": { "automatedUnderwritingResult": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "characteristics": { "$ref": "#/definitions/PolicyCharacteristicsResponse" }, "contractEndTimestamp": { "type": "string" }, "contractStartTimestamp": { "type": "string" }, "createdTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureResponse" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } }, "grossFees": { "type": "number" }, "grossFeesCurrency": { "type": "string" }, "invoices": { "type": "array", "items": { "$ref": "#/definitions/PolicyQuoteInvoiceResponse" } }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "paymentScheduleName": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "productLocator": { "type": "string" }, "productName": { "type": "string" }, "resourcesAsOfTimestamp": { "type": "string" }, "selected": { "type": "boolean" }, "state": { "type": "string", "enum": [ "draft", "quoted", "accepted", "declined", "discarded" ] }, "updatedTimestamp": { "type": "string" } } }, "ProrationPluginData": { "type": "object", "required": [ "items", "operation", "paymentScheduleName", "policy", "segmentSplitTimestamp", "tenantTimeZone" ], "properties": { "cancellationCategory": { "type": "string" }, "cancellationComments": { "type": "string" }, "cancellationType": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/ProrationPluginItem" } }, "oldPaymentScheduleName": { "type": "string" }, "operation": { "type": "string", "enum": [ "creation", "endorsement", "renewal", "cancellation", "reinstatement", "withdrawal", "action" ] }, "paymentScheduleName": { "type": "string" }, "policy": { "$ref": "#/definitions/PluginPolicyInfo" }, "segmentSplitTimestamp": { "type": "string" }, "tenantTimeZone": { "type": "string" } } }, "PolicyPriceChangeResponse": { "type": "object", "required": [ "commissions", "exposurePrices", "fees", "grossCommissionsChange", "grossFeesChange", "grossPremiumChange", "grossTaxesChange", "holdbacks", "newGrossCommissions", "newGrossFees", "newGrossPremium", "newGrossTaxes", "newTotal", "taxGroups", "totalChange" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionChangeResponse" } }, "exposurePrices": { "type": "array", "items": { "$ref": "#/definitions/ExposurePriceChangeResponse" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeChangeResponse" } }, "grossCommissionsChange": { "type": "number" }, "grossFeesChange": { "type": "number" }, "grossPremiumChange": { "type": "number" }, "grossTaxesChange": { "type": "number" }, "holdbacks": { "type": "array", "items": { "$ref": "#/definitions/HoldbackResponse" } }, "newGrossCommissions": { "type": "number" }, "newGrossFees": { "type": "number" }, "newGrossPremium": { "type": "number" }, "newGrossTaxes": { "type": "number" }, "newTotal": { "type": "number" }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxChangeResponse" } }, "totalChange": { "type": "number" } } }, "GetPolicyPriceResponse": { "type": "object", "required": [ "commissions", "exposurePrices", "fees", "grossCommissions", "grossFees", "grossPremium", "grossTaxes", "holdbacks", "taxGroups", "total" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "exposurePrices": { "type": "array", "items": { "$ref": "#/definitions/GetExposurePriceResponse" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } }, "grossCommissions": { "type": "number" }, "grossCommissionsCurrency": { "type": "string" }, "grossFees": { "type": "number" }, "grossFeesCurrency": { "type": "string" }, "grossPremium": { "type": "number" }, "grossPremiumCurrency": { "type": "string" }, "grossTaxes": { "type": "number" }, "grossTaxesCurrency": { "type": "string" }, "grossTechnicalPremium": { "type": "number" }, "grossTechnicalPremiumCurrency": { "type": "string" }, "holdbacks": { "type": "array", "items": { "$ref": "#/definitions/HoldbackResponse" } }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "total": { "type": "number" }, "totalCurrency": { "type": "string" } } }, "ReinstatementAmountDueResponse": { "type": "object", "required": [ "grossFeesDue", "grossPremiumDue", "grossTaxesDue", "totalDue" ], "properties": { "grossFeesDue": { "type": "number" }, "grossPremiumDue": { "type": "number" }, "grossTaxesDue": { "type": "number" }, "totalDue": { "type": "number" } } }, "AuxDataKeyResponse": { "type": "object", "required": [ "key", "uiType" ], "properties": { "key": { "type": "string" }, "uiType": { "type": "string", "enum": [ "normal", "hidden", "readonly" ] } } }, "SubEntityCreateRequest": { "type": "object", "required": [ "completed", "ontologyUri", "values" ], "properties": { "completed": { "type": "boolean" }, "localId": { "type": "string" }, "ontologyUri": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PayableCommissionsReportRequest": { "type": "object", "required": [ "endTimestamp", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "PaymentScheduleResponse": { "type": "object", "required": [ "displayName", "name", "type" ], "properties": { "displayName": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "total", "custom", "monthly", "annually", "semiannually", "quarterly", "every_two_weeks", "every_week", "2Pay", "5Pay" ] } } }, "LedgerLineItem": { "type": "object", "required": [ "amountChange", "changeTimestamp", "changeType", "reserveBalance" ], "properties": { "amountChange": { "type": "number" }, "changeTimestamp": { "type": "string" }, "changeType": { "type": "string", "enum": [ "payable.created", "payable.reversed", "reserve.updated", "reserve.closed", "reserve.opened", "reserve.reopened" ] }, "newAmount": { "type": "number" }, "oldAmount": { "type": "number" }, "payableLocator": { "type": "string" }, "reserveBalance": { "type": "number" } } }, "EntityResponse2": { "type": "object", "required": [ "accountLocator", "completed", "createdTimestamp", "flags", "locator", "revision", "updatedTimestamp", "values" ], "properties": { "accountLocator": { "type": "string" }, "completed": { "type": "boolean" }, "createdTimestamp": { "type": "string" }, "flags": { "type": "array", "items": { "type": "string", "enum": [ "flag.entity.workflow.complete", "flag.entity.workflow.started", "flag.entity.canceled", "flag.entity.test" ] } }, "locator": { "type": "string" }, "revision": { "type": "string" }, "subEntitiesByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/EntityResponse2" } }, "updatedTimestamp": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "AutofillCallResponse": { "type": "object", "required": [ "callSequence", "locator", "operation" ], "properties": { "callSequence": { "type": "array", "items": { "type": "string" } }, "locator": { "type": "string" }, "operation": { "type": "string" } } }, "PolicyConfigurationResponse": { "type": "object", "required": [ "cancellations", "documents", "endorsements", "exposures", "externalDataCalls", "fees", "fields", "invoicing", "paymentSchedules", "plugins", "reminders", "renewals", "taxes" ], "properties": { "cancellations": { "$ref": "#/definitions/CancellationConfigurationResponse" }, "defaultPaymentTerms": { "$ref": "#/definitions/PaymentTermsResponse" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } }, "endorsements": { "type": "array", "items": { "$ref": "#/definitions/EndorsementConfigurationResponse" } }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureConfigurationResponse" } }, "externalDataCalls": { "type": "array", "items": { "$ref": "#/definitions/FrontendExternalDataCallConfiguration" } }, "externalRater": { "type": "string" }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeConfigurationResponse" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "invoicing": { "$ref": "#/definitions/PolicyInvoicingConfiguration" }, "lapse": { "$ref": "#/definitions/LapseConfigurationResponse" }, "paymentSchedules": { "type": "array", "items": { "$ref": "#/definitions/PaymentScheduleResponse" } }, "plugins": { "$ref": "#/definitions/ProductScriptingConfig" }, "policyAsOf": { "type": "string", "enum": [ "quotation", "term_start" ] }, "reminders": { "type": "array", "items": { "$ref": "#/definitions/ReminderConfigurationResponse" } }, "renewals": { "type": "array", "items": { "$ref": "#/definitions/RenewalConfigurationResponse" } }, "searchSummary": { "type": "array", "items": { "type": "string" } }, "taxes": { "type": "array", "items": { "$ref": "#/definitions/TaxConfigurationResponse" } } } }, "GracePeriodUpdateRequest": { "type": "object", "properties": { "cancelEffectiveTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "resetCancelEffectiveTimestamp": { "type": "boolean" } } }, "PaymentScheduleChangeRequest": { "type": "object", "required": [ "newPaymentScheduleName" ], "properties": { "newPaymentScheduleName": { "type": "string" } } }, "EventStreamSubClaimPayableCreateData": { "type": "object", "required": [ "claimLocator", "payableLocator", "policyLocator", "subClaimLocator" ], "properties": { "amountChange": { "type": "number" }, "claimLocator": { "type": "string" }, "payableLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reserveCurrency": { "type": "string" }, "reserveType": { "type": "string", "enum": [ "loss", "expense" ] }, "subClaimLocator": { "type": "string" } } }, "CancellationInfo": { "type": "object", "required": [ "effectiveTimestamp", "modificationLocator", "modificationName" ], "properties": { "effectiveTimestamp": { "type": "string" }, "modificationLocator": { "type": "string" }, "modificationName": { "type": "string" } } }, "FieldGroupCreateRequest": { "type": "object", "required": [ "fieldName" ], "properties": { "fieldName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "EventStreamReinstatementEffectiveData": { "type": "object", "required": [ "cancellationLocator", "effectiveTimestamp", "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "effectiveTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "SearchResultResponseApi": { "type": "object", "required": [ "policyholderLocator", "score", "type" ], "properties": { "claimLocator": { "type": "string" }, "paymentDisplayId": { "type": "string" }, "paymentLocator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" }, "quoteLocator": { "type": "string" }, "score": { "type": "number" }, "searchSummary": { "type": "array", "items": { "$ref": "#/definitions/SearchSummaryItemResponseApi" } }, "subclaimLocator": { "type": "string" }, "type": { "type": "string" } } }, "PolicyModificationResponse": { "type": "object", "required": [ "createdTimestamp", "displayId", "exposureModifications", "fieldGroupsByLocator", "fieldValues", "locator", "mediaByLocator", "name", "newPolicyCharacteristicsLocators", "number", "policyholderLocator", "policyLocator", "productLocator", "updatedTimestamp" ], "properties": { "automatedUnderwritingResult": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "cancellationLocator": { "type": "string" }, "cancellationName": { "type": "string" }, "configVersion": { "type": "integer" }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "effectiveTimestamp": { "type": "string" }, "endorsementLocator": { "type": "string" }, "exposureModifications": { "type": "array", "items": { "$ref": "#/definitions/ExposureModificationResponse" } }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "name": { "type": "string" }, "newPolicyCharacteristicsLocator": { "type": "string" }, "newPolicyCharacteristicsLocators": { "type": "array", "items": { "type": "string" } }, "number": { "type": "integer" }, "policyEndTimestamp": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "premiumChange": { "type": "number" }, "premiumChangeCurrency": { "type": "string" }, "productLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "resourcesAsOfTimestamp": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "CatchUpInvoiceIssueRequest": { "type": "object", "required": [ "dueTimestamp", "totalDue" ], "properties": { "dueTimestamp": { "type": "string" }, "totalDue": { "type": "number" } } }, "EventStreamPolicyUpdateData": { "type": "object", "required": [ "policyLocator" ], "properties": { "policyLocator": { "type": "string" } } }, "PolicySnapshotResponse": { "type": "object", "required": [ "characteristics", "exposures", "locator", "policyholderLocator", "productName", "snapshotTimestamp" ], "properties": { "characteristics": { "type": "array", "items": { "$ref": "#/definitions/PolicyCharacteristicsResponse" } }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureSnapshotResponse" } }, "locator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "productName": { "type": "string" }, "snapshotTimestamp": { "type": "string" } } }, "EventStreamPaymentDiscardData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "DocumentRenderResponse": { "type": "object", "required": [ "assignedVariables" ], "properties": { "assignedVariables": { "type": "object", "additionalProperties": { "type": "object" } }, "renderedHtmlUrl": { "type": "string" }, "renderedPdfUrl": { "type": "string" } } }, "PremiumReportingConfigurationResponse": { "type": "object", "required": [ "documents", "fields", "id", "productRevisionLocator", "reportName", "tenantLocator" ], "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "id": { "type": "string" }, "productRevisionLocator": { "type": "string" }, "reportName": { "type": "string" }, "searchSummary": { "type": "array", "items": { "type": "string" } }, "tenantLocator": { "type": "string" } } }, "EventStreamPolicyInvoicePastDueData": { "type": "object", "required": [ "invoiceLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "PolicyUpdateRequest": { "type": "object", "required": [ "addExposures", "addFieldGroups", "removeExposures", "removeFieldGroups", "updateExposures", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "effectiveContractEndTimestamp": { "type": "string" }, "effectiveContractStartTimestamp": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "finalize": { "type": "boolean" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "paymentScheduleName": { "type": "string" }, "policyEndTimestamp": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "removeExposures": { "type": "array", "items": { "type": "string" } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "resetOverrideResourcesAsOfTimestamp": { "type": "boolean" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/DraftPolicyExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "DisbursementUpdateRequest": { "type": "object", "properties": { "amount": { "type": "number" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PolicyholderCreateRequest": { "type": "object", "properties": { "completed": { "type": "boolean" }, "subEntities": { "type": "array", "items": { "$ref": "#/definitions/SubEntityCreateRequest" } }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PolicySnapshotRequest": { "type": "object", "required": [ "snapshotTimestamp" ], "properties": { "snapshotTimestamp": { "type": "string" } } }, "EventStreamSubClaimReOpenData": { "type": "object", "required": [ "claimLocator", "policyLocator", "subClaimLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "EventStreamPolicyIssueData": { "type": "object", "required": [ "policyLocator" ], "properties": { "policyLocator": { "type": "string" } } }, "CommissionChangeResponse": { "type": "object", "required": [ "amountChange", "newAmount", "recipient" ], "properties": { "amountChange": { "type": "number" }, "newAmount": { "type": "number" }, "recipient": { "type": "string" } } }, "ReserveHistoryResponse": { "type": "object", "required": [ "expenseReserveHistory", "lossReserveHistory", "reserveCurrency" ], "properties": { "expenseReserveHistory": { "type": "array", "items": { "$ref": "#/definitions/ReserveVersionResponse" } }, "lossReserveHistory": { "type": "array", "items": { "$ref": "#/definitions/ReserveVersionResponse" } }, "reserveCurrency": { "type": "string" } } }, "GroupFieldConfiguration": { "type": "object", "required": [ "fields", "name", "order", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } }, "heading": { "type": "string" }, "maximum": { "type": "integer" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "repeatable": { "type": "boolean" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "EventStreamClaimCreateData": { "type": "object", "required": [ "claimLocator", "policyLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "TenantAssetsResponse": { "type": "object", "required": [ "accountLocator", "locator", "tenantLocator", "uploadTimestamp" ], "properties": { "accountLocator": { "type": "string" }, "configurationVersion": { "type": "integer" }, "deploymentTimestamp": { "type": "string" }, "locator": { "type": "string" }, "tenantLocator": { "type": "string" }, "uploadTimestamp": { "type": "string" } } }, "PremiumReportPremiumResponse": { "type": "object", "required": [ "category", "premium" ], "properties": { "category": { "type": "string" }, "premium": { "type": "number" } } }, "EventStreamSubClaimUpdateData": { "type": "object", "required": [ "claimLocator", "policyLocator", "subClaimLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "PremiumReportingInvoiceStatusAndTimeResponse": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "unfulfilled", "paid", "writtenOff", "zeroDue", "invalidated", "carriedForward" ] }, "timestamp": { "type": "string" } } }, "CashBalanceLogsPagedResponse": { "type": "object", "required": [ "cashBalanceLogs" ], "properties": { "cashBalanceLogs": { "type": "array", "items": { "$ref": "#/definitions/CashBalanceLogResponse" } }, "pagingToken": { "type": "string" } } }, "EventStreamCashTransferData": { "type": "object", "required": [ "amount", "name", "sourceCashBalanceLocator", "targetCashBalanceLocator" ], "properties": { "amount": { "type": "number" }, "details": { "type": "string" }, "name": { "type": "string" }, "sourceCashBalanceLocator": { "type": "string" }, "targetCashBalanceLocator": { "type": "string" } } }, "EventStreamPolicyFinalizeData": { "type": "object", "required": [ "policyLocator" ], "properties": { "policyLocator": { "type": "string" } } }, "EventStreamReinstatementAcceptData": { "type": "object", "required": [ "cancellationLocator", "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "LambdaRequest": { "type": "object", "required": [ "operation", "payload" ], "properties": { "operation": { "type": "string" }, "payload": { "type": "object" } } }, "GroupStaticDocumentResponse": { "type": "object", "required": [ "failedStaticDocuments", "successfulStaticDocuments" ], "properties": { "failedStaticDocuments": { "$ref": "#/definitions/ErrorTableResponse" }, "successfulStaticDocuments": { "$ref": "#/definitions/StaticDocumentResponse" } } }, "PerilCharacteristicsPriceRequest": { "type": "object", "required": [ "fieldGroupsByLocator" ], "properties": { "deductible": { "type": "number" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "indemnityInAggregate": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "lumpSumPayment": { "type": "number" } } }, "SsoClientResponse": { "type": "object", "required": [ "clientId", "role" ], "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "clientUuid": { "type": "string" }, "namespace": { "type": "string" }, "role": { "type": "string" } } }, "RatingPluginResponse": { "type": "object", "required": [ "pricedPerilCharacteristics" ], "properties": { "exceptionMessage": { "type": "string" }, "pricedPerilCharacteristics": { "type": "object", "additionalProperties": { "$ref": "#/definitions/RatingPluginPriceResponse" } } } }, "FutureInvoiceResponse": { "type": "object", "required": [ "endTimestamp", "financialTransactions", "issueTimestamp", "startTimestamp" ], "properties": { "dueTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "financialTransactions": { "type": "array", "items": { "$ref": "#/definitions/FinancialTransactionResponse" } }, "issueTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "writeOff": { "type": "boolean" } } }, "EventStreamDisbursementIssueData": { "type": "object", "required": [ "cashBalanceLocator", "disbursementLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "disbursementLocator": { "type": "string" } } }, "EventStreamPaymentDraftData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "EventStreamEndorsementAcceptData": { "type": "object", "required": [ "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "FieldGroupErrors": { "type": "object", "required": [ "errors", "fieldName" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/ValidationFieldError2" } }, "fieldName": { "type": "string" }, "index": { "type": "integer" }, "locator": { "type": "string" } } }, "ClaimResponse": { "type": "object", "required": [ "createdTimestamp", "currentStatus", "fieldGroupsByLocator", "fieldValues", "locator", "mediaByLocator", "policyLocator", "productName", "subClaims", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "currentStatus": { "type": "string", "enum": [ "pending", "open", "closed" ] }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "incidentTimestamp": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "notificationTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "productName": { "type": "string" }, "subClaims": { "type": "array", "items": { "$ref": "#/definitions/SubClaimResponse" } }, "updatedTimestamp": { "type": "string" } } }, "SubClaimPayableListsResponse": { "type": "object", "required": [ "expensePayables", "lossPayables", "reserveCurrency" ], "properties": { "expensePayables": { "type": "array", "items": { "$ref": "#/definitions/SubClaimPayableResponse" } }, "lossPayables": { "type": "array", "items": { "$ref": "#/definitions/SubClaimPayableResponse" } }, "reserveCurrency": { "type": "string" } } }, "ErrorStaticDocumentResponse": { "type": "object", "required": [ "effectiveTimestamp", "errorDetails", "StaticDocumentName" ], "properties": { "effectiveTimestamp": { "type": "string" }, "errorDetails": { "type": "string" }, "StaticDocumentName": { "type": "string" } } }, "PolicyDocumentRenderRequest2": { "type": "object", "required": [ "configProductTemplate", "policyDisplayId" ], "properties": { "configProductTemplate": { "type": "string" }, "policyDisplayId": { "type": "string" }, "resourcesAsOfTimestamp": { "type": "string" }, "transactionLocator": { "type": "string" }, "transactionType": { "type": "string", "enum": [ "renewal", "endorsement", "cancellation", "reinstatement", "premium_report" ] } } }, "CancellationReasonConfigurationResponse": { "type": "object", "required": [ "documents", "name", "title" ], "properties": { "cancellationCategories": { "type": "array", "items": { "type": "string" } }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } }, "name": { "type": "string" }, "reinstatement": { "$ref": "#/definitions/ReinstatementConfigurationResponse" }, "title": { "type": "string" } } }, "ExternalDataCallRequest": { "type": "object", "required": [ "policy" ], "properties": { "exposureCharacteristics": { "$ref": "#/definitions/ExposureCharacteristicsResponse" }, "perilCharacteristics": { "$ref": "#/definitions/PerilCharacteristicsResponse" }, "policy": { "$ref": "#/definitions/PolicyResponse" }, "policyCharacteristics": { "$ref": "#/definitions/PolicyCharacteristicsResponse" } } }, "PostIssuancePluginResponse": { "type": "object", "required": [ "documentConsolidations" ], "properties": { "documentConsolidations": { "type": "array", "items": { "$ref": "#/definitions/DocumentConsolidation" } } } }, "TenantAssetsUrlResponse": { "type": "object", "required": [ "expiresTimestamp", "tenantAssets", "url" ], "properties": { "expiresTimestamp": { "type": "string" }, "tenantAssets": { "$ref": "#/definitions/TenantAssetsResponse" }, "url": { "type": "string" } } }, "RoleUpdateRequest": { "type": "object", "properties": { "assignPermissions": { "type": "array", "items": { "type": "string" } }, "replaceAll": { "type": "boolean" }, "unassignPermissions": { "type": "array", "items": { "type": "string" } } } }, "EventStreamPolicyDiscardData": { "type": "object", "required": [ "policyLocator" ], "properties": { "policyLocator": { "type": "string" } } }, "ProrationResponseItem": { "type": "object", "required": [ "holdbackAmount", "id", "proratedAmount" ], "properties": { "holdbackAmount": { "type": "number" }, "holdbackMetadata": { "type": "string" }, "id": { "type": "string" }, "proratedAmount": { "type": "number" } } }, "AutofillFieldGroupUpdateResponse": { "type": "object", "required": [ "fieldGroupLocator", "fieldValues" ], "properties": { "fieldGroupLocator": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "EventStreamPremiumReportDiscardData": { "type": "object", "required": [ "policyLocator", "premiumReportLocator" ], "properties": { "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "PerilCharacteristicsResponse": { "type": "object", "required": [ "coverageEndTimestamp", "coverageStartTimestamp", "createdTimestamp", "exposureCharacteristicsLocator", "fieldGroupsByLocator", "fieldValues", "locator", "mediaByLocator", "perilLocator", "policyCharacteristicsLocator", "policyholderLocator", "policyLocator", "policyModificationLocator", "productLocator", "updatedTimestamp" ], "properties": { "characteristicsAsOfTimestamp": { "type": "string" }, "coverageEndTimestamp": { "type": "string" }, "coverageStartTimestamp": { "type": "string" }, "createdTimestamp": { "type": "string" }, "deductible": { "type": "number" }, "deductibleCurrency": { "type": "string" }, "exposureCharacteristicsLocator": { "type": "string" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "indemnityInAggregate": { "type": "string" }, "indemnityInAggregateCurrency": { "type": "string" }, "indemnityPerEvent": { "type": "string" }, "indemnityPerEventCurrency": { "type": "string" }, "indemnityPerItem": { "type": "string" }, "indemnityPerItemCurrency": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "lumpSumPayment": { "type": "number" }, "lumpSumPaymentCurrency": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "monthPremium": { "type": "number" }, "monthTechnicalPremium": { "type": "number" }, "perilLocator": { "type": "string" }, "policyCharacteristicsLocator": { "type": "string" }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "premium": { "type": "number" }, "premiumCurrency": { "type": "string" }, "productLocator": { "type": "string" }, "replacedTimestamp": { "type": "string" }, "technicalPremium": { "type": "number" }, "updatedTimestamp": { "type": "string" } } }, "AutofillFieldGroupUpdateRequest": { "type": "object", "required": [ "fieldGroupLocator", "fieldName" ], "properties": { "fieldGroupLocator": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "EventStreamSubClaimPayableReverseData": { "type": "object", "required": [ "claimLocator", "policyLocator", "reversalLocator", "reversedLocator", "subClaimLocator" ], "properties": { "amountChange": { "type": "number" }, "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reserveCurrency": { "type": "string" }, "reserveType": { "type": "string", "enum": [ "loss", "expense" ] }, "reversalLocator": { "type": "string" }, "reversedLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "RenewalConfigurationResponse": { "type": "object", "required": [ "documents" ], "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentConfiguration" } }, "renewalAsOf": { "type": "string", "enum": [ "quotation", "term_start" ] } } }, "PolicyEndorsementIssueRequest": { "type": "object", "required": [ "endorsementName" ], "properties": { "endorsementName": { "type": "string" }, "newPolicyEndTimestamp": { "type": "string" }, "reprice": { "type": "boolean" }, "startTimestamp": { "type": "string" }, "updatePolicy": { "$ref": "#/definitions/EndorsementPolicyUpdateRequest" } } }, "RenewalIssueRequest": { "type": "object", "required": [ "renewalEndTimestamp" ], "properties": { "policyUpdateRequest": { "$ref": "#/definitions/RenewalPolicyUpdateRequest" }, "renewalEndTimestamp": { "type": "string" } } }, "ExternalServiceIntegrationAddRequest": { "type": "object", "required": [ "name", "url" ], "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "securitySpec": { "$ref": "#/definitions/SecuritySpecification" }, "type": { "type": "string", "enum": [ "external_rater", "data_autofill", "webhook" ] }, "url": { "type": "string" } } }, "ClaimsPayablesReportRequest": { "type": "object", "required": [ "endTimestamp", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "EventStreamRenewalAcceptData": { "type": "object", "required": [ "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "ExposureValidationErrors": { "type": "object", "required": [ "exposureName", "hasErrors", "perilValidationErrors" ], "properties": { "exposureFieldErrors": { "$ref": "#/definitions/FieldErrors" }, "exposureLocator": { "type": "string" }, "exposureName": { "type": "string" }, "hasErrors": { "type": "boolean" }, "index": { "type": "integer" }, "message": { "type": "string" }, "perilValidationErrors": { "type": "array", "items": { "$ref": "#/definitions/PerilValidationErrors" } } } }, "FieldGroupUpdateRequest": { "type": "object", "required": [ "fieldGroupLocator", "fieldName", "fieldValues" ], "properties": { "fieldGroupLocator": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PerilPriceChangeResponse": { "type": "object", "required": [ "commissions", "grossCommissionsChange", "grossPremiumChange", "grossTaxesChange", "name", "newGrossCommissions", "newGrossPremium", "newGrossTaxes", "taxes" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionChangeResponse" } }, "grossCommissionsChange": { "type": "number" }, "grossPremiumChange": { "type": "number" }, "grossTaxesChange": { "type": "number" }, "locator": { "type": "string" }, "name": { "type": "string" }, "newGrossCommissions": { "type": "number" }, "newGrossPremium": { "type": "number" }, "newGrossTaxes": { "type": "number" }, "newlyAdded": { "type": "boolean" }, "taxes": { "type": "array", "items": { "$ref": "#/definitions/TaxChangeResponse" } } } }, "EventStreamPremiumReportReverseData": { "type": "object", "required": [ "policyLocator", "premiumReportLocator" ], "properties": { "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "SearchSummaryItemResponseApi": { "type": "object", "required": [ "fieldName", "fieldType", "fieldValue" ], "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string" }, "fieldValue": { "type": "array", "items": { "type": "string" } } } }, "EventStreamPremiumReportReplaceData": { "type": "object", "required": [ "newPremiumReportLocator", "policyLocator", "replacedPremiumReportLocator" ], "properties": { "newPremiumReportLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "replacedPremiumReportLocator": { "type": "string" } } }, "AccountUnlockRequest": { "type": "object", "required": [ "username" ], "properties": { "hostName": { "type": "string" }, "tenantName": { "type": "string" }, "username": { "type": "string" } } }, "EventStreamPremiumReportCreateData": { "type": "object", "required": [ "policyLocator", "premiumReportLocator" ], "properties": { "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "ExternalServiceIntegrationResponse": { "type": "object", "required": [ "headers", "name", "tenantLocator", "type", "url" ], "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "securitySpec": { "$ref": "#/definitions/SecuritySpecification" }, "tenantLocator": { "type": "string" }, "type": { "type": "string", "enum": [ "external_rater", "data_autofill", "webhook" ] }, "url": { "type": "string" } } }, "PremiumReportingPaymentResponse": { "type": "object", "required": [ "amount", "displayId", "fieldValues", "invoiceLocator", "locator", "mediaByLocator", "policyholderLocator", "postedTimestamp", "tenantLocator" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "displayId": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoiceLocator": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "policyholderLocator": { "type": "string" }, "postedTimestamp": { "type": "string" }, "reversedTimestamp": { "type": "string" }, "tenantLocator": { "type": "string" } } }, "AutofillPerilUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "perilLocator", "removeFieldGroups", "updateFieldGroups" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "perilLocator": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateRequest" } } } }, "ReservesReportRequest": { "type": "object", "required": [ "reportTimestamp" ], "properties": { "reportTimestamp": { "type": "string" } } }, "CancellationResponse": { "type": "object", "required": [ "conflictHandling", "createdTimestamp", "documents", "effectiveTimestamp", "locator", "name", "policyLocator", "policyModificationLocator", "state", "title" ], "properties": { "cancellationCategory": { "type": "string" }, "cancellationComments": { "type": "string" }, "conflictHandling": { "type": "string", "enum": [ "block", "invalidate" ] }, "createdTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "effectiveTimestamp": { "type": "string" }, "invoiceLocator": { "type": "string" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "price": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "reinstatement": { "$ref": "#/definitions/ReinstatementResponse" }, "state": { "type": "string", "enum": [ "draft", "issued", "rescinded", "reinstated" ] }, "title": { "type": "string" } } }, "PolicyQuoteListResponse": { "type": "object", "required": [ "quotes" ], "properties": { "quotes": { "type": "array", "items": { "$ref": "#/definitions/PolicyQuoteResponse" } } } }, "PremiumReportReplacementRequest": { "type": "object", "required": [ "fieldGroups", "fieldValues" ], "properties": { "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoiceDueTimestamp": { "type": "string" } } }, "TableRequest": { "type": "object", "required": [ "file" ], "properties": { "effectiveTimestamp": { "type": "string" }, "file": { "type": "string" }, "tableName": { "type": "string" } } }, "EventStreamEndorsementCreateData": { "type": "object", "required": [ "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "WebhookRequest": { "type": "object", "required": [ "name" ], "properties": { "alertIntegrationName": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "cancellation.create", "cancellation.update", "cancellation.rescind", "cancellation.issue", "cancellation.effective", "claim.close", "claim.create", "claim.discard", "claim.open", "claim.update", "policy.gracePeriod", "policy.gracePeriod.update", "invoice.issue", "invoice.invalidate", "invoice.pastDue", "invoice.writtenOff", "payment.pay", "policy.cancel", "policy.create", "policy.discard", "policy.endorse", "policy.finalize", "policy.issue", "policy.lapse", "policy.reinstatement.close", "policy.reinstatement.invoice", "policy.reinstatement.issue", "policy.reinstatement.open", "policy.renew", "policy.update", "policy.upgrade", "subClaim.open", "subClaim.update", "subClaim.close", "subClaim.reopen", "subClaim.updateReserve", "policy.end.reminder", "subClaim.createPayable", "subClaim.reversePayable", "endorsement.create", "endorsement.update", "endorsement.quote", "endorsement.accept", "endorsement.issue", "endorsement.invalidate", "endorsement.discard", "endorsement.effective", "reinstatement.accept", "reinstatement.create", "reinstatement.issue", "reinstatement.invalidate", "reinstatement.deadlineReached", "reinstatement.effective", "renewal.create", "renewal.update", "renewal.quote", "renewal.accept", "renewal.issue", "renewal.invalidate", "renewal.discard", "renewal.effective", "policy.effective", "policy.end", "policy.quote.create", "policy.quote.discard", "policy.quote.update", "policy.quote.quoted", "policy.quote.accept", "policy.quote.declined", "policy.quote.invalidate", "premiumReport.create", "premiumReport.update", "premiumReport.issue", "premiumReport.discard", "premiumReport.reverse", "premiumReport.replace", "premiumReport.effective", "premiumReport.pay", "login.success", "login.failure", "policyholder.create", "policyholder.update", "payment.reverse", "payment.update", "payment.ready", "payment.discard", "payment.return", "payment.decline", "payment.draft", "policy.gracePeriod.satisfied", "disbursement.issue", "disbursement.create", "disbursement.update", "catchUp.issue", "catchUp.writtenOff", "catchUp.pay", "catchUp.pay.reverse", "catchUp.invalidate", "catchUp.pastDue", "cash.transfer" ] } }, "failureHandling": { "$ref": "#/definitions/FailureHandlingRequest" }, "integrationName": { "type": "string" }, "name": { "type": "string" }, "resetAlertIntegrationName": { "type": "boolean" }, "retryStrategy": { "type": "string", "enum": [ "none", "one", "three" ] } } }, "PolicyConfigUpgradeRequest": { "type": "object", "required": [ "newConfigVersion" ], "properties": { "newConfigVersion": { "type": "integer" } } }, "EventStreamRenewalData": { "type": "object", "required": [ "endTimestamp", "modificationLocator", "policyLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "modificationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "FeeCreateRequest": { "type": "object", "required": [ "amount", "endTimestamp", "feeName", "startTimestamp" ], "properties": { "amount": { "type": "number" }, "description": { "type": "string" }, "endTimestamp": { "type": "string" }, "feeName": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "PolicyholderUpdateRequest": { "type": "object", "required": [ "completed", "locator", "version" ], "properties": { "addSubEntities": { "type": "array", "items": { "$ref": "#/definitions/SubEntityCreateRequest" } }, "completed": { "type": "boolean" }, "deleteSubEntities": { "type": "array", "items": { "type": "string" } }, "locator": { "type": "string" }, "updateSubEntities": { "type": "array", "items": { "$ref": "#/definitions/SubEntityUpdateRequest" } }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "version": { "type": "integer" } } }, "DisbursementsPagedResponse": { "type": "object", "required": [ "disbursements" ], "properties": { "disbursements": { "type": "array", "items": { "$ref": "#/definitions/DisbursementResponse" } }, "pagingToken": { "type": "string" } } }, "ExposurePriceChangeResponse": { "type": "object", "required": [ "commissions", "grossCommissionsChange", "grossPremiumChange", "grossTaxesChange", "name", "newGrossCommissions", "newGrossPremium", "newGrossTaxes", "perilPrices", "taxGroups" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionChangeResponse" } }, "grossCommissionsChange": { "type": "number" }, "grossPremiumChange": { "type": "number" }, "grossTaxesChange": { "type": "number" }, "locator": { "type": "string" }, "name": { "type": "string" }, "newGrossCommissions": { "type": "number" }, "newGrossPremium": { "type": "number" }, "newGrossTaxes": { "type": "number" }, "newlyAdded": { "type": "boolean" }, "perilPrices": { "type": "array", "items": { "$ref": "#/definitions/PerilPriceChangeResponse" } }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxChangeResponse" } } } }, "SsoClientAuthenticateRequest": { "type": "object", "required": [ "clientId", "clientSecret" ], "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "hostName": { "type": "string" } } }, "Media": { "type": "object", "required": [ "expiresTimestamp", "locator", "mimeType", "url" ], "properties": { "expiresTimestamp": { "type": "string" }, "fileName": { "type": "string" }, "locator": { "type": "string" }, "mimeType": { "type": "string" }, "url": { "type": "string" } } }, "ErrorTableResponse": { "type": "object", "required": [ "effectiveTimestamp", "errorDetails", "tableName" ], "properties": { "effectiveTimestamp": { "type": "string" }, "errorDetails": { "type": "string" }, "tableName": { "type": "string" } } }, "PreGracePluginResponse": { "type": "object", "properties": { "cancelEffectiveTimestamp": { "type": "string" }, "gracePeriodEndTimestamp": { "type": "string" } } }, "GetExposurePriceResponse": { "type": "object", "required": [ "commissions", "grossCommissions", "grossPremium", "grossTaxes", "locator", "name", "perilPrices", "taxGroups", "total" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "grossCommissions": { "type": "number" }, "grossCommissionsCurrency": { "type": "string" }, "grossPremium": { "type": "number" }, "grossPremiumCurrency": { "type": "string" }, "grossTaxes": { "type": "number" }, "grossTaxesCurrency": { "type": "string" }, "grossTechnicalPremium": { "type": "number" }, "grossTechnicalPremiumCurrency": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "perilPrices": { "type": "array", "items": { "$ref": "#/definitions/GetPerilPriceResponse" } }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "total": { "type": "number" }, "totalCurrency": { "type": "string" } } }, "PolicyInvoiceStatusAndTimeResponse": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "unfulfilled", "paid", "writtenOff", "zeroDue", "invalidated", "carriedForward" ] }, "timestamp": { "type": "string" } } }, "ProductScriptingConfig": { "type": "object", "required": [ "createInstallments", "getDataAutofill", "getPerilRates", "getPostIssuanceResult", "getPostPaymentReversal", "getPreGraceResult", "getProrationResult", "getUnderwritingResult" ], "properties": { "createInstallments": { "$ref": "#/definitions/ProductPluginConfig" }, "getDataAutofill": { "$ref": "#/definitions/ProductPluginConfig" }, "getPerilRates": { "$ref": "#/definitions/ProductPluginConfig" }, "getPostIssuanceResult": { "$ref": "#/definitions/ProductPluginConfig" }, "getPostPaymentReversal": { "$ref": "#/definitions/ProductPluginConfig" }, "getPreGraceResult": { "$ref": "#/definitions/ProductPluginConfig" }, "getProrationResult": { "$ref": "#/definitions/ProductPluginConfig" }, "getUnderwritingResult": { "$ref": "#/definitions/ProductPluginConfig" } } }, "ResourceDeployResponse": { "type": "object", "required": [ "effectiveTimestamp", "errorDetails", "locator", "name", "success", "type", "url", "urlExpirationTimestamp" ], "properties": { "effectiveTimestamp": { "type": "string" }, "errorDetails": { "type": "string" }, "locator": { "type": "string" }, "name": { "type": "string" }, "success": { "type": "boolean" }, "type": { "type": "string" }, "url": { "type": "string" }, "urlExpirationTimestamp": { "type": "string" } } }, "CheckInvoicesResponse": { "type": "object", "required": [ "futureInvoices", "generatedInvoices" ], "properties": { "futureInvoices": { "type": "array", "items": { "$ref": "#/definitions/FutureInvoiceResponse" } }, "generatedInvoices": { "type": "array", "items": { "$ref": "#/definitions/GeneratedInvoiceResponse" } } } }, "EventStreamClaimDiscardData": { "type": "object", "required": [ "claimLocator", "policyLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamPolicyQuoteAcceptData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } }, "FeeConfigurationResponse": { "type": "object", "required": [ "displayName", "name" ], "properties": { "displayName": { "type": "string" }, "name": { "type": "string" } } }, "EventStreamPaymentReverseData": { "type": "object", "required": [ "invoiceLocator", "paymentLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "paymentLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamPaymentReturnData": { "type": "object", "required": [ "paymentLocator" ], "properties": { "paymentLocator": { "type": "string" } } }, "ExposureCreateRequest": { "type": "object", "required": [ "exposureName" ], "properties": { "exposureName": { "type": "string" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateRequest" } } } }, "ProrationPluginItem": { "type": "object", "required": [ "amount", "followingAmount", "id", "segmentEndTimestamp", "segmentStartTimestamp", "type" ], "properties": { "amount": { "type": "number" }, "commissionLocator": { "type": "string" }, "commissionRecipient": { "type": "string" }, "feeLocator": { "type": "string" }, "feeName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "followingAmount": { "type": "number" }, "id": { "type": "string" }, "perilCharacteristicsLocator": { "type": "string" }, "perilName": { "type": "string" }, "segmentEndTimestamp": { "type": "string" }, "segmentStartTimestamp": { "type": "string" }, "taxLocator": { "type": "string" }, "taxName": { "type": "string" }, "type": { "type": "string", "enum": [ "premium", "tax", "commission", "fee", "technicalPremium", "premiumHoldback", "taxHoldback", "feeHoldback", "commissionHoldback", "premiumHoldbackReversal", "taxHoldbackReversal", "feeHoldbackReversal", "commissionHoldbackReversal" ] } } }, "SubClaimLedger": { "type": "object", "required": [ "lineItems" ], "properties": { "lineItems": { "type": "array", "items": { "$ref": "#/definitions/LedgerLineItem" } } } }, "EventStreamReinstatementIssueData": { "type": "object", "required": [ "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "ExternalServiceIntegrationUpdateRequest": { "type": "object", "required": [ "url" ], "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "securitySpec": { "$ref": "#/definitions/SecuritySpecification" }, "url": { "type": "string" } } }, "SubEntityUpdateRequest": { "type": "object", "required": [ "completed", "locator", "ontologyUri", "values" ], "properties": { "completed": { "type": "boolean" }, "locator": { "type": "string" }, "ontologyUri": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ExposureCreateResponse": { "type": "object", "required": [ "exposureLocator", "exposureName", "fieldGroups", "fieldValues", "locator", "perils" ], "properties": { "exposureLocator": { "type": "string" }, "exposureName": { "type": "string" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "locator": { "type": "string" }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateResponse" } } } }, "GraceLapseReinstatementResponse": { "type": "object", "required": [ "gracePeriod", "reinstatements" ], "properties": { "gracePeriod": { "$ref": "#/definitions/GracePeriodResponse" }, "lapse": { "$ref": "#/definitions/LapseResponse" }, "reinstatements": { "type": "array", "items": { "$ref": "#/definitions/LapseReinstatementResponse" } } } }, "EventStreamRenewalDiscardData": { "type": "object", "required": [ "policyLocator", "renewalLocator" ], "properties": { "policyLocator": { "type": "string" }, "renewalLocator": { "type": "string" } } }, "AuthenticateAdminResponse": { "type": "object", "required": [ "authorizationToken", "expiresTimestamp" ], "properties": { "authorizationToken": { "type": "string" }, "expiresTimestamp": { "type": "string" } } }, "EndorsementResponse": { "type": "object", "required": [ "addExposures", "addFieldGroups", "createdTimestamp", "documents", "endExposures", "endorsementName", "fieldValues", "locator", "policyholderLocator", "policyLocator", "productLocator", "removeFieldGroups", "reprice", "state", "updatedTimestamp", "updateExposures", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateResponse" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "automatedUnderwritingResult": { "$ref": "#/definitions/AutomatedUnderwritingResultResponse" }, "createdTimestamp": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "endorsementName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoice": { "$ref": "#/definitions/PolicyInvoiceResponse" }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "newPaymentScheduleName": { "type": "string" }, "newPolicyEndTimestamp": { "type": "string" }, "plannedInvoices": { "type": "array", "items": { "$ref": "#/definitions/FutureInvoiceResponse" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "price": { "$ref": "#/definitions/PolicyPriceChangeResponse" }, "productLocator": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "reprice": { "type": "boolean" }, "startTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "application", "quoted", "accepted", "issued", "invalidated", "discarded" ] }, "updatedTimestamp": { "type": "string" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/EndorsementExposureUpdateResponse" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "EventStreamLoginData": { "type": "object", "required": [ "username" ], "properties": { "username": { "type": "string" } } }, "EventStreamCatchUpPayReverseData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "EventStreamCatchUpPayData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "AutofillFieldGroupCreateRequest": { "type": "object", "required": [ "fieldName" ], "properties": { "fieldName": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "AutofillExposureCreateRequest": { "type": "object", "required": [ "exposureName", "fieldGroups", "perils" ], "properties": { "exposureName": { "type": "string" }, "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "perils": { "type": "array", "items": { "$ref": "#/definitions/PerilCreateRequest" } } } }, "EventStreamCatchUpPastDueData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "EventStreamRenewalIssueData": { "type": "object", "required": [ "endTimestamp", "policyLocator", "policyModificationLocator", "renewalLocator", "startTimestamp" ], "properties": { "endTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "startTimestamp": { "type": "string" } } }, "PolicyholderConfigurationResponse": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldConfiguration" } } } }, "AccountRoleUpdateRequest": { "type": "object", "properties": { "assignRoles": { "type": "array", "items": { "type": "string" } }, "replaceAll": { "type": "boolean" }, "unassignRoles": { "type": "array", "items": { "type": "string" } } } }, "ReinstatementDocumentRemoveRequest": { "type": "object", "required": [ "documentLocator" ], "properties": { "documentLocator": { "type": "string" } } }, "SelectFieldConfiguration": { "type": "object", "required": [ "name", "order", "title", "values" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "repeatable": { "type": "boolean" }, "search": { "type": "string" }, "title": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "width": { "type": "integer" } } }, "ResourceTimestampResponse": { "type": "object", "required": [ "" ], "properties": { "": { "type": "string" } } }, "RenewalUpdateRequest": { "type": "object", "required": [ "addFieldGroups", "removeFieldGroups", "updateFieldGroups" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "autofill": { "type": "array", "items": { "type": "string" } }, "endExposures": { "type": "array", "items": { "type": "string" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "newPaymentScheduleName": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "renewalEndTimestamp": { "type": "string" }, "resetOverrideResourcesAsOfTimestamp": { "type": "boolean" }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/RenewalExposureUpdateRequest" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupUpdateRequest" } } } }, "GetInvoiceFinancialTransactionsResponse": { "type": "object", "required": [ "financialTransactions" ], "properties": { "financialTransactions": { "type": "array", "items": { "$ref": "#/definitions/FinancialTransactionResponse" } } } }, "AutofillResponse": { "type": "object", "required": [ "fieldValues" ], "properties": { "addExposures": { "type": "array", "items": { "$ref": "#/definitions/AutofillExposureCreateRequest" } }, "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "endorsementEffectiveTimestamp": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "policyEndTimestamp": { "type": "string" }, "policyStartTimestamp": { "type": "string" }, "removeExposures": { "type": "array", "items": { "type": "string" } }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateExposures": { "type": "array", "items": { "$ref": "#/definitions/AutofillExposureUpdateResponse" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateResponse" } } } }, "CashBalanceTransferResponse": { "type": "object", "required": [ "amount", "newSourceCashBalanceAmount", "newTargetCashBalanceAmount", "previousSourceCashBalanceAmount", "previousTargetCashBalanceAmount", "sourceCashBalanceLocator", "targetCashBalanceLocator" ], "properties": { "amount": { "type": "number" }, "newSourceCashBalanceAmount": { "type": "number" }, "newTargetCashBalanceAmount": { "type": "number" }, "previousSourceCashBalanceAmount": { "type": "number" }, "previousTargetCashBalanceAmount": { "type": "number" }, "sourceCashBalanceLocator": { "type": "string" }, "targetCashBalanceLocator": { "type": "string" } } }, "LambdaResponse": { "type": "object", "required": [ "payload" ], "properties": { "payload": { "type": "object" } } }, "ReminderConfigurationResponse": { "type": "object", "required": [ "enabled", "from", "name", "offset" ], "properties": { "enabled": { "type": "boolean" }, "from": { "type": "string", "enum": [ "policy.end" ] }, "name": { "type": "string" }, "offset": { "type": "string" } } }, "FieldErrors": { "type": "object", "required": [ "errors", "fieldGroupErrors", "hasErrors" ], "properties": { "errorMessage": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/definitions/ValidationFieldError2" } }, "fieldGroupErrors": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupErrors" } }, "hasErrors": { "type": "boolean" } } }, "PolicyReportRequest": { "type": "object", "properties": { "exposureFields": { "type": "array", "items": { "type": "string" } }, "perilFields": { "type": "array", "items": { "type": "string" } }, "policyFields": { "type": "array", "items": { "type": "string" } }, "productNames": { "type": "array", "items": { "type": "string" } }, "reportEndTimestamp": { "type": "string" }, "reportStartTimestamp": { "type": "string" }, "reportTimestamp": { "type": "string" } } }, "AuthenticateRequest": { "type": "object", "required": [ "password", "username" ], "properties": { "hostName": { "type": "string" }, "password": { "type": "string" }, "tenantName": { "type": "string" }, "username": { "type": "string" } } }, "ExternalRaterPriceRequest": { "type": "object", "required": [ "operation", "policy", "policyExposurePerils", "tenantTimeZone" ], "properties": { "endorsementLocator": { "type": "string" }, "newPaymentScheduleName": { "type": "string" }, "operation": { "type": "string", "enum": [ "new_business", "endorsement", "renewal", "reinstatement" ] }, "policy": { "$ref": "#/definitions/PolicyResponse" }, "policyExposurePerils": { "type": "array", "items": { "$ref": "#/definitions/PolicyExposurePerilPricingRequest" } }, "quoteLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" }, "renewalLocator": { "type": "string" }, "tenantTimeZone": { "type": "string" } } }, "EventStreamData": { "type": "object", "properties": {} }, "EventStreamPolicyInvoiceInvalidateData": { "type": "object", "required": [ "invoiceLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "ReservesResponse": { "type": "object", "required": [ "history" ], "properties": { "history": { "$ref": "#/definitions/ReserveHistoryResponse" } } }, "EventStreamSubClaimCloseData": { "type": "object", "required": [ "claimLocator", "policyLocator", "subClaimLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "subClaimLocator": { "type": "string" } } }, "NumberFieldConfiguration": { "type": "object", "required": [ "name", "order", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "decimalPlaces": { "type": "integer" }, "heading": { "type": "string" }, "maximum": { "type": "number" }, "minimum": { "type": "number" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "ProductPluginConfig": { "type": "object", "required": [ "enabled", "path", "type" ], "properties": { "enabled": { "type": "boolean" }, "path": { "type": "string" }, "type": { "type": "string", "enum": [ "echo", "rater", "underwriter", "prorater", "installments", "postIssuance", "postPaymentReversal", "preGrace", "dataAutofill" ] } } }, "AutofillPerilUpdateResponse": { "type": "object", "required": [ "fieldValues", "perilLocator" ], "properties": { "addFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "perilLocator": { "type": "string" }, "removeFieldGroups": { "type": "array", "items": { "type": "string" } }, "updateFieldGroups": { "type": "array", "items": { "$ref": "#/definitions/AutofillFieldGroupUpdateResponse" } } } }, "DisbursementActionRequest": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "issue", "discard" ] }, "disbursementUpdate": { "$ref": "#/definitions/DisbursementUpdateRequest" } } }, "WebhookPayload": { "type": "object", "required": [ "data", "id", "timestamp", "transactionId", "type", "username" ], "properties": { "data": { "$ref": "#/definitions/EventStreamData" }, "id": { "type": "string" }, "timestamp": { "type": "string" }, "transactionId": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "ClaimCreateRequest": { "type": "object", "required": [ "policyLocator" ], "properties": { "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "incidentTimestamp": { "type": "string" }, "notificationTimestamp": { "type": "string" }, "policyLocator": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "open" ] } } }, "SearchResponseApi": { "type": "object", "required": [ "results" ], "properties": { "pageNumber": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/SearchResultResponseApi" } }, "searchToken": { "type": "string" } } }, "EventStreamPolicyEndData": { "type": "object", "required": [ "policyEndTimestamp", "policyLocator" ], "properties": { "policyEndTimestamp": { "type": "string" }, "policyLocator": { "type": "string" } } }, "AutofillPerilCreateRequest": { "type": "object", "required": [ "fieldGroups", "name" ], "properties": { "fieldGroups": { "type": "array", "items": { "$ref": "#/definitions/FieldGroupCreateRequest" } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "name": { "type": "string" } } }, "PolicyPriceResponse": { "type": "object", "required": [ "commissions", "exposurePrices", "fees", "grossCommissions", "grossFees", "grossPremium", "grossTaxes", "holdbacks", "premiumsByExposureLocator", "premiumsByPerilLocator", "taxGroups", "totalDue" ], "properties": { "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "exposurePrices": { "type": "array", "items": { "$ref": "#/definitions/GetExposurePriceResponse" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } }, "grossCommissions": { "type": "number" }, "grossCommissionsCurrency": { "type": "string" }, "grossFees": { "type": "number" }, "grossFeesCurrency": { "type": "string" }, "grossPremium": { "type": "number" }, "grossPremiumCurrency": { "type": "string" }, "grossTaxes": { "type": "number" }, "grossTaxesCurrency": { "type": "string" }, "grossTechnicalPremium": { "type": "number" }, "grossTechnicalPremiumCurrency": { "type": "string" }, "holdbacks": { "type": "array", "items": { "$ref": "#/definitions/HoldbackResponse" } }, "premiumsByExposureLocator": { "type": "object", "additionalProperties": { "type": "number" } }, "premiumsByPerilLocator": { "type": "object", "additionalProperties": { "type": "number" } }, "taxGroups": { "type": "array", "items": { "$ref": "#/definitions/TaxGroupResponse" } }, "totalDue": { "type": "number" }, "totalDueCurrency": { "type": "string" } } }, "EventStreamPremiumReportUpdateData": { "type": "object", "required": [ "policyLocator", "premiumReportLocator" ], "properties": { "policyLocator": { "type": "string" }, "premiumReportLocator": { "type": "string" } } }, "PolicyCharacteristicsPriceRequest": { "type": "object", "required": [ "fieldGroupsByLocator", "policyEndTimestamp", "policyStartTimestamp" ], "properties": { "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "policyEndTimestamp": { "type": "string" }, "policyStartTimestamp": { "type": "string" } } }, "InstallmentFee": { "type": "object", "required": [ "amount", "description", "feeName" ], "properties": { "amount": { "type": "number" }, "description": { "type": "string" }, "feeName": { "type": "string" } } }, "ReinstatementInvoiceRequest": { "type": "object", "required": [ "reinstatementTimestamp" ], "properties": { "reinstatementTimestamp": { "type": "string" } } }, "DateOffsetConfiguration": { "type": "object", "required": [ "amount", "field" ], "properties": { "amount": { "type": "integer" }, "field": { "type": "string", "enum": [ "year", "month", "day", "second" ] }, "roundToDay": { "type": "boolean" } } }, "HoldbackResponse": { "type": "object", "required": [ "amount", "cancellationLocator", "isReversed", "locator", "type" ], "properties": { "amount": { "type": "number" }, "cancellationLocator": { "type": "string" }, "commissionRecipient": { "type": "string" }, "feeLocator": { "type": "string" }, "feeName": { "type": "string" }, "holdbackMetadata": { "type": "string" }, "isReversed": { "type": "boolean" }, "locator": { "type": "string" }, "perilCharacteristicsLocator": { "type": "string" }, "perilName": { "type": "string" }, "taxLocator": { "type": "string" }, "taxName": { "type": "string" }, "type": { "type": "string", "enum": [ "premium", "tax", "fee", "commission", "holdback", "cash" ] } } }, "ExposureModificationResponse": { "type": "object", "required": [ "exposureLocator", "locator", "perilModifications", "policyholderLocator", "policyLocator", "policyModificationLocator", "productLocator" ], "properties": { "exposureLocator": { "type": "string" }, "locator": { "type": "string" }, "newExposureCharacteristicsLocator": { "type": "string" }, "perilModifications": { "type": "array", "items": { "$ref": "#/definitions/PerilModificationResponse" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" }, "productLocator": { "type": "string" } } }, "EventStreamWebhookSuspendedData": { "type": "object", "required": [ "event", "integrationName", "webhookName" ], "properties": { "event": { "type": "string", "enum": [ "cancellation.create", "cancellation.update", "cancellation.rescind", "cancellation.issue", "cancellation.effective", "claim.close", "claim.create", "claim.discard", "claim.open", "claim.update", "policy.gracePeriod", "policy.gracePeriod.update", "invoice.issue", "invoice.invalidate", "invoice.pastDue", "invoice.writtenOff", "payment.pay", "policy.cancel", "policy.create", "policy.discard", "policy.endorse", "policy.finalize", "policy.issue", "policy.lapse", "policy.reinstatement.close", "policy.reinstatement.invoice", "policy.reinstatement.issue", "policy.reinstatement.open", "policy.renew", "policy.update", "policy.upgrade", "subClaim.open", "subClaim.update", "subClaim.close", "subClaim.reopen", "subClaim.updateReserve", "policy.end.reminder", "subClaim.createPayable", "subClaim.reversePayable", "endorsement.create", "endorsement.update", "endorsement.quote", "endorsement.accept", "endorsement.issue", "endorsement.invalidate", "endorsement.discard", "endorsement.effective", "reinstatement.accept", "reinstatement.create", "reinstatement.issue", "reinstatement.invalidate", "reinstatement.deadlineReached", "reinstatement.effective", "renewal.create", "renewal.update", "renewal.quote", "renewal.accept", "renewal.issue", "renewal.invalidate", "renewal.discard", "renewal.effective", "policy.effective", "policy.end", "policy.quote.create", "policy.quote.discard", "policy.quote.update", "policy.quote.quoted", "policy.quote.accept", "policy.quote.declined", "policy.quote.invalidate", "premiumReport.create", "premiumReport.update", "premiumReport.issue", "premiumReport.discard", "premiumReport.reverse", "premiumReport.replace", "premiumReport.effective", "premiumReport.pay", "login.success", "login.failure", "policyholder.create", "policyholder.update", "payment.reverse", "payment.update", "payment.ready", "payment.discard", "payment.return", "payment.decline", "payment.draft", "policy.gracePeriod.satisfied", "disbursement.issue", "disbursement.create", "disbursement.update", "catchUp.issue", "catchUp.writtenOff", "catchUp.pay", "catchUp.pay.reverse", "catchUp.invalidate", "catchUp.pastDue", "cash.transfer" ] }, "integrationName": { "type": "string" }, "webhookName": { "type": "string" } } }, "PolicyValidationErrors": { "type": "object", "required": [ "cancellationValidationErrors", "exposureValidationErrors", "hasErrors" ], "properties": { "cancellationValidationErrors": { "type": "array", "items": { "$ref": "#/definitions/CancellationValidationError" } }, "exposureValidationErrors": { "type": "array", "items": { "$ref": "#/definitions/ExposureValidationErrors" } }, "hasErrors": { "type": "boolean" }, "policyFieldErrors": { "$ref": "#/definitions/FieldErrors" } } }, "PasswordChangeRequest": { "type": "object", "required": [ "oldPassword", "password" ], "properties": { "logout": { "type": "boolean" }, "oldPassword": { "type": "string" }, "password": { "type": "string" } } }, "PolicyResponse": { "type": "object", "required": [ "characteristics", "configVersion", "createdTimestamp", "currency", "displayId", "documents", "effectiveContractEndTimestamp", "exposures", "fees", "grossFees", "invoices", "locator", "modifications", "originalContractEndTimestamp", "originalContractStartTimestamp", "policyholderLocator", "productLocator", "productName", "updatedTimestamp" ], "properties": { "cancellation": { "$ref": "#/definitions/CancellationInfo" }, "cashBalance": { "$ref": "#/definitions/CashBalanceResponse" }, "characteristics": { "type": "array", "items": { "$ref": "#/definitions/PolicyCharacteristicsResponse" } }, "configVersion": { "type": "integer" }, "createdTimestamp": { "type": "string" }, "currency": { "type": "string" }, "displayId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PolicyDocumentResponse" } }, "effectiveContractEndTimestamp": { "type": "string" }, "exposures": { "type": "array", "items": { "$ref": "#/definitions/ExposureResponse" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/FeeResponse" } }, "grossFees": { "type": "number" }, "grossFeesCurrency": { "type": "string" }, "invoices": { "type": "array", "items": { "$ref": "#/definitions/PolicyInvoiceResponse" } }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "modifications": { "type": "array", "items": { "$ref": "#/definitions/PolicyModificationResponse" } }, "originalContractEndTimestamp": { "type": "string" }, "originalContractStartTimestamp": { "type": "string" }, "overrideResourcesAsOfTimestamp": { "type": "string" }, "paymentScheduleName": { "type": "string" }, "policyholderLocator": { "type": "string" }, "premiumReportName": { "type": "string" }, "productLocator": { "type": "string" }, "productName": { "type": "string" }, "quoteLocator": { "type": "string" }, "quoteSummary": { "$ref": "#/definitions/QuoteSummaryResponse" }, "resourcesAsOfTimestamp": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "PolicyholderOverwriteDataRequest": { "type": "object", "required": [ "overwrites" ], "properties": { "overwrites": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExternalDataCallResponse": { "type": "object", "properties": { "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "EventStreamEndorsementUpdateData": { "type": "object", "required": [ "endorsementLocator", "endorsementName", "policyLocator", "policyModificationLocator" ], "properties": { "endorsementLocator": { "type": "string" }, "endorsementName": { "type": "string" }, "policyLocator": { "type": "string" }, "policyModificationLocator": { "type": "string" } } }, "EmailFieldConfiguration": { "type": "object", "required": [ "name", "order", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "search": { "type": "string" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "EventStreamPolicyInvoiceWrittenOffData": { "type": "object", "required": [ "invoiceLocator", "policyLocator" ], "properties": { "invoiceLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamReinstatementInvalidateData": { "type": "object", "required": [ "cancellationLocator", "policyLocator", "reinstatementLocator" ], "properties": { "cancellationLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "reinstatementLocator": { "type": "string" } } }, "EventStreamCatchUpIssueData": { "type": "object", "required": [ "cashBalanceLocator", "catchUpInvoiceLocator" ], "properties": { "cashBalanceLocator": { "type": "string" }, "catchUpInvoiceLocator": { "type": "string" } } }, "FeeChangeResponse": { "type": "object", "required": [ "amountChange", "name", "newAmount" ], "properties": { "amountChange": { "type": "number" }, "locator": { "type": "string" }, "name": { "type": "string" }, "newAmount": { "type": "number" } } }, "EventStreamPolicyLapseData": { "type": "object", "required": [ "lapseLocator", "policyLocator" ], "properties": { "lapseLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "AutofillIntegrationCreateRequest": { "type": "object", "required": [ "callSequence", "operation" ], "properties": { "callSequence": { "type": "array", "items": { "type": "string" } }, "operation": { "type": "string" } } }, "WebhookResponse": { "type": "object", "required": [ "enabled", "events", "failureHandling", "integrationName", "name", "retryStrategy", "suspended" ], "properties": { "alertIntegrationName": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "cancellation.create", "cancellation.update", "cancellation.rescind", "cancellation.issue", "cancellation.effective", "claim.close", "claim.create", "claim.discard", "claim.open", "claim.update", "policy.gracePeriod", "policy.gracePeriod.update", "invoice.issue", "invoice.invalidate", "invoice.pastDue", "invoice.writtenOff", "payment.pay", "policy.cancel", "policy.create", "policy.discard", "policy.endorse", "policy.finalize", "policy.issue", "policy.lapse", "policy.reinstatement.close", "policy.reinstatement.invoice", "policy.reinstatement.issue", "policy.reinstatement.open", "policy.renew", "policy.update", "policy.upgrade", "subClaim.open", "subClaim.update", "subClaim.close", "subClaim.reopen", "subClaim.updateReserve", "policy.end.reminder", "subClaim.createPayable", "subClaim.reversePayable", "endorsement.create", "endorsement.update", "endorsement.quote", "endorsement.accept", "endorsement.issue", "endorsement.invalidate", "endorsement.discard", "endorsement.effective", "reinstatement.accept", "reinstatement.create", "reinstatement.issue", "reinstatement.invalidate", "reinstatement.deadlineReached", "reinstatement.effective", "renewal.create", "renewal.update", "renewal.quote", "renewal.accept", "renewal.issue", "renewal.invalidate", "renewal.discard", "renewal.effective", "policy.effective", "policy.end", "policy.quote.create", "policy.quote.discard", "policy.quote.update", "policy.quote.quoted", "policy.quote.accept", "policy.quote.declined", "policy.quote.invalidate", "premiumReport.create", "premiumReport.update", "premiumReport.issue", "premiumReport.discard", "premiumReport.reverse", "premiumReport.replace", "premiumReport.effective", "premiumReport.pay", "login.success", "login.failure", "policyholder.create", "policyholder.update", "payment.reverse", "payment.update", "payment.ready", "payment.discard", "payment.return", "payment.decline", "payment.draft", "policy.gracePeriod.satisfied", "disbursement.issue", "disbursement.create", "disbursement.update", "catchUp.issue", "catchUp.writtenOff", "catchUp.pay", "catchUp.pay.reverse", "catchUp.invalidate", "catchUp.pastDue", "cash.transfer" ] } }, "failureHandling": { "$ref": "#/definitions/FailureHandlingResponse" }, "integrationName": { "type": "string" }, "name": { "type": "string" }, "retryStrategy": { "type": "string", "enum": [ "none", "one", "three" ] }, "suspended": { "type": "boolean" }, "suspendedTimestamp": { "type": "string" } } }, "ReportStatusResponse": { "type": "object", "required": [ "createdTimestamp", "locator", "status", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "error": { "type": "string" }, "locator": { "type": "string" }, "resultUrl": { "type": "string" }, "status": { "type": "string", "enum": [ "started", "complete", "failed" ] }, "updatedTimestamp": { "type": "string" } } }, "CalculationResponse": { "type": "object", "required": [ "assignedVariables", "commissions", "premium" ], "properties": { "assignedVariables": { "type": "object", "additionalProperties": { "type": "object" } }, "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionResponse" } }, "premium": { "type": "number" }, "technicalPremium": { "type": "number" } } }, "ExposureCharacteristicsResponse": { "type": "object", "required": [ "createdTimestamp", "endTimestamp", "exposureLocator", "fieldGroupsByLocator", "fieldValues", "locator", "mediaByLocator", "policyholderLocator", "policyLocator", "productLocator", "startTimestamp", "updatedTimestamp" ], "properties": { "createdTimestamp": { "type": "string" }, "endTimestamp": { "type": "string" }, "exposureLocator": { "type": "string" }, "fieldGroupsByLocator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "issuedTimestamp": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "productLocator": { "type": "string" }, "replacedTimestamp": { "type": "string" }, "startTimestamp": { "type": "string" }, "updatedTimestamp": { "type": "string" } } }, "StringFieldConfiguration": { "type": "object", "required": [ "name", "order", "title" ], "properties": { "condition": { "type": "object", "additionalProperties": { "type": "string" } }, "heading": { "type": "string" }, "maximum": { "type": "integer" }, "multiline": { "type": "boolean" }, "name": { "type": "string" }, "newline": { "type": "boolean" }, "optional": { "type": "boolean" }, "order": { "type": "integer" }, "regex": { "type": "string" }, "search": { "type": "string" }, "title": { "type": "string" }, "width": { "type": "integer" } } }, "RoleCreateRequest": { "type": "object", "required": [ "displayName", "name", "permissions" ], "properties": { "displayName": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "ClaimFieldErrors": { "type": "object", "properties": { "fieldErrors": { "$ref": "#/definitions/FieldErrors" }, "subClaimErrors": { "$ref": "#/definitions/SubClaimValidationErrors" } } }, "ProrationPluginResponse": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProrationResponseItem" } } } }, "PaymentResponse": { "type": "object", "required": [ "amount", "displayId", "fieldValues", "locator", "mediaByLocator" ], "properties": { "amount": { "type": "number" }, "amountCurrency": { "type": "string" }, "createdTimestamp": { "type": "string" }, "displayId": { "type": "string" }, "fieldValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "invoiceLocator": { "type": "string" }, "locator": { "type": "string" }, "mediaByLocator": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Media" } }, "policyholderLocator": { "type": "string" }, "policyLocator": { "type": "string" }, "postedTimestamp": { "type": "string" }, "reversedTimestamp": { "type": "string" }, "state": { "type": "string", "enum": [ "draft", "ready", "posted", "declined", "returned", "discarded" ] }, "updatedTimestamp": { "type": "string" } } }, "CheckPerilPremiumRequest": { "type": "object", "required": [ "calculation", "exposureCharacteristics", "exposureName", "perilCharacteristics", "perilName", "policyCharacteristics", "productName" ], "properties": { "calculation": { "type": "string" }, "exposureCharacteristics": { "$ref": "#/definitions/ExposureCharacteristicsPriceRequest" }, "exposureName": { "type": "string" }, "perilCharacteristics": { "$ref": "#/definitions/PerilCharacteristicsPriceRequest" }, "perilName": { "type": "string" }, "policyCharacteristics": { "$ref": "#/definitions/PolicyCharacteristicsPriceRequest" }, "productName": { "type": "string" }, "resourcesAfOfTimestamp": { "type": "string" } } }, "EventStreamClaimUpdateData": { "type": "object", "required": [ "claimLocator", "policyLocator" ], "properties": { "claimLocator": { "type": "string" }, "policyLocator": { "type": "string" } } }, "EventStreamPolicyQuoteDiscardData": { "type": "object", "required": [ "policyLocator", "quoteLocator" ], "properties": { "policyLocator": { "type": "string" }, "quoteLocator": { "type": "string" } } } } }