Update a quote

PATCH 
/v1/quotes

Update a previously created quote.

Request

application/json

Body

Details of the quotation to be updated.

ref stringrequired

the ref of the quotation to be updated.

customer_ref string

the ref of the new customer to update the quotation to, this should have been supplied when creating the customer

asset_ref string

The new asset_ref to.

company_name string

The updated company name.

description string

An updated description for this quote

child_partner_id string

The child partner key to update the quote for the child partner

Responses

200

OK

application/json

Schema

Schema

data object
Product quotation
id integer
The unique ID of the quote.
ref string
unique reference of the quote.
status string
the current status of the quote.
amount_due float
the amount due for payment by partner, excluding the partner's commission
policy_start_date date
A provisional date when the policy coverage is due to start
product_price float
The cost of purchasing the product by policy holder, including the partner's commission.
asset_ref string
An optional identifier for the asset the insurance covers. You may set this to a value that uniquley identifies the asset on your database.
currency string
The currency of all monetary parameters.
created_at date
company_name string
The name of your company
product object
An individual insurance product or plan
title string
The name of the product
code string
The unique identifier for technical purposes
id integer
Unique Id of the product.
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
name string
The generally accepted human friendly name
slug string
The unique identifier for technical purposes
cover-benefits object
list of the nefits covered.
created-at string
Date of product creation
price integer
Price of product
premium-type string
Define the product premium tier.
premium-rate-unit integer
premium-rate number
premium number
partner-commision-rate number
min-premium string
premium-rules string
premium_frequency string
Possible values: [monthly, quarterly, annually]
Default value: annually
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired

Example (from schema)

{
  "data": {
    "id": 2,
    "ref": "q-partner-one-1",
    "status": "paid",
    "amount_due": 1470,
    "policy_start_date": "2022-04-06T00:00:00.000000Z",
    "product_price": 1500,
    "asset_ref": "T2354354",
    "currency": "GHS",
    "created_at": "2022-04-06T10:34:20.000000Z",
    "company_name": "Curacel Inc.",
    "product": {
      "title": "Comprehensive Car Plan XYZ",
      "code": "auto-com-xyz",
      "id": 1,
      "insurer": {
        "code": "AXA",
        "name": "Axa Mansard",
        "logo_url": null,
        "terms_conditions": null
      },
      "product type": {
        "name": "Goods in Transit",
        "slug": "GIT"
      },
      "cover-benefits": {},
      "created-at": "string",
      "price": 0,
      "premium-type": "string",
      "premium-rate-unit": 0,
      "premium-rate": 0,
      "premium": 0,
      "partner-commision-rate": 0,
      "min-premium": "string",
      "premium-rules": "string",
      "premium_frequency": "annually"
    },
    "customer": {
      "ref": "string",
      "email": "string",
      "phone": "408-867-5309",
      "first_name": "Jane",
      "last_name": "Doe"
    }
  }
}

422

Unprocessable Content

application/json

Schema

Schema

message string
errors object
ref string[]
customer_ref string[]

Example (from schema)

{
  "message": "The given data was invalid",
  "errors": {
    "ref": [
      "The ref field is required"
    ],
    "customer_ref": [
      "The selected customer ref is invalid"
    ]
  }
}

Loading...