GET v1/Policies/{policyId}/Premium
Gets the base policy premium and base carrier fees on a policy
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| policyId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ActionResultDTOOfPolicyPremiumDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | PolicyPremiumDTO |
None. |
|
| CreatedBy | string |
None. |
|
| EntityID | integer |
None. |
|
| RowSource | string |
None. |
|
| PolicyID | integer |
None. |
|
| IsSuccess | boolean |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| InfoMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": {
"PolicyQuoteID": 1,
"CustomerID": 2,
"PremiumBase": 3.0,
"EndorsementPremium": 4.0,
"IssuedPolicy": true,
"NominalTermAmount": 1.0,
"WrittenAmount": 1.0,
"PolicyCarrierFees": [
{
"Id": 1,
"PolicyQuoteId": 2,
"CarrierFeeId": 3,
"AmountIsPercent": true,
"Amount": 5.0,
"CalculatedAmount": 6.0,
"CommBaseAmount": 7.0,
"CommIsPercent": true,
"CommBaseAmountManuallyChanged": true,
"Commissionable": true,
"CommAmount": 11.0,
"Commission": 12.0,
"EndorsementId": 13,
"CarrierFeeName": "sample string 14",
"UtilityCarrierFee": {
"CarrierFeeID": 1,
"CarrierFeeName": "sample string 2",
"DefaultAmount": 3.0,
"AmountIsPercent": true,
"SystemDefined": true,
"Visible": true,
"LocationID": 1,
"AppCreated": "sample string 6",
"ThirdPartyAppCode": "sample string 7"
},
"PolicyId": 15
},
{
"Id": 1,
"PolicyQuoteId": 2,
"CarrierFeeId": 3,
"AmountIsPercent": true,
"Amount": 5.0,
"CalculatedAmount": 6.0,
"CommBaseAmount": 7.0,
"CommIsPercent": true,
"CommBaseAmountManuallyChanged": true,
"Commissionable": true,
"CommAmount": 11.0,
"Commission": 12.0,
"EndorsementId": 13,
"CarrierFeeName": "sample string 14",
"UtilityCarrierFee": {
"CarrierFeeID": 1,
"CarrierFeeName": "sample string 2",
"DefaultAmount": 3.0,
"AmountIsPercent": true,
"SystemDefined": true,
"Visible": true,
"LocationID": 1,
"AppCreated": "sample string 6",
"ThirdPartyAppCode": "sample string 7"
},
"PolicyId": 15
}
]
},
"CreatedBy": "sample string 1",
"EntityID": 2,
"RowSource": "sample string 3",
"PolicyID": 4,
"IsSuccess": true,
"ErrorCode": "sample string 6",
"ErrorMessage": "sample string 7",
"InfoMessage": "sample string 8"
}
application/xml, text/xml
Sample:
<ActionResultOfPolicyPremiumDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
<ErrorCode>sample string 6</ErrorCode>
<ErrorMessage>sample string 7</ErrorMessage>
<InfoMessage>sample string 8</InfoMessage>
<IsSuccess>true</IsSuccess>
<CreatedBy>sample string 1</CreatedBy>
<EntityID>2</EntityID>
<PolicyID>4</PolicyID>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
<d2p1:CustomerID>2</d2p1:CustomerID>
<d2p1:EndorsementPremium>4</d2p1:EndorsementPremium>
<d2p1:IssuedPolicy>true</d2p1:IssuedPolicy>
<d2p1:NominalTermAmount>1</d2p1:NominalTermAmount>
<d2p1:PolicyCarrierFees>
<d2p1:PolicyCarrierFeeDTO>
<d2p1:Amount>5</d2p1:Amount>
<d2p1:AmountIsPercent>true</d2p1:AmountIsPercent>
<d2p1:CalculatedAmount>6</d2p1:CalculatedAmount>
<d2p1:CarrierFeeId>3</d2p1:CarrierFeeId>
<d2p1:CarrierFeeName>sample string 14</d2p1:CarrierFeeName>
<d2p1:CommAmount>11</d2p1:CommAmount>
<d2p1:CommBaseAmount>7</d2p1:CommBaseAmount>
<d2p1:CommBaseAmountManuallyChanged>true</d2p1:CommBaseAmountManuallyChanged>
<d2p1:CommIsPercent>true</d2p1:CommIsPercent>
<d2p1:Commission>12</d2p1:Commission>
<d2p1:Commissionable>true</d2p1:Commissionable>
<d2p1:EndorsementId>13</d2p1:EndorsementId>
<d2p1:Id>1</d2p1:Id>
<d2p1:PolicyId>15</d2p1:PolicyId>
<d2p1:PolicyQuoteId>2</d2p1:PolicyQuoteId>
<d2p1:UtilityCarrierFee>
<d2p1:AmountIsPercent>true</d2p1:AmountIsPercent>
<d2p1:AppCreated>sample string 6</d2p1:AppCreated>
<d2p1:CarrierFeeID>1</d2p1:CarrierFeeID>
<d2p1:CarrierFeeName>sample string 2</d2p1:CarrierFeeName>
<d2p1:DefaultAmount>3</d2p1:DefaultAmount>
<d2p1:LocationID>1</d2p1:LocationID>
<d2p1:SystemDefined>true</d2p1:SystemDefined>
<d2p1:ThirdPartyAppCode>sample string 7</d2p1:ThirdPartyAppCode>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:UtilityCarrierFee>
</d2p1:PolicyCarrierFeeDTO>
<d2p1:PolicyCarrierFeeDTO>
<d2p1:Amount>5</d2p1:Amount>
<d2p1:AmountIsPercent>true</d2p1:AmountIsPercent>
<d2p1:CalculatedAmount>6</d2p1:CalculatedAmount>
<d2p1:CarrierFeeId>3</d2p1:CarrierFeeId>
<d2p1:CarrierFeeName>sample string 14</d2p1:CarrierFeeName>
<d2p1:CommAmount>11</d2p1:CommAmount>
<d2p1:CommBaseAmount>7</d2p1:CommBaseAmount>
<d2p1:CommBaseAmountManuallyChanged>true</d2p1:CommBaseAmountManuallyChanged>
<d2p1:CommIsPercent>true</d2p1:CommIsPercent>
<d2p1:Commission>12</d2p1:Commission>
<d2p1:Commissionable>true</d2p1:Commissionable>
<d2p1:EndorsementId>13</d2p1:EndorsementId>
<d2p1:Id>1</d2p1:Id>
<d2p1:PolicyId>15</d2p1:PolicyId>
<d2p1:PolicyQuoteId>2</d2p1:PolicyQuoteId>
<d2p1:UtilityCarrierFee>
<d2p1:AmountIsPercent>true</d2p1:AmountIsPercent>
<d2p1:AppCreated>sample string 6</d2p1:AppCreated>
<d2p1:CarrierFeeID>1</d2p1:CarrierFeeID>
<d2p1:CarrierFeeName>sample string 2</d2p1:CarrierFeeName>
<d2p1:DefaultAmount>3</d2p1:DefaultAmount>
<d2p1:LocationID>1</d2p1:LocationID>
<d2p1:SystemDefined>true</d2p1:SystemDefined>
<d2p1:ThirdPartyAppCode>sample string 7</d2p1:ThirdPartyAppCode>
<d2p1:Visible>true</d2p1:Visible>
</d2p1:UtilityCarrierFee>
</d2p1:PolicyCarrierFeeDTO>
</d2p1:PolicyCarrierFees>
<d2p1:PolicyQuoteID>1</d2p1:PolicyQuoteID>
<d2p1:PremiumBase>3</d2p1:PremiumBase>
<d2p1:WrittenAmount>1</d2p1:WrittenAmount>
</Result>
<RowSource>sample string 3</RowSource>
</ActionResultOfPolicyPremiumDTO>