PolicyTransactionPremiumUpdateRequest Element
In This Topic
Type
Diagram
Overview
 |
 |
Sequence
|
|
Sequence
|
PolicyId optional guid Simple Type
Globally Unique Identifier (GUID) for a Policy. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000.
|
|
TransactionEffectiveDate optional xs:dateTime
Identifies the Policy Transaction (endorsement) for the Policy that the PolicyTransactionPremium belongs to. Must be the complete DateTime value (in string format) of the TransactionEffectiveDate contained in an PolicyTransaction entity returned during a GetPolicy request.
This field uniquely identifies a specific policy transaction for the policy.
The Date component specifies the endorsement effective date and the Time component contains the transaction sequence number for that date using the second's value as a zero based counter.
For example the second policy endorsement on 5/1/2008 will have a TransactionEffectiveDate of '5/1/2008 12:00:01 AM'
|
|
PolicyTransactionPremiumId optional guid Simple Type
Globally Unique Identifier (GUID) for a PolicyTransactionPremium.
Insert Validation:
AMS360 creates on insert.
Update Validation:
Must be a valid PolicyTransctionPremiumId for the Policy and PolicyTransaction. 36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000.
|
|
LineOfBusiness optional xs:string
Identifies the line of business for this PolicyTransactionPremium.
Insert Validation:
Must be a valid LineOfBusiness for the Policy's TypeOfBusiness.
Update Validation:
Must be a valid LineOfBusiness for the Policy's TypeOfBusiness. Changes to this value are ignored during updates to previously billed PolicyTransactionPremium rows and no error message is returned. Valid AMS360 Line of Business codes.
|
|
PlanType optional xs:string
Identifies the program or plan for this PolicyTransactionPremium. Must be an existing program or plan that was setup in AMS360 for the Policy's insurance company.
Insert Validation:
PlanType must be a active plan type in the system and also active for the Policy's insurance company.
Update Validation:
PlanType must be a active plan type in the system and also active for the Policy's insurance company. Changes to this value are ignored during updates to previously billed PolicyTransactionPremium rows and no error message is returned.
|
|
WritingCompanyCode optional xs:string
Identifies the company for this PolicyTransactionPremium.
Insert Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode.
Update Validation:
Must be a valid AMS360 CompanyCode or WritingCompanyCode. If WritingCompanyCode change is done by UpdatePolicy, on an unbilled policy, all PolicyTransactionPremium rows for the policy term(includes policy effective date, past, current, and future endorsement dates) will be updated with the new WritingCompanyCode. Changes to this field are ignored during updates to previously billed PolicyTransactionPremium rows and no error message will be returned.
|
|
Description optional xs:string
Description for this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the description will default to the LineOfBusiness description.
Update Validation:
Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
Premium optional xs:decimal
The premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
WrittenPremium optional xs:decimal
The written premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
FullTermPremium optional xs:decimal
The full term premium amount associated with this PolicyTransactionPremium.
Insert Validation:
If not supplied on Insert, the value defaults to zero.
Update Validation:
If not supplied on Update, the value defaults to zero. Changes to this field are accepted during updates to posted (previously bill) PolicyTransactionPremium rows.
|
|
IncludePremium optional xs:boolean
Indicates if the premium values on this PolicyTransactionPremium should be included in policy totals.
Insert Validation:
Not available for insert. This value is ignored and no error message is returned.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
|
|
HowBilled optional xs:string
Value indicates how this PolicyTransactionPremium will be treated for billing purposes.
Insert Validation:
Agency Bill policies are restricted to use either Customer Center Billing ('C') or Not Billed ('N'). Direct Billed policies may use any HowBilled list value.
Update Validation:
Agency Bill policies are restricted to use either Customer Center Billing ('C') or Not Billed ('N'). Direct Billed policies may use any HowBilled list value. Changes to this field are ignored during updates to posted (previously bill) PolicyTransactionPremium rows and no error message is returned. Valid code values from the "HowBilled" name value list.
If you know the name of a value list and only need the contents of the list, you can retrieve the list using the ValueListGet() method.
Method=ValueListGet()
InputType=ValueListGetRequest
ListName=HowBilled
|
|
IsSuspended optional xs:boolean
System maintained value indicating if this PolicyTransactionPremium is in the process of being billed (invoiced).
Insert Validation:
Not available for insert. This value is ignored and no error message is returned.
Update Validation:
Not available for update. This value is ignored and no error message is returned.
|
|
Reconciled optional xs:string
System maintained field used for DirectBillStatement PolicyTransactionPremiums to indicate whether or not they have been completely reconciled on a Direct Bill Statement.
Insert Validation:
Not available for insert. This value is ignored and no error message is returned.
Update Validation:
Not available for update. This value is ignored and no error message is returned. If HowBilled is DirectBillStatement the value will be 'N' or 'Y'; If HowBilled is anything else, the value will be 'D'
|
| | | |
Source
<xs:element name="PolicyTransactionPremiumUpdateRequest" nillable="true" type="tns:PolicyTransactionPremiumUpdateRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema" /> |
See Also
