Damage Service Report Event [Deprecated]
- URL:
<SPCIntegrationAPIUrl>/Claim/DamageServiceReport
- HTTP METHOD:
PUT
- URL Example:
https://servicepartnercompany.com/ecbintegration/Claim/DamageServiceReport
- Schema:
DamageServiceReportEventRequest.schema.json
- Example:
DamageServiceReportEventRequest.example.json
| 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 |
| Property | Description |
|---|
claim* | Claim object |
report* | Report object |
| Property | Description |
|---|
id* | Claim unique identifier in ECB |
number* | Claim number |
url* | URL to Claim Details in ECB |
| 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 |
status* | Damage service report status
Possible values are: “Proposed”, “Approved”, “Rejected”, “Draft” |
rejectionReason | Damage service report rejection reason in case when report was rejected |
url* | URL to report details in ECB |
message | Free text description that will appear on Messages Tab |
files | Collection of File objects |
| Property | Description |
|---|
description* | Free text damage description |
photos | Collection of File objects representing damage images only |
| 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 |
| 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 |
estimatedCost* | Estimated Cost object |
| Property | Description |
|---|
calculationType | Specifies whether estimated expense items should be used or total estimated amount. Possible values are: “Items”, “Amount” |
groups | Collection of Expense Group objects |
items | Collection of Expense Item objects (redundant when groups are available) |
totalAmount | Total estimated cost amount (ex. VAT) |
| Property | Description |
|---|
title* | Item title |
category* | Item Category identifier
Supported values are: "Wages", "Materials", "Equipment", "Subcontractor", "Claimant", "Other", "EquipmentInsurance", "SubcontractorAdmin", "EnvironmentAdditional" |
unit* | Item Unit Of Measure identifier
Supported values are: "Pcs", "Hours", "Days", "Kilograms", "Liters", "Meters", "SquareMeters", "CubicMeters", "Lbm", "Sum", "Tonnes", "Bags", "Kilometers", "CubicMetersDays", "None" |
amount* | Amount of items |
unitPrice | Item unit price (ex. VAT) |
agreementPrice* | Unit price with discount according to agreements with SPC (ex. VAT) |
salesPrice* | Sales price. agreementPrice value multiplied by amount of items (ex. VAT) |
vat* | VAT amount |
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" |
type | Items type. Supported values are: "Service", "Materials", "Equipment", "EnvironmentalFee", "Dehumidification", "Other" |
subitems | Subitem collection of Expense Item objects |
| Property | Description |
|---|
name* | File name |
mimeType* | File MIME type. For example, “image/jpeg”, “text/html” |
Size | Original file size in bytes, before Base64 encoding |
description | Free text file description |
id* | File unique identifier in ECB |
| Property | Description |
|---|
name* | Group name |
items | Collection of Expense Item objects |
- Schema:
DamageServiceReportEventResponse.schema.json
- Example:
DamageServiceReportEventResponse.example.json
| 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 |
| Property | Description |
|---|
claim.referenceNumber* | Claim reference number in SPC internal system |
This endpoint is invoked in both cases when new damage service report was created in ECB and when existing damage service report was modified or its status was changed.
ECB can send only those fields that were modified in damage service report. For example, when report was approved the only Status field is changed, and no information about the report will be included in the request except for required fields and Status field. This allows to avoid sending the same information each time something happens with the report.
Last updated on
