dashboards

Get Agency Experience Data returns the agency experience summary data (used to fill the tables).

Code
Parameters
----------
contact_id : str
  The id of the contact making the request.
to_date : str
   The date of the end data e.x {"year":"2017","month":"3"}

Returns
-------
success : bool
   True if completely successful, false if not
messages : list of str
   List of human-readable error messages
data : dict
   Dict containing two array of dicts, this is YTD data.
   {
      "line_of_business":{
            "Dwelling Property": {
                "ytd_claims": 0.0,
                "losses_incurred": 0.0,
                "loss_ratio": 0.0,
                "total_written_premium": 12597.14,
                "canceled_written_premium": -523.86,
                "total_lae_paid": 0.0,
                "total_lae_incurred": 0.0,
                "renewal_written_premium": 3039.0,
                "endorsed_written_premium": 0.0,
                "inforce_policy_count": 52.0,
                "new_written_premium": 10082.0,
                "ending_loss_reserve": 0.0,
                "earned_premium": 10492.720000000001,
                "new_policy_count": 11.0,
                "net_cancel_policy_count": 3.0,
                "beginning_loss_reserve": 0.0,
                "losses_paid": 0.0
              },
              ...
              for all line items.
      },
      "totals":{
          "ytd_claims": 0.0,
          "losses_incurred": 0.0,
          "loss_ratio": 0.0,
          "total_written_premium": 13104.939999999999,
          "canceled_written_premium": -523.86,
          "total_lae_paid": 0.0,
          "total_lae_incurred": 0.0,
          "renewal_written_premium": 3039.0,
          "endorsed_written_premium": 0.0,
          "inforce_policy_count": 53.0,
          "new_written_premium": 10589.8,
          "ending_loss_reserve": 0.0,
          "earned_premium": 10591.41,
          "new_policy_count": 12.0,
          "net_cancel_policy_count": 3.0,
          "beginning_loss_reserve": 0.0,
          "losses_paid": 0.0
      }
   }

Get csr data returns csr data for given agent/agency/agency group.

Parameters

contact_id : str, required The id of the contact making the request.

Returns

success : bool True if completely successful, false if not messages : list of str List of human-readable error messages data : list of dicts List of dicts containing the csr data [ { "cancellation_pending": [ { "policyStatus": "Active", "policyNumber": "10-2015-36", "expirationDate": "2017-05-14", "policyId": "64f10a14-0ddf-46d2-a6e8-71868deac348", "revisionDate": "2016-05-14" }, ... ], "will_expire_in_30_days": [ { "policyStatus": "Active", "policyNumber": "10-2015-36", "expirationDate": "2017-05-14", "policyId": "64f10a14-0ddf-46d2-a6e8-71868deac348", "revisionDate": "2016-05-14" }, ... ], "will_expire_in_60_days": [ { "policyStatus": "Active", "policyNumber": "10-2015-36", "expirationDate": "2017-05-14", "policyId": "64f10a14-0ddf-46d2-a6e8-71868deac348", "revisionDate": "2016-05-14" }, ... ], "cancel_non_pay_30_days": [ { "policyStatus": "Cancelled", "policyNumber": "10-2015-36", "expirationDate": "2017-05-14", "policyId": "64f10a14-0ddf-46d2-a6e8-71868deac348", "revisionDate": "2016-05-14" }, ... ], "expired_within_45_days": [ { "policyStatus": "Cancelled", "policyNumber": "10-2015-36", "expirationDate": "2017-05-14", "policyId": "64f10a14-0ddf-46d2-a6e8-71868deac348", "revisionDate": "2016-05-14" }, ... ] } ]

Get Loss Ratio Chart return monthly loss ratio for given year and one year prior.

Code
Parameters
----------
contact_id : str
   The id of the contact making the request.
to_date : str
    The date of the end data e.x {"year":"2017","month":"3"}

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    Dict containing two array objects
    {
        "pv_year": [m0,m1,m2,m3,m4,m5,m6,m7,m8,m9,m10,m11],
        "now": [m0... util to_date["month"]]
    }
    where m0 is January value and so on..

Get Policy Count Data returns the policy count (inforce_policy_count) for given year and one year prior.

Code
Parameters
----------
contact_id : str
  The id of the contact making the request.
to_date : str
   The date of the end data e.x {"year":"2017","month":"3"}

Returns
-------
success : bool
   True if completely successful, false if not
messages : list of str
   List of human-readable error messages
data : dict
    Dict containing two array of dicts
   {
       "pv_year": [
           "Dwelling Property":[m0,m1,m2,m3,m4,m5,m6,m7,m8,m9,m10,m11],
            ... fol all line items
           "Total":[m0,m1,m2,m3,m4,m5,m6,m7,m8,m9,m10,m11]
       ],
       "now": [
            "Dwelling Property":[m0... until to_date["month"]],
            ... fol all line items
           "Total":[m0... until to_date["month"]]
       ]
   }

Get Premium data returns the Written Premium VS Losses Paid for given year and one year prior.

Code
Parameters
----------
contact_id : str
  The id of the contact making the request.
to_date : str
   The date of the end data e.x {"year":"2017","month":"3"}

Returns
-------
success : bool
   True if completely successful, false if not
messages : list of str
   List of human-readable error messages
data : dict
   Dict containing two array of dicts
   {
       "pv_year": [
            {
                "cl":"0" - losses paid for given month,
                "wp": "0" - written premium for given month,
                "reportingMonth":"1"
            },
            ... until december (reportingMonth = 12)
       ],
       "now": [
            {
                "cl":"0" - losses paid for given month,
                "wp": "0" - written premium for given month,
                "reportingMonth":"1"
            },
            ... until to_date["month"] (reportingMonth = to_date["month"])]
   }

Returns the Transaction Report for a specified date range

Code
Parameters
----------
from_date : str
  ``MM-DD-YYYY``
to_date : str
  ``MM-DD-YYYY``
contact_id : str
  The id of the contact making the request.
payment_types : str
  ``{field:bool, field:bool}`` e.x {"Sweep":true,"Other":true}

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : dict
    Representation of dict result:
    ::
        {
            'data':{
              'url': String: URL for transaction report
            },
            'success': True,
            'messages': []
        }

Returns the Transaction Report for a specified date range

Code
Parameters
----------
from_date : str
  ``MM-DD-YYYY``
to_date : str
  ``MM-DD-YYYY``
page : int
  ``1``
records_per_page: int
  ``1``
sort_obj : str
  ``{field:"column", order:"asc"}``
contact_id : str
  The id of the contact making the request.
payment_types : str
  ``{field:bool, field:bool}`` e.x {"Sweep":true,"Other":true}

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : dict
    Representation of dict result:
    ::
        {
            'data':{
            },
            'success': True,
            'messages': []
        }

Validates that the given agent's contact id has access to the provided policy.

Code
Parameters
----------
contact_id : str
    The id of the contact making the request.
policy_number : str
    Any valid policy number

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : dict
    Representation of dict result:
    ::
        {
            'data':{
            },
            'success': True,
            'messages': []
        }