Submit Damage Service Report
Integration point URL
- URL:
<ECBIntegrationAPIUrl>/DamageServiceReport/Submit - HTTP METHOD:
POST - URL Example:
https://sandbox.scalepoint.com/ecx/host/api/integration/v1/DamageServiceReport/Submit
Request structure
- Schema:
SubmitDamageServiceReportRequest.schema.json - Example:
SubmitDamageServiceReportRequest.example.json
Root object
| Property | Description |
|---|---|
securityToken* | Pre-shared secret string key that is used to authenticate SPC and ECB to each other |
timestamp* | Message generation UTC date/time. Should be in ISO 8601 format without time zone. Note: Can be used to restore messages original order (per claim) – due to network/server errors it’s not guaranteed that messages will arrive in the order they were generated |
payload* | Payload object with integration endpoint specific data |
* Here and later * after property name means that property is required, ** conditionally required. Properties without those marks are optional.
Payload object
| Property | Description |
|---|---|
claim* | Claim object |
report* | Report object |
service | Service object |
Claim object
| Property | Description |
|---|---|
id* | Claim unique identifier in ECB |
policy.insuranceCompany.alias* | Insurance company alias in ECB application |
Report object
| Property | Description |
|---|---|
responsibleUserLogin* | User login of SPC employee responsible for damage report. Also used to identify specific service partner company in SPC organization Note: List of all users in SPC organization can be obtained using Damage Notification integration points. Those point are described in a separate specification, please contact Scalepoint to obtain it. |
referenceNumber | Claim reference number in internal SPC system |
damageDescription* | Damage Description object |
acuteDamageStop | Acute Damage Stop object |
followUpDamageStop | Follow up damage stop object |
message | Free text description that will appear on Messages Tab |
files | Collection of File objects |
Damage Description object
| Property | Description |
|---|---|
description* | Free text damage description |
photos | Collection of File objects representing damage images only |
Acute Damage Stop object
| Property | Description |
|---|---|
arrival* | Date and time of arrival to claimant. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone) |
workPerformed* | Free text description of performed work |
subTotal | Total estimated acute cost amount (ex. VAT) |
Follow up Damage Stop object
| Property | Description |
|---|---|
estimatedStart* | Estimated work start date. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone) |
estimatedFinish* | Estimated work finish date. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone) |
workDescription* | Free text description of required work scope |
calculationType | Specifies whether estimated expense items should be used or total estimated amount. Possible values are: “Items”, “Amount” |
groups | Collection of Report Group objects |
items | Collection of Report Item objects (redundant when groups are available) |
subTotal | Total estimated cost amount (ex. VAT) |
File object
| Property | Description |
|---|---|
name* | Full file name with proper extension ie. file.docx, file.pdf |
mimeType* | File MIME type. For example, “image/jpeg”, “text/html” |
Size | Original file size in bytes, before Base64 encoding |
description | Free text file description |
content* | Base64-encoded file content |
Report Item object
| Property | Description |
|---|---|
title** | Item title (required only when externalCode and externalSource not provided) |
category** | Item Category identifier Supported values are: "Wages", "Materials", "Equipment", "Subcontractor", "Claimant", "Other", "EquipmentInsurance", "SubcontractorAdmin", "EnvironmentAdditional", "Dehumidification", "UnitPrice", "Transport", "ExternalSupplier", "WorkUnit", "CustomMaterials". (required only when fulfilled by and type not provided) |
unit** | Item Unit Of Measure identifier Supported values are: "Pcs", "Hours", "Days", "Kilograms", "Liters", "Meters", "SquareMeters", "CubicMeters", "Lbm", "Sum", "Tonnes", "Bags", "Kilometers", "CubicMetersDays", "Pair", "Half", "Unit", "SquareMetersDays", "ManualWorkUnit", "KiloWattHours" (required only when externalCode and externalSource not provided) |
quantity* | Quantity of items |
unitPrice** | Item unit price (ex. VAT, required only when externalCode and externalSource not provided) |
vat** | VAT amount (required only when externalCode and externalSource not provided) |
externalCode | Item code from external system |
externalId | Product identifier from external system |
externalSource | Item external system source |
fulfilledBy** | Who fulfills item. Supported values are: "MyCompany", "Subcontractor", "Claimant" (required only when category not provided) |
type** | Items type. Supported values are: "Service", "Materials", "Equipment", "EnvironmentalFee", "Dehumidification", "Other" (required only when category or externalCode and externalSource not provided) |
subitems | Subitem collection of Report Item objects |
Report Group object
| Property | Description |
|---|---|
name* | Group name |
items | Collection of Report Item objects |
Service object
| Property | Description |
|---|---|
orderNumber | Order number of a service that the report is related to |
Response structure
- Schema:
SubmitDamageServiceReportDraftResponse.schema.json - Example:
SubmitDamageServiceReportDraftResponse.example.json
Root object
| Property | Description |
|---|---|
success* | Boolean flag representing if request is processed successfully |
errorDescription | Description of errors, if any |
payload | Payload object with integration endpoint specific data |
Payload object
| Property | Description |
|---|---|
report.submitDraftUrl | URL for Submit damage report form in ECB application to complete report submission from the draft |
report.viewUrl* | URL for view damage report form in ECB application. |
warnings | List of warnings if not possible to submit damage service report. |
Request with warning handling
If there are no all data submitted and not possible to submit damage service report then warnings node will be present in payload response and damage service report draft will be created instead.
Duplicate requests handling
If ECB claim with ID payload.claim.id already contains damage service report draft with reference number equal to payload.report.referenceNumber then existing draft will be overwritten with data from new request.
If ECB claim with ID payload.claim.id already contains damage service report with reference number equal to payload.report.referenceNumber then new report will be created and existing one will become outdated.
If no damage service report with given reference number exists on a claim then new with data from request will be created.
Last updated on