POST v1/Quotes?suppressDocGen={suppressDocGen}&customerClearance={customerClearance}

Create Quote

Request Information

URI Parameters

Name	Description	Type	Additional information
suppressDocGen	suppress document generation flag	boolean	Default value is False
customerClearance		boolean	Default value is False

Body Parameters

quote and product data

QuoteProductInboundDTO

Name	Description	Type	Additional information
Quote		QuoteInboundDTO	Required
Product		Object	Required
Expand	Comma separated list of expansions to include in results	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Quote": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "DivisionOrganizationId": 1,
    "BillPlanId": 1,
    "RenewalBillPlanId": 1,
    "CustomerId": 1,
    "Customer": {
      "FirstName": "sample string 1",
      "Id": 2,
      "LastName": "sample string 3",
      "CommercialName": "sample string 4",
      "Type": "Unknown",
      "LegalStatus": "Unknown",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MobilePhone": "sample string 5",
      "HomePhone": "sample string 6",
      "WorkPhone": "sample string 7",
      "SecondaryMobilePhone": "sample string 8",
      "FaxNumber": "sample string 9",
      "Email": "sample string 10",
      "BirthDate": "2024-12-21T08:33:09.4673407-10:00",
      "CitizenCountryId": 1,
      "BirthCountryId": 1,
      "Fein": "sample string 11",
      "YearStarted": 1,
      "EstablishCountryId": 1,
      "ExternalCustomerNumber": "sample string 12",
      "Attributes": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Expand": ""
    },
    "EffectiveDate": "2024-12-21T08:33:09.7284836-10:00",
    "ExpirationDate": "2024-12-21T08:33:09.7284836-10:00",
    "QuoteTerm": "Unknown",
    "LineOfBusiness": "sample string 1",
    "PrimaryNamedInsured": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "CommercialName": "sample string 3",
      "EmailAddress": "sample string 4",
      "HomePhone": "sample string 5",
      "MobilePhone": "sample string 6",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "RiskAddressIsMailingAddress": true,
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "Type": "Unknown",
      "Id": 7
    },
    "RateGuaranteeDate": "2024-12-21T08:33:09.7284836-10:00",
    "RatingTaxa": "sample string 2",
    "State": "sample string 3",
    "Country": "sample string 4",
    "UnderwritingCompanyId": 5,
    "UniversalAccountId": 6,
    "QuoteNumber": "sample string 7",
    "AgencyCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "SubagencyCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "AgentCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "AdditionalPayees": [
      {
        "Type": "Unknown",
        "CommissionOverride": {
          "Type": "Unknown",
          "Rate": 1.0,
          "OverrideType": "Unknown",
          "OverrideRate": 1.0,
          "CommissionOverride": true,
          "Id": 2
        },
        "Id": 1
      },
      {
        "Type": "Unknown",
        "CommissionOverride": {
          "Type": "Unknown",
          "Rate": 1.0,
          "OverrideType": "Unknown",
          "OverrideRate": 1.0,
          "CommissionOverride": true,
          "Id": 2
        },
        "Id": 1
      }
    ],
    "CustomQuoteNumber": "sample string 8",
    "QuoteName": "sample string 9",
    "UnderwriterId": 1,
    "Id": 10,
    "Expand": ""
  },
  "Product": {},
  "Expand": ""
}

application/xml, text/xml

Sample:

<QuoteProductInboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>2</Id>
  <Product />
  <Quote>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>10</Id>
    <AdditionalPayees xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:AdditionalPayeeDTO>
        <d3p1:Expand></d3p1:Expand>
        <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:CommissionOverride>
          <d3p1:Expand></d3p1:Expand>
          <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
          <d3p1:Id>2</d3p1:Id>
          <d3p1:CommissionOverride>true</d3p1:CommissionOverride>
          <d3p1:OverrideRate>1</d3p1:OverrideRate>
          <d3p1:OverrideType>Unknown</d3p1:OverrideType>
          <d3p1:Rate>1</d3p1:Rate>
          <d3p1:Type>Unknown</d3p1:Type>
        </d3p1:CommissionOverride>
        <d3p1:Type>Unknown</d3p1:Type>
      </d3p1:AdditionalPayeeDTO>
      <d3p1:AdditionalPayeeDTO>
        <d3p1:Expand></d3p1:Expand>
        <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:CommissionOverride>
          <d3p1:Expand></d3p1:Expand>
          <d3p1:Expansions xmlns:d6p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
          <d3p1:Id>2</d3p1:Id>
          <d3p1:CommissionOverride>true</d3p1:CommissionOverride>
          <d3p1:OverrideRate>1</d3p1:OverrideRate>
          <d3p1:OverrideType>Unknown</d3p1:OverrideType>
          <d3p1:Rate>1</d3p1:Rate>
          <d3p1:Type>Unknown</d3p1:Type>
        </d3p1:CommissionOverride>
        <d3p1:Type>Unknown</d3p1:Type>
      </d3p1:AdditionalPayeeDTO>
    </AdditionalPayees>
    <AgencyCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>2</d3p1:Id>
      <d3p1:CommissionOverride>true</d3p1:CommissionOverride>
      <d3p1:OverrideRate>1</d3p1:OverrideRate>
      <d3p1:OverrideType>Unknown</d3p1:OverrideType>
      <d3p1:Rate>1</d3p1:Rate>
      <d3p1:Type>Unknown</d3p1:Type>
    </AgencyCommissionOverride>
    <AgencyId>1</AgencyId>
    <AgentCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>2</d3p1:Id>
      <d3p1:CommissionOverride>true</d3p1:CommissionOverride>
      <d3p1:OverrideRate>1</d3p1:OverrideRate>
      <d3p1:OverrideType>Unknown</d3p1:OverrideType>
      <d3p1:Rate>1</d3p1:Rate>
      <d3p1:Type>Unknown</d3p1:Type>
    </AgentCommissionOverride>
    <AgentId>1</AgentId>
    <BillPlanId>1</BillPlanId>
    <Country>sample string 4</Country>
    <CustomQuoteNumber>sample string 8</CustomQuoteNumber>
    <Customer>
      <Expand></Expand>
      <Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <Id>2</Id>
      <Attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Attributes>
      <BirthCountryId>1</BirthCountryId>
      <BirthDate>2024-12-21T08:33:09.4673407-10:00</BirthDate>
      <CitizenCountryId>1</CitizenCountryId>
      <CommercialName>sample string 4</CommercialName>
      <Email>sample string 10</Email>
      <EstablishCountryId>1</EstablishCountryId>
      <ExternalCustomerNumber>sample string 12</ExternalCustomerNumber>
      <FaxNumber>sample string 9</FaxNumber>
      <Fein>sample string 11</Fein>
      <FirstName>sample string 1</FirstName>
      <HomePhone>sample string 6</HomePhone>
      <LastName>sample string 3</LastName>
      <LegalStatus>Unknown</LegalStatus>
      <MailingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </MailingAddress>
      <MobilePhone>sample string 5</MobilePhone>
      <RiskAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </RiskAddress>
      <SecondaryMobilePhone>sample string 8</SecondaryMobilePhone>
      <Type>Unknown</Type>
      <WorkPhone>sample string 7</WorkPhone>
      <YearStarted>1</YearStarted>
    </Customer>
    <CustomerId>1</CustomerId>
    <DivisionOrganizationId>1</DivisionOrganizationId>
    <EffectiveDate>2024-12-21T08:33:09.7284836-10:00</EffectiveDate>
    <ExpirationDate>2024-12-21T08:33:09.7284836-10:00</ExpirationDate>
    <LineOfBusiness>sample string 1</LineOfBusiness>
    <PrimaryNamedInsured xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>7</d3p1:Id>
      <d3p1:CommercialName>sample string 3</d3p1:CommercialName>
      <d3p1:EmailAddress>sample string 4</d3p1:EmailAddress>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:HomePhone>sample string 5</d3p1:HomePhone>
      <d3p1:LastName>sample string 2</d3p1:LastName>
      <d3p1:MailingAddress>
        <d3p1:Expand></d3p1:Expand>
        <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d3p1:Id>9</d3p1:Id>
        <d3p1:Address1>sample string 1</d3p1:Address1>
        <d3p1:Address2>sample string 2</d3p1:Address2>
        <d3p1:City>sample string 3</d3p1:City>
        <d3p1:Country>sample string 6</d3p1:Country>
        <d3p1:County>sample string 5</d3p1:County>
        <d3p1:State>sample string 4</d3p1:State>
        <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1>
        <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2>
        <d3p1:Type>Unknown</d3p1:Type>
      </d3p1:MailingAddress>
      <d3p1:MobilePhone>sample string 6</d3p1:MobilePhone>
      <d3p1:RiskAddress>
        <d3p1:Expand></d3p1:Expand>
        <d3p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d3p1:Id>9</d3p1:Id>
        <d3p1:Address1>sample string 1</d3p1:Address1>
        <d3p1:Address2>sample string 2</d3p1:Address2>
        <d3p1:City>sample string 3</d3p1:City>
        <d3p1:Country>sample string 6</d3p1:Country>
        <d3p1:County>sample string 5</d3p1:County>
        <d3p1:State>sample string 4</d3p1:State>
        <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1>
        <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2>
        <d3p1:Type>Unknown</d3p1:Type>
      </d3p1:RiskAddress>
      <d3p1:RiskAddressIsMailingAddress>true</d3p1:RiskAddressIsMailingAddress>
      <d3p1:Type>Unknown</d3p1:Type>
    </PrimaryNamedInsured>
    <QuoteName>sample string 9</QuoteName>
    <QuoteNumber>sample string 7</QuoteNumber>
    <QuoteTerm>Unknown</QuoteTerm>
    <RateGuaranteeDate>2024-12-21T08:33:09.7284836-10:00</RateGuaranteeDate>
    <RatingTaxa>sample string 2</RatingTaxa>
    <RenewalBillPlanId>1</RenewalBillPlanId>
    <State>sample string 3</State>
    <SubagencyCommissionOverride xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>2</d3p1:Id>
      <d3p1:CommissionOverride>true</d3p1:CommissionOverride>
      <d3p1:OverrideRate>1</d3p1:OverrideRate>
      <d3p1:OverrideType>Unknown</d3p1:OverrideType>
      <d3p1:Rate>1</d3p1:Rate>
      <d3p1:Type>Unknown</d3p1:Type>
    </SubagencyCommissionOverride>
    <SubagencyId>1</SubagencyId>
    <UnderwriterId>1</UnderwriterId>
    <UnderwritingCompanyId>5</UnderwritingCompanyId>
    <UniversalAccountId>6</UniversalAccountId>
  </Quote>
</QuoteProductInboundDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Create Quote

SimpleQuoteResponseDTO

Name	Description	Type	Additional information
QuoteId		integer	None.
QuoteNumber		string	None.
ProductId		integer	None.
Premium		decimal number	None.
CustomerId		integer	None.
UnderwritingResults		Collection of UnderwritingResultOutboundDTO	None.
WarningMessages	List of warning messages encountered while servicing request	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "QuoteId": 1,
  "QuoteNumber": "sample string 2",
  "ProductId": 1,
  "Premium": 3.0,
  "CustomerId": 1,
  "UnderwritingResults": [
    {
      "RuleCode": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "RuleCode": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SimpleQuoteResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>4</Id>
  <CustomerId>1</CustomerId>
  <Premium>3</Premium>
  <ProductId>1</ProductId>
  <QuoteId>1</QuoteId>
  <QuoteNumber>sample string 2</QuoteNumber>
  <UnderwritingResults>
    <UnderwritingResultOutboundDTO>
      <Id>3</Id>
      <Message>sample string 2</Message>
      <RuleCode>sample string 1</RuleCode>
    </UnderwritingResultOutboundDTO>
    <UnderwritingResultOutboundDTO>
      <Id>3</Id>
      <Message>sample string 2</Message>
      <RuleCode>sample string 1</RuleCode>
    </UnderwritingResultOutboundDTO>
  </UnderwritingResults>
</SimpleQuoteResponseDTO>