Report Status Changed Event
Integration point URL
- URL:
<SPCIntegrationAPIUrl>/Claim/ReportStatusChanged - HTTP METHOD:
PUT - URL Example:
https://servicepartnercompany.com/ecbintegration/Claim/ReportStatusChanged
Request structure
- Schema:
ReportStatusChangedEventRequest.schema.json - Example:
ReportStatusChangedEventRequest.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 |
Payload object
| Property | Description |
|---|---|
claim* | Claim object |
report* | Report object |
Claim object
| Property | Description |
|---|---|
id* | Claim unique identifier in ECB |
number* | Claim number |
url* | URL to Claim Details in ECB |
Report object
| Property | Description |
|---|---|
reportType* | Report type that indicates the concrete Report object payload. Possible values are: “DamageService”, “RepairOffer” |
responsibleUserLogin* | User login of SPC employee responsible for the report. Also used to identify specific service partner company in SPC organization Note: List of all users in SPC organization can be obtained using by, example for DamageService, 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 | [Only for reportType=DamageService] Damage Description object |
acuteDamageStop | [Only for reportType=DamageService] Acute Damage Stop object |
followUpDamageStop | [Only for reportType=DamageService] Follow up damage stop object |
repairOfferItems | [Only for reportType=RepairOffer] Collection of Expense Item objects (redundant when groups are available) |
repairOfferGroups | [Only for reportType=RepairOffer] Collection of Expense Group objects |
status* | Report status. Possible values are: “Proposed”, “Approved”, “Rejected”, “Draft” |
rejectionReason | 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 |
Damage Description object [only for reportType=DamageService]
| Property | Description |
|---|---|
description* | Free text damage description |
photos | Collection of File objects representing damage images only |
Acute Damage Stop object [only for reportType=DamageService]
| 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 |
Follow up Damage Stop object [only for reportType=DamageService]
| 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 |
Estimated Cost object [only for reportType=DamageService]
| 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) |
Expense Item object
| 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 |
File object [only for reportType=DamageService]
| 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 |
Expense Group object
| Property | Description |
|---|---|
name* | Group name |
items | Collection of Expense Item objects |
Response structure
- Schema:
ReportStatusChangedEventResponse.schema.json - Example:
ReportStatusChangedEventResponse.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 |
|---|---|
claim.referenceNumber* | Claim reference number in SPC internal system |
Implementation notes
This endpoint is invoked in both cases when new report was created in ECB and when existing report was modified or its status was changed.
ECB always sends all fields (not only the ones that were modified in the report).
Last updated on