Submit Offer

Integration point URL

URL: <ECBIntegrationAPIUrl>/Offer/Submit
HTTP METHOD: POST
URL Example: https://sandbox.scalepoint.com/ecx/host/api/integration/v1/Offer/Submit

Request structure

Schema: SubmitOfferRequest.schema.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
`serviceType`	String key that defines which service submits an offer. “Repair” stands for repair service and “Damage” stands for damage service.
`claim*`	Claim object
`report**`	Report object
`offer**`	Offer 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

Offer object

Property	Description
`isDraft*`	Boolean flag representing if submitted offer is a draft.
`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.
`calculationType*`	Specifies if submitted report is quote or estimate. Allowed values are: “Estimate”, “Quote”.
`expensesOption*`	Determines if submitted report is for repair of cash compensation. Allowed values are: “Repar”, “Compensation”
`fullCashCompensation**`	Value of cash compensation. Required if expensesOption is set to “Compensation”
`fullCashCompensationComment**`	Optional comment for cash compensation
`depreciationType*`	Depreciation type for an offer. Possible values are: “None”, “NoDepreciation”, “FixedAmount”, “PercentPerLine”.
`depreciation**`	Total value of depreciation. Required if depreciationType is set to “FixedAmount”.
`repairStartDate*`	Estimated work start date. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone)
`estimatedRepairEndDate*`	Estimated work finish date. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone)
`workIncludes*`	Additional comment for an offer.
`subTotal*`	Subtotal value for an entire offer.
`groups**`	Collection of Group object
`items*`	Collection of Item objects
`deductibleDetails*`	Collection of Deductible details objects

Item object

Property	Description
`guid**`	Unique identifier of an item. Required only if there are multiple groups, the item has subitems, or the item is a subitem of another item. Applicable only for EasyOffer users.
`parentGuid**`	Unique identifier of an item that is a parent of this item. Applicable only for EasyOffer users.
`groupGuid**`	Unique identifier of a group that contains this item. Applicable only for EasyOffer users. Only required if groups are provided.
`index**`	Index of an item on the offer. Starts from 0. Applicable only for EasyOffer users.
`title*`	Item title
`quantity*`	Quantity of items
`category*`	Item Category identifier Supported values are: "Wages", "Materials", "Equipment", "Subcontractor", "Claimant", "Other", "EquipmentInsurance", "SubcontractorAdmin", "EnvironmentAdditional", "Dehumidification", "UnitPrice", "Transport", "ExternalSupplier", "WorkUnit", "CustomMaterials".
`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)
`unitPrice*`	Item unit price (ex. VAT)
`vat*`	VAT amount
`vatPercentage*`	VAT percentage amount
`depreciationPercent**`	Depreciation percentage amount for an item if depreciationType in Offer object was set to “PercentPerLine”
`subitems**`	Collection of Item objects

Deductible details object

Property	Description
`deductible*`	Current deductible amount.
`originalDeductible*`	Original amount of deductible.
`damageCount**`	Damage count. Required if deductibleOption is set to “ConditionalDeductible”.
`deductibleOption*`	Deductible option to use. Allowed options are “None”, “PolicyDeductible”, “ConditionalDeductible”, “PercentageDeductible”, “ZeroDeductible”
`deductibleModifier**`	Deductible modifier amount. Required if deductibleOption is set to “ConditionalDeductible”.
`deductibleReason**`	Reason for deductible. Required if deductibleOptions is set to “ConditionalDeductible”.
`deductiblePercent**`	Deductible percent value. Required if deductibleOption is set to “PercentageDeductible”.
`percentageDeductibleMinValue**`	Minimum percentage value for deductible. Required if deductibleOption is set to “PercentageDeductible”.
`percentageDeductibleMaxValue**`	Maximum percentage value for deductible. Required if deductibleOption is set to “PercentageDeductible”.

Group object

Property	Description
`guid*`	Unique identifier of a group
`name*`	Group name
`index*`	Group index. Specifies order of a group on the offer. Starts from 0. Two groups cannot have the same index.

* Group object is optional if all items are under one group. This object is only viable for EasyOffer users.

Response structure

Root object

Property	Description
`success*`	Boolean flag representing if request is processed successfully
`errorDescription`	Description of errors, if any
`payload`	Returns submitted offer payload

Submit Offer

On this page