Socotra

Getting Started

  • Configuration Walkthrough
    • The Socotra Configuration
    • Socotra Configuration File/Folder Structure
    • Product Lines
    • Policy
    • Exposures
    • Perils
    • Documents
    • Taxes and Fees
  • Getting Started Guide
    • Terminology
    • Introduction
      • Step 1.1: Set Up
      • Step 1.2: Log into your test tenant
    • Product Configuration
      • Step 2.1: Vehicle Color
    • Pricing
      • Step 3.1: Rates Update
      • Testing your rating change
      • Step 3.2: Discount Increase
      • Testing your discount adjustment
    • Documents
      • Step 4.1: Policy Schedule Update
    • Reports
      • Step 5.1: On Risk Report
  • Getting Started Guide - Reference
    • Step 3.2: Discount Increase
    • Step 4.1: Policy Schedule Update

Policy Management

  • Quotes
    • Quote Lifecycle
    • Quote Updates
    • Quote Creation
    • Selecting Quotes
    • Pricing Quotes
    • Accepting Quotes
    • Invalidating Quotes
    • Issuing Policies
    • Discarding Quotes
    • Document Rendering
  • Automated Underwriting
    • Configuration
      • Input: Data Object
      • Return Object
      • Example
    • Workflow
      • Automated Underwriting Results in the UI
      • Automated Underwriting Results in the API
    • Using the API to test automated underwriting logic
    • Configuration (Legacy)
      • Example
  • Policy Change Management
    • Lifecycle
    • Pricing and Invalidation
    • Documents
  • Endorsements
    • Repricing
    • Endorsement Types
    • Extensions and Reductions
    • Configuration
      • Example endorsements.json
    • Endorsement Documents
  • Renewals
    • Renewal Documents
    • Peril Handling on Renewal
    • Configuration
    • Notes
    • Policy Calculations
    • Data Object
  • Premium Reporting
    • Overview
    • Lifecycle
    • Report Timing
    • Invoicing
    • Correcting Premium Reports
      • Reversals
      • Replacements
    • Configuration
      • Financial Calculations
      • Data Objects
      • Invoicing
  • Cancellations and Reinstatements
    • Overview
    • Cancellation Types
    • Cancellation Creation
    • Cancellation Issuance
    • Multiple Cancellations
    • Reinstatement
    • Reinstatement Deadlines
    • Conflict Handling
      • Cancellation Conflicts
      • Reinstatement Conflicts
    • Reinstatement Invalidation
    • Reinstatement with a Gap
    • Documents
    • Configuration
    • Api Support
  • Grace Periods and Policy Lapse
    • Documents
  • Policy Snapshots and Coverage Summaries
    • Overview
    • API
      • Snapshots
      • Coverage Summary
  • Reminders
    • Behavior
    • Configuration
    • Example policy.json Section
  • Claims
    • Configuration
    • Claims API
    • Claims in the UI

Premiums and Financials

  • Rating Plugin
    • Enabling the Plugin
    • Data Object
    • Return Object
    • Validation
    • Sample Implementation
  • Fees
    • Proration
    • Standard Fees
      • Data for Standard Fee Calculation
      • Example fees.json File
      • Example policy.calculations.liquid File
    • Ad Hoc Fees
    • Installment Fees
  • Taxes
    • Tax Configuration
    • Tax Calculation
  • Commissions
    • Endorsements
    • Configuration
      • Example [peril_name].premium.liquid
  • Invoicing and Payment Schedules
    • Overview
    • Manual Schedule Changes
    • Payment Schedule Changes with Endorsements and Renewals
    • Payments
    • Configuration
      • Policy Configuration
      • Payment Configuration
      • Invoice Templates
      • Invoice Rendering
    • Legacy Invoice Scheduling
      • Billing Periods
      • Invoices
      • Backdated Policy Invoicing
  • Payment Schedule Plugin
    • Overview
      • Enabling the plugin
      • Script
    • Charges
    • Write offs
    • The Plugin data Object
    • Validation
    • Simple Example
  • Proration and Premium Allocation
    • Plugin Details
      • Enabling the plugin
      • The plugin script
      • The data object
      • The Plugin Response Object
    • Validation
    • Sample Script (Simple)
    • Sample Script (Advanced)
    • Legacy Proration
      • Month Counting
  • Technical Premium
    • Documents
    • API
    • Configuration
    • Legacy Calculation
  • Financial Transactions
    • Data
    • Reporting
  • Premium Calculations (Legacy)
    • Usage
      • Example
    • Data available in premium calculations
      • Structure of the “data” object
      • data.policy_characteristics
      • data.exposure_characteristics
      • data.peril_characteristics

Documents

  • Documents
    • Overview
    • Document Types
    • Rendering Targets
    • Templates
    • Triggering events
    • Document Attachment
    • Configuration
  • Document Templates
    • Data Available in Templates
    • Details of the data Object
      • data.policy
      • data.policyholder
    • data.policy Child Objects
      • data.policy.characteristics
      • data.policy.exposures
      • data.policy.modifications
      • data.policy.invoices
      • data.policy.fees
      • data.policy.commissions
      • data.policy.commissions.peril_commissions
    • Headers and footers
      • Usage
  • Liquid Filters
    • Liquid Filters for Document Templates
      • format_number_currency
      • format_number
      • format_number_pattern
      • timestamp_millis_add
      • timestamp_millis_round_day_floor
      • timestamp_millis_round_day_ceiling
      • lookup
      • timestamp_millis_print
    • Liquid Filters for Premium Calculations
      • set_month_premium
      • set_year_premium
      • set_month_technical_premium
      • set_year_technical_premium
      • add_month_commission
      • add_year_commission
      • pow
    • Multi-Use Filters
    • Liquid Tips
      • Floating Point Assignments
      • Lookup Table Syntax
      • Debugging Liquid Template Rendering Errors
  • Static PDF Documents
    • Capabilities of the feature
    • Usage
    • Example 1: Basic Static Documents
    • Example 2: Conditional Dynamic Documents

Data

  • Object Model
    • The Policy
    • Exposures
    • Perils
    • Claims and SubClaims
    • Documents
    • Invoices and Payments
  • Data Fields
    • Attributes available on all data types
    • Optionality
    • Data Types
      • Date
      • Email
      • Media
      • Number
      • String
      • Select
      • Group
      • Lookup
    • Conditions
  • Field Groups
    • API Access
      • Example Policy Characteristics
      • Policy Creation
    • Liquid Access
      • Endorsements
  • Characteristics
    • Overview
    • Characteristics’ Data
  • Modifications
    • Data Types
    • Policy Modification Names
  • Auxiliary Data
    • Overview
    • Use Cases
    • Structure
    • Data Types
    • UI Hints
    • API
    • Plugin Access
    • Document Templates
    • User Interface
    • Null Handling
    • Limitations
  • Event Stream
    • Overview
    • Structure
    • Attribution
    • Data Types
    • Event Details
      • Policy Termination and Expiration
  • Reporting
    • Financial Transactions Report
    • Paid Financial Transactions Report
    • On-Risk Report
    • All Issued Policies Report
    • Payable Commissions Report
    • Claims Report
    • Claim Reserves Report
    • Claims Payables Report
    • Unearned Premium Report

Tooling

  • Deploying and Testing Configuration
    • Deploying a Configuration
    • Reusing an Instance
    • Example Implementation
  • Plugins
    • Script Format
    • Script Data
    • Fetching Socotra Entities
    • Table Lookups
    • Script Deployment
    • Script Enablement
    • Logging
  • Product Versioning
    • Overview
    • Versioned Elements
    • Creating Policies with a Specific Version
    • Product Versioning “Repair”
    • Premium Reporting
  • External Rater
    • Implementation
    • Requests Sent to the External Rater
    • Response Expected from the External Rater
    • Socotra Administration UI
    • Socotra Configuration
    • Error Handling
  • External Data Calls
    • Common use cases
    • Overview
    • Configuration
    • Data structure sent to web service
    • Data structure expected from web service
    • Example
      • Web Service Wrapper
      • Complete exposure.json File
  • Socotra User Interface
    • Login
    • Limitations on Legacy Cancellations
    • Notes
    • Legacy User Interface

API Reference

  • Getting Started with the Socotra API
    • What You Need
    • URLs
      • Base URL
      • Sandbox URL
    • Authentication and Authorization
      • Authentication
      • Authorization
    • Typical Fields
      • Field Value Maps
    • Errors and Exceptions
    • Example: Creating a Policy
      • Get an Authorization Token
      • Create a Policyholder
      • Create an Exposure
      • Create a Policy
      • Print Policy Information
  • Account API
    • Endpoint Index
    • Authentication
    • Account Lockout Reset
    • Password Change
    • Account Management
  • Auxiliary Data
    • Endpoint Index
    • Details
  • Calculation API
    • Endpoint Index
    • Details
  • Cancellations API
    • Endpoint Index
    • Grace Periods
    • Cancellation
    • Legacy Lapsing and Reinstatement
  • Claims API
    • Endpoint Index
    • Details
  • Configuration API
    • Endpoint Index
    • Configuration Deployment to Test Tenants
    • Legacy Deployment Endpoints
  • Deployments API
    • Endpoint Index
    • Product Version Deployment History
    • Retrieving Configurations
  • Document API
  • Endorsements API
    • Endpoint Index
    • Details
    • Legacy Endorsements
  • Event Stream API
    • Endpoint Index
    • Details
    • Login
    • Policyholders
    • Policies
    • Quotes
    • Endorsements
    • Renewals
    • Cancellations
    • Reinstatements
    • Claims
    • SubClaims
    • Invoicing and Payments
    • Premium Reports
  • Integrations API
    • Endpoint Index
    • Details
  • Invoice API
    • Endpoint Index
    • Details
  • Media API
    • Endpoint Index
    • Details
  • Payments API
    • Endpoint Index
    • Details
  • Policyholder API
    • Endpoint Index
    • Policyholder Creation and Update
    • Policyholder Fetch
    • Associated Data
    • Overwriting Policyholder Data
  • Policy API
    • Endpoint Index
    • Basic Operations
    • Exposures
    • Perils
    • Characteristics
    • Modifications
    • Field Groups
    • Documents
    • Underwriting
    • Fees
    • Pricing
    • Invoicing and Financial Transactions
    • Snapshots and Coverage Summaries
    • Legacy Endpoints
  • Premium Reporting API
    • Endpoint Index
    • Details
    • Reversals
    • Replacements
  • Products API
    • Endpoint Index
    • Details
      • ReminderOffset
  • Quotes API
    • Endpoint Index
    • Details
  • Reinstatements API
    • Endpoint Index
    • Details
  • Renewals API
    • Endpoint Index
    • Details
    • Legacy Renewals
  • Reporting API
    • Endpoint Index
    • Details
  • Scripts API
    • Endpoint Index
    • Details
  • Tenant Assets API
  • Errors and Exceptions API
    • Error Responses
    • API Error Codes
      • Conflicts
      • Bad Requests
      • Forbidden
      • Precondition Failed
Socotra
  • »
  • Search


© Copyright 2021, Socotra.

Built with Sphinx using a theme provided by Read the Docs.