You are here:
InsClaimItemService:getClaimItems
Use this service to retrieve the list of Claimants and their corresponding open ClaimCoverages with the respective line items (loss or expense).
Method: getClaimItems
How It Works
-
Takes the
claimIdand gets all the open coverages and their line items (if any). -
Finds the claim line items of the specified type.
-
Returns a JSON of loss claim line items, grouped under involved items and involved parties. This JSON includes coverage amounts and adjusted amounts for each involved item, involved party, and coverage associated with each of these.
For expense type, returns a JSON including the details of each expense claim line item.
NoteThis service now uses the interface fields that are common between the Vlocity Data Model and the Salesforce Data Model.
You can use this service to get both Loss claim line items or Expense claim line items, but not both types at the same time.
Remote Options
Option |
Description |
|---|---|
|
Required. The Id of the claim for which the service gets claim line items. |
|
Optional.
If no value is entered, the service defaults to
|
Input JSON
Here's the format of the input JSON:
{
"claimId": <Id>,
"type": <String>
}Here's an example of the input JSON:
{
"claimId": "01t000000000000001",
"type": "Loss"
}Output JSON
The service returns a JSON that contains the claim items or expense items, depending on the claim type. Here's the format of the output JSON:
{
"claimItems": [
{
"coverages" : [
"claimItems" : []
]
}
]
}
// or
{
"expenseItems": [
{
"coverages" : [
"expenseItems" : []
]
}
]
}
Here's an example of the output JSON:
// sample of 2 Claimants, 1 with 2 open coverages (Collision, and BIPD with 1 loss item), the other with 1 open coverage (Collision with 1 loss item).
{
"claimItems": [
{
"coverages": [
{
"claimItems": [
{
"currencyIsoCode": "USD",
"additionalInfo": {},
"adjustedAmount": 200,
"claimAmount": 200,
"claimCoverageId": "0kP5e000000wk8DEAQ",
"claimId": "0Zk5e0000010xPlCAI",
"createdDate": "2021-07-28T18:39:36.000Z",
"currencySymbol": "$",
"description": "checkup for whiplash",
"id": "0l25e000000sXzLAAU",
"name": "Bodily Injury & Property Damage - 1",
"recipientId": "0aS5e0000010wl7EAA",
"recipientName": "Joe Black",
"status": "Open",
"type": "Loss"
}
],
"reserveAmount": 3200,
"reserveStatus": "Open",
"currencyIsoCode": "USD",
"currencySymbol": "$",
"createdDate": "2021-07-28T08:06:26.000Z",
"coverageName": "Bodily Injury & Property Damage",
"involvedName": "Excavator",
"involvedId": "0dq5e0000010wknAAA",
"insuredName": "Audi A5",
"insuredId": "0YW5e000000wvVYGAY",
"coverageStatus": "Open",
"coverageMode": "CoverageReserve",
"claimCoverageId": "0kP5e000000wk8DEAQ"
},
{
"claimItems": [],
"reserveAmount": 1230,
"reserveStatus": "Open",
"currencyIsoCode": "USD",
"currencySymbol": "$",
"createdDate": "2021-07-28T18:37:59.000Z",
"coverageName": "Collision",
"involvedName": "Excavator",
"involvedId": "0dq5e0000010wknAAA",
"insuredName": "Audi A5",
"insuredId": "0YW5e000000wvVYGAY",
"coverageStatus": "Open",
"coverageMode": "CoverageReserve",
"claimCoverageId": "0kP5e000000wk8cEAA"
}
],
"claimantName": "Joe Black",
"claimantId": "0aS5e0000010wl7EAA"
},
{
"coverages": [
{
"claimItems": [
{
"childClaimItems": [
{
"adjustedAmount": 100,
"adjustmentReason": "Deductible",
"currencyIsoCode": null,
"currencySymbol": null,
"id": null,
"name": null,
"parentLineItemId": "0l25e000000sXzGAAU"
}
],
"currencyIsoCode": "USD",
"additionalInfo": {},
"adjustedAmount": 0,
"claimAmount": 100,
"claimCoverageId": "0kP5e000000wk8EEAQ",
"claimId": "0Zk5e0000010xPlCAI",
"createdDate": "2021-07-28T18:37:01.000Z",
"currencySymbol": "$",
"description": "repair tail light",
"id": "0l25e000000sXzGAAU",
"name": "Collision - 1",
"recipientId": "0aS5e0000010wl2EAA",
"recipientName": "Ernie Newton",
"status": "Open",
"type": "Loss"
}
],
"reserveAmount": 3200,
"reserveStatus": "Open",
"currencyIsoCode": "USD",
"currencySymbol": "$",
"createdDate": "2021-07-28T08:06:27.000Z",
"coverageName": "Collision",
"involvedName": "Audi A5",
"involvedId": "0dq5e0000010wkiAAA",
"insuredName": "Audi A5",
"insuredId": "0YW5e000000wvVYGAY",
"coverageStatus": "Open",
"coverageMode": "CoverageReserve",
"claimCoverageId": "0kP5e000000wk8EEAQ"
}
],
"claimantName": "Ernie Newton",
"claimantId": "0aS5e0000010wl2EAA"
}
]
}