Can Submit Invoice
Integration point URL
- URL:
<ECBIntegrationAPIUrl>/Invoice/CanSubmit - HTTP METHOD:
POST - URL Example:
https://sandbox.scalepoint.com/ecx/host/api/integration/v1/Invoice/CanSubmit
Request structure
- Schema:
CanSubmitInvoiceRequest.schema.json - Example:
CanSubmitInvoiceRequest.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 |
responsibleUserLogin* | User login of SPC employee responsible for invoice. 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. |
invoiceType* | Invoice type identifier that SPC is going to submit. Possible values are: “None”, “Repair”, “DamageService” |
expenseType* | Expense type that SPC is going to submit. Possible values are: “Invoice” - shall be used for “Repair” and “DamageService” invoice types. “CreditNote”, “ClaimantOwnWork”, “PaymentOnAccountInvoice”, “CashCompensation” – shall be used with “None” invoice type. |
service | Service object |
Claim object
| Property | Description |
|---|---|
id* | Claim unique identifier in ECB |
policy.insuranceCompany.alias* | Insurance company alias in ECB application |
Response structure
- Schema:
CanSubmitInvoiceResponse.schema.json - Example:
CanSubmitInvoiceResponse.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 |
|---|---|
canSubmitInvoice* | Indicates whether Service Partner can submit invoice in ECB or not. Possible values: “true”, “false” |
claimUrl | URL to the claim Settlement tab in ECB. |
estimatedCost | Estimated Cost object that represents calculations from latest approved repair offer or damage service report. |
paymentOnAccountDeduction* | Payment on account balance to be deducted. It is calculated in ECB basing on submitted invoices (amount without VAT) |
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) |
externalMaterialsEstimatedCost | External material supplier Estimated Cost object. Toggle “calculateExternalMaterialsSeparately” required to be true |
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" |
amount* | Amount of items |
unitPrice | Item unit price (ex. VAT) |
agreementPrice* | Unit price with discount according to agreements with SPC (ex. VAT) |
salesPrice* | Item sales price. Should be either unitPrice or agreementPrice value (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 | Item type Supported values are: "Service", "Materials", "Equipment", "EnvironmentalFee", "Dehumidification", "Other" |
subitems | Subitem collection of Expense Item objects |
Expense Group object
| Property | Description |
|---|---|
name* | Group name |
items | Collection of Expense Item objects |
External material supplier Estimated Cost object
| Property | Description |
|---|---|
totalInvoicedExternalMaterialsAmount | Total invoiced external material expense for service |
totalInvoicedRewardAmount | Total reward for service (based on invoice) |
totalEstimatedExternalMaterialsAmount | Total estimated external material expenses in last approved offer |
estimatedRewardAmount | Estimated reward in last approved offer |
Service object
| Property | Description |
|---|---|
orderNumber | Order number of a service that the invoice is related to |
Implementation notes
ECB checks whether Service Partner user is allowed to submit full invoice, not to save it as draft.
Last updated on