alteration-package

InsuranceAuto InsuranceTelematicsEmbedded InsurancePolicy AdministrationClaimsUsage-Based InsuranceInsurTech

Properties

Name	Type	Description
alteration_package_id	string	Must be a UUID. Unique identifier of the alteration package.
product_module_definition_id	string	Must be a UUID. Unique identifier of the product module definition.
module	object	Custom module-specific fields stored against the alteration package. See [product modules](#product-modules) for more details.
created_at	string	The date/time at which the alteration package was created.
created_by	objectnull	`null` is allowed. An object indicating the user or API key that created the alteration package. See [Authentication](#client-apps).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "alteration-package",
  "type": "object",
  "required": [
    "alteration_package_id",
    "product_module_definition_id",
    "module",
    "created_at",
    "created_by"
  ],
  "properties": {
    "alteration_package_id": {
      "type": "string",
      "description": "Must be a UUID. Unique identifier of the alteration package."
    },
    "product_module_definition_id": {
      "type": "string",
      "description": "Must be a UUID. Unique identifier of the product module definition."
    },
    "module": {
      "type": "object",
      "description": "Custom module-specific fields stored against the alteration package. See [product modules](#product-modules) for more details.",
      "additionalProperties": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date/time at which the alteration package was created."
    },
    "created_by": {
      "type": [
        "object",
        "null"
      ],
      "description": "`null` is allowed. An object indicating the user or API key that created the alteration package. See [Authentication](#client-apps)."
    }
  },
  "example": {
    "alteration_package_id": "f4397823-db4a-4d6a-a06b-08e1a2a3172c",
    "product_module_id": "5d8c8c63-e2f1-43e0-94f1-c467545f182d",
    "created_at": "2017-10-12T15:47:34.281Z",
    "created_by": {
      "id": "00000000-0000-0000-0000-000000000001",
      "type": "user"
    },
    "module": {
      "type": "root_gadgets",
      "make": "Apple",
      "model": "iPhone 6S 64GB LTE"
    },
    "monthly_premium": 11200,
    "currency": "ZAR",
    "sum_assured": 329900,
    "billing_frequency": "monthly",
    "status": "pending",
    "change_description": "Updating device",
    "product_module_definition_id": "9b7b43f4-9ab8-4e37-b42b-59d5595f3983",
    "input_data": {},
    "policy_id": "128ba0c0-3f6a-4f8b-9b40-e2066b02b59e",
    "product_module_definition_alteration_hook_id": "2cbbc377-e142-4986-8871-29b0a4c23353"
  }
}