API Info

 

HTTP Method: POST

Request format:

[{
 "id": "201702028950",
 "policy_number": "CA20170228-05",
 "policy_effective_date": "2017-02-01",
 "transaction_effective_date": "2017-02-01",
 "transaction_type": "PN",
 "account_written_as": "B",
 "rpg": 0,
 "premium": 3900.00,
 "agency_fee": 200.00,
 "inspection_fee": 0.00,
 "sl_tax": 117.00,
 "stamping_fee": 7.80,
 "sl_service_charge": 0.00,
 "municipal_fee": 0.00,
 "fm_tax": 0.00,
 "total": 4224.80,
 "commission_received": 0,
 "non_admitted_insured_name": "1001",
 "invoice_date": "2017-02-01",
 "purchasing_group_name": "Cal Association",
 "ecp": 0,
 "risk_description": "This is a risk description",
 "mailing_insured_name": "Westfield Galleria at Roseville",
 "mailing_address": "1151 Galleria Blvd",
 "mailing_city": "Roseville",
 "mailing_zip_code": "95678",
 "mailing_state_code": "CA",
 "physical_same_as_mailing": 1,
 "transaction_line_of_business": "1001",
 "exempt": 0,
 "export_list": 0,
 "multi_state": 0,
 "transaction_documents": [{
   "code": "D1DISC",
   "url": ",
   "id": 1000001
 },{
   "code": "POLIC",
   "url": ",
   "id": 1000002
 }]
}]
 

Multiple documents with the same code are allowed. For example:


"transaction_documents": [{
  "code": "SSW",
  "url": ",
  "id": 12233
},{
  "code": "SSW",
  "url": ",
  "id": 455667
},{
  "code": "DILEF",
  "url": ",
  "id": 455666
}]
 

Field Values

Field

Description

Field type

id

Unique ID used for tracking imported transactions

varchar (255)

policy_number

Policy number. Non-unique field.

varchar (50)

policy_effective_date

Policy effective date

date (yyyy-mm-dd)

transaction_effective_date

Transaction effective date

date (yyyy-mm-dd)

transaction_type

Transaction types are listed below

 

account_written_as

Account Written values are listed below

 

rpg

RPG: yes or no

No = 0

Yes = 1

decimal(12,2)

premium

Policy premium

decimal(12,2)

agency_fee

Policy / Broker / Agency Fee

decimal(12,2)

inspection_fee

Inspection / Audit / Underwriting Fee

decimal(12,2)

sl_tax

Surplus Lines Tax,

or Florida Tax in FL,

or State Tax in Oregon

decimal(12,2)

stamping_fee

Stamping fee,

or FSLO fee in Florida

or Fire Marshal Tax in Oregon

decimal(12,2)

sl_service_charge

Currently active only in state of Oregon

decimal(12,2)

municipal_fee

Currently active only in state of Kentucky

decimal(12,2)

fm_tax

Fire Marshal Tax based on Line of Business.

Active in state of Illinois and is based off premium amount

decimal(12,2)

total

total amount = premium + all taxes + all policy fees

decimal(12,2)

commission_received

Is commission received?

Required in state of New Hampshire

If commission is received, policy fee cannot be charged (Tax rule #33 (NH, RPG))

Yes = 1

No = 0

tinyint(1)

non_admitted_insured_name

Insurance Company Name or NAICS code

varchar(255)

invoice_date

Date of Invoice

date (yyyy-mm-dd)

purchasing_group_name

Required if RPG == 1

varchar(255)

ecp

Exempt Commercial Purchaser
Yes = 1
No = 0

tinyint(1)

risk_description

Risk description
Required if RPG == 1

varchar(255)

mailing_insured_name

Insured name as it appears in policy documents

varchar(100)

mailing_address

Mailing address

varchar(255)

mailing_address2

Mailing address line 2

varchar(255)

mailing_city

Mailing city

varchar(100)

mailing_zip_code

Mailing zip code

varchar(20)

mailing_state_code

Mailing state. 2 letter state code

 

physical_same_as_mailing

physical is same as mailing == 1
physical is NOT same as mailing == 0

tinyint(1)

physical_address

Physical address

varchar(255)

physical_address2

Physical address line 2

varchar(255)

physical_city

Physical city

varchar(100)

physical_zip_code

Physical zip code

varchar(20)

physical_state_code

Physical state. 2 letter state code

 

transaction_line_of_business

Line of business code
See lines of business below

 

exempt

Exempt yes = 1
Exempt no = 0
Optional Value. Currently Required only for state of Utah.

tinyint(1)

export_list

Export list yes = 1
Export list no = 0
Optional Value. Currently Required only for state of Utah.

tinyint(1)

multi_state

Multi state yes = 1
Multi state no = 0
Optional value. Currently required in Utah only

 
transaction_documents Required to upload transaction documents  

 └  code

Document code is retrieved from tax rules API

 

 └  url

Full document URL that can be access by our system and downloaded.

 

 └  id

Unique document ID number. For import tracking purposes only. Optional.

 

 

Response format

Return a list of all policy numbers together with import status.

 

Success response:

{
 "batch_id": "79b9aa668b9468d1197c57d10a41f0f4",
 "transactions": [
  {
   "id": "0000001",
   "policy_number": "PL 899292",
   "status": 0,
   "status_message":"Success"
  },
  {
   "id": "0000002",
   "policy_number": "PL 7272727",
   "status": 0,
   "status_message":"Success"
  }
 ]
}
 

Error response:

{
    "batch_id":"f6272344cc2b5dccdaf24c9120ab77de",
    "transactions":[
        {
            "id":"00001",
            "policy_number":"ABC 0099",
            "status":1001,
            "status_message":"Error: missing required document with code 'POLIC'."
        }
    ]
}
 

Response Status codes

Code Name
0 Ok, success
1001 Error: missing required documents
1002 Error: transaction type not found
1003 Error: transaction line of business is missing or invalid     
1004 Error: department not found
1005 Error: unable to assign tax rule
3001 Error: duplicate transaction is submitted

 

Available transaction types

Code Name
PN Policy New
PR Policy Renewal
APE Additional Premium Endorsement
RPE Return Premium Endorsement
AE Audit Endorsement
FC Flat Cancellation

 

Available account written as values

Code Name
B Brokerage
DC Direct Client

 

Lines of Business

1001

Accident & Health

1002

BOP Liability

1003

Business Auto

1004

Business Owners

1005

Commercial Property

1006

Data Breach

1007

Employment Practice Liability Insurance

1008

Errors & Omissions

1009

Garage & Dealers

1010

General Liability

1011

Inland Marine (C)

1012

Med/Professional Liab

1013

Package (C)

1014

Professional Liability1

1015

Umbrella(C)

1016

Directors and Officers

1017

Foreign Liability

1018

Pollution

1019

Workers Compensation

1020

Monoline

1021

Earthquake Liability

1022

Special Events