case_settled event is sent to IC when a claim got settled inside scalepoint platform. A case/claim could be settled manually by a claim handler or automatically by our rule engine so its depending on customer configurations.
{
"settlement": {
"approvedBy": {
"email": "och@company.com",
"name": "ochtryg",
"type": "user"
},
"summary": {
"deductible": 1000.0,
"shareOfVat": 0.0,
"depreciation": 0.0,
"manualReduction": 0.0
},
"revisionToken": "C3BEDF01-A49D-4CB1-A026-3A160AA5322A"
},
"parties": [{
"$id": "/parties/2",
"name": "Lauren Horn",
"address": {
"street": "335 Ranchero Rd",
"street2": "",
"city": "Racine",
"postalCode": "1357",
"countryCode": ""
},
"contact": {
"name": "Lauren Horn",
"telephone": "79169401",
"email": "och@scalepoint.com"
}
}, {
"$id": "/parties/0",
"name": "Scalepoint",
"address": {
"street": "",
"street2": "",
"city": "",
"postalCode": "",
"countryCode": ""
}
}, {
"$id": "/parties/1",
"name": "Tryg",
"address": {
"street": "",
"street2": "",
"city": "",
"postalCode": "",
"countryCode": ""
}
}
],
"expenses": [{
"$id": "/expenses/0",
"uuid": "449f0bdc-5589-41a9-ad23-655a9f5eff58",
"dueDate": "2018-09-10T11:22:39.760Z",
"issueDate": "2018-09-10T11:22:39.760Z",
"total": 9763.00,
"currencyCode": "NOK",
"payerParty": {
"$ref": "/parties/1"
},
"payeeParty": {
"$ref": "/parties/2"
},
"expenseType": "cashCompensation"
}
],
"payments": [{
"uuid": "6ec41869-cd6f-40f5-af12-8101896a7d53",
"dueDate": "2018-09-10T11:22:39.776Z",
"total": 8763.00,
"currencyCode": "NOK",
"payerParty": {
"$ref": "/parties/1"
},
"payeeParty": {
"$ref": "/parties/0"
},
"expenses": [{
"$ref": "/expenses/0"
}
],
"obligations": [{
"$ref": "/obligations/1"
}
],
"paymentMeans": {
"payeeFinancialAccount": {
"id": "123412341234",
"fiBranch": {
"id": "1234"
},
"paymentNote": "CH75691383",
"paymentDescription": "CH75691383"
},
"paymentMeansCode": "DOMESTIC_BANK_TRANSFER",
"paymentChannelCode": "DK:BANK"
}
}
],
"obligations": [{
"$id": "/obligations/0",
"obligationType": "compensation",
"total": 8763.00,
"currencyCode": "NOK",
"payerParty": {
"$ref": "/parties/0"
},
"payeeParty": {
"$ref": "/parties/2"
},
"expense": {
"$ref": "/expenses/0"
}
}, {
"$id": "/obligations/1",
"obligationType": "compensation",
"total": 8763.00,
"currencyCode": "NOK",
"payerParty": {
"$ref": "/parties/1"
},
"payeeParty": {
"$ref": "/parties/0"
},
"expense": {
"$ref": "/expenses/0"
}
}, {
"$id": "/obligations/2",
"obligationType": "deductible",
"total": 1000.00,
"currencyCode": "NOK",
"payerParty": {
"$ref": "/parties/2"
},
"payeeParty": {
"$ref": "/parties/2"
},
"expense": {
"$ref": "/expenses/0"
}
}
],
"eventType": "case_settled",
"payloadVersion": "1.0.0",
"correlationId": "7634A739-EF51-4706-92AD-AB57D88B0F78",
"timestamp": "2018-09-10T11:22:39.743Z",
"case": {
"uuid": "bd6e3a94-aded-4f2d-936e-783fea446b71",
"number": "CH75691383",
"externalClaimId": "",
"token": "c.7634A739-EF51-4706-92AD-AB57D88B0F78",
"caseType": "contentClaim"
}
}
| Attribute Name | Description |
|---|---|
| Case | Case related information |
| case.uuid | Unique id for the case |
| case.number | The caseNumber is the identifier for the case received from Insurance Company |
| case.externalclaimId | External claim Id is unique to the specified case and provided by Insurance Company |
| case.token | Case token - using this token customer always get the case related information |
| case.caseType | The caseType determines the kind of case - contentClaim, propertyclaim |
| timestamp | Time stamp when the event is created |
| correlationId | Scalepoint internal Id |
| payloadVersion | Version of the payload, in case if we do any breaking changes we will update this version |
| eventType | Type of the event. Fx. case_settled, claim_updated |
| Settlement | Case Settlement related info, for example who have settled this claim, and what is the applied deductible and what is applied depreciation |
| Settlement.approvedBy.email | Email address of the settlement approver |
| Settlement.approvedBy.name | Full name of the person who made changes to the claim |
| Settlement.approvedBy.username | Username of the settlement approver |
| Settlement.approvedBy.type | Type of the User approval. Can be 'automatic' or 'user' |
| Settlement.summary.deductible | amount of deductible applied in this settlement |
| Settlement.summary.shareOfVat | amount of VAT the claimant pays |
| Settlement.summary.depreciation | amount of depreciation applied in this settlement |
| Settlement.summary.manualReduction | Manual reduction applied for this settlement |
| Settlement.revisionToken | Revision Token is generated every time when a case is settled. Its a unique Id which should be used in Settlement API to get the list of the items got settled |
| Parties | Array of Parties involved in this case close |
| Parties.$id | reference to this party within the json document |
| Parties.id | Unique identification of the party. Can be CVR or CRP number |
| Parties.roles | Role of the party within the claim, for instance service provider or policy holder |
| Parties.name | Party Name who involved in this case settlement for example could be Insurance company or Service Partner or claimant |
| Parties.address.street | Party Address who involved in this case settlement for example could be Insurance company address or Service Partner address or claimant address |
| Parties.address.street2 | Party Address who involved in this case settlement for example could be Insurance company address or Service Partner address or claimant address |
| Parties.address.city | Party Address who involved in this case settlement for example could be Insurance company address or Service Partner address or claimant address |
| Parties.address.postalCode | Party Address who involved in this case settlement for example could be Insurance company address or Service Partner address or claimant address |
| Parties.address.countryCode | Party Address who involved in this case settlement for example could be Insurance company address or Service Partner address or claimant address |
| Parties.contact.name | Party contact name who involved in this case settlement for example could be Insurance company contact name or Service Partner name or claimant name |
| Parties.contact.telephone | Party contact telephone who involved in this case settlement for example could be Insurance company contact telephone or Service Partner telephone or claimant telephone |
| Parties.contact.email | Party contact email who involved in this case settlement for example could be Insurance company contact email or Service Partner email or claimant email |
| Expenses | Summary of the approved expenses |
| Expenses.$id | Reference to this expense within the json document |
| Expenses.uuid | Unique id for the expense |
| Expenses.dueDate | Duedate as stated on the invoice |
| Expenses.issueDate | Date for when the invoice was issued by the payee party |
| Expenses.total | Total amount on the invoice, before any selfcoverage (deductible, depreciation...) |
| Expenses.currencyCode | Currency for the invoice. For example DKK |
| Expenses.administrative | This is a special type of expense that is not supposed to cover claimant loss, but is issued by service provider when he performed some administrative tasks like inspection |
| Expenses.payerParty.$ref | Payer as stated on the invoice |
| Expenses.payeeParty.$ref | Issuer of invoice |
| Expenses.expenseType | Type of expense. Can be one of 'invoice', 'creditNote', 'repairInvoice', 'assessmentInvoice', 'rejectionInvoice', 'cashCompensation' |
| Payments | Array of transactions between parties |
| Payments.uuid | Unique id for the particular transaction. Can be used to provide feedback to scalepoint if the given transaction succeeded or not |
| Payments.dueDate | Due date for the payment |
| Payments.total | Amount to be transferred |
| Payments.currencyCode | Currency for the invoice. For example DKK |
| Payments.payerParty.$ref | Reference to the paying participant |
| Payments.payeeParty.$ref | Reference to the participant getting payed |
| Payments.expenses.$ref | Expenses to which this transaction relates |
| Payments.paymentMeans | defines the preferrec way of how the money should be transferred |
| Payments.paymentMeans.paymentMeansCode | defines the kind of payment eg. FIK, Domestic or internation bank trasfer |
| Payments.paymentMeans.paymentChannelCode | relates to paymentmeanscode |
| Payments.paymentMeans.payerFinancialAccount | Account information of the sending party |
| Payments.paymentMeans.payeeFinancialAccount | Account information of the recieving party |
| Payments.paymentMeans.paymentId | specifies the form category on joint info transfer form payment information (Danish abbreviation FIK), and Giro payment forms |
| Payments.paymentMeans.instructionId | specifies an OCR reference from a payment form using the PaymentID 04, 15, 71 or 75. The number of digits depends on which PaymentID is being used |
| Payments.paymentMeans.creditAccount | |
| Payments.paymentMeans.creditAccount.accountId | identifies the account ID on payment forms with the paymentId FIK71,FIK73,FIK75. The accountId is always 8 numeric characters |
| Payments.paymentMeans.financialAccount | The identifier for the Financial Account; the Bank Account Number |
| Payments.paymentMeans.fiBranch | For domestic bank transfer it is 4 digits bank branch number |
| Payments.additionalPaymentMeans | Array of secondary payment means. Usually this contains bank transfer if 'Payment means' contains FIK payment |
| Obligations | List of obligations which describes how expenses are covered, and why. Each one described in Obligation structure. |
| Obligations.id | Reference to this obligation within the event |
| Obligations.obligationType | Type of obligation. Can be one of 'deductible', 'depreciation', 'manualReduction', 'compensation', 'creditNote' |
| Obligations.total | Amount of obligation |
| Payments.currencyCode | Currency for the invoice. For example DKK |
| Payments.payerParty.$ref | Reference to the paying participant |
| Payments.payeeParty.$ref | Reference to the participant getting payed |
| Payments.expenses.$ref | Expenses to which this transaction relates |