getAllBillingSummaries
- Description
- This inquiry transaction returns all billing summary objects for a given contract and its associated contract components. Depending upon the inquiry level provided, the billing summary miscellaneous values are returned. In addition to the inquiry level, billing status types or billing status values can be specified to retrieve billing summaries based on their status.
- Web Services
- Operation name: getAllBillingSummaries
- Example
- Retrieve all billing summaries or specific billing summaries based on the billing status such as rejected, void, or paid for on a whole life insurance policy, a term rider, a child protection rider, and a guaranteed insurability rider.
- Usage information
- When one or more billing status type or billing status value is
specified, only those billing summaries with the specified billing
status types or billing status values are returned.
Billing status types and values are defined using the CDBILLINGSTTP code table.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- ContractId
- InquiryLevel
- Inquiry levels
- InquiryLevel:
- Level 0 - returns the BillingSummary business object only.
- Level 1 - returns level 0 data plus all billing miscellaneous value business objects.
- Filter values
- One of:
- BillingStatusTypes
- BillingStatusValues
- Transaction behavior
- The billing status types can be specified as either a billing status type or a billing status value, but not both.
- Request message
- <TCRMTxType> getAllBillingSummaries
- Response objects
- TCRMBillingSummaryBObj
- Special note
- Not applicable