Save decant closure
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
returnHome: {
returnOn: '<string>',
providerCheckOutOn: '<string>',
finalReviewOn: '<string>'
},
rehousing: {
newAddress: '<string>',
tenancyStartOn: '<string>',
previousTenancyEndOn: '<string>',
disturbanceAllowanceMinor: 123,
removals: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure"
payload = {
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"case": {
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"householdLabel": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"type": "temporary_decant",
"status": "scheduled",
"startOn": "<string>",
"expectedEndOn": "<string>",
"ownerUserId": "<string>",
"ownerName": "<string>",
"funding": "building_insurer",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"claimReference": "<string>",
"closedAt": "<string>",
"tabs": [
{
"stage": "overview",
"label": "<string>",
"subtitle": "<string>",
"tone": "neutral"
}
]
},
"outcome": "return_home",
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
},
"checklist": [
{
"id": "<string>",
"item": "<string>",
"owner": "<string>",
"status": "not_started",
"completedOn": "<string>"
}
],
"completeCount": 123,
"totalCount": 123,
"canClose": true,
"closedAt": "<string>",
"finalPosition": {
"daysInDecant": 123,
"accommodationMinor": 123,
"allowancesMinor": 123,
"totalMinor": 123,
"recoverableMinor": 123,
"rechargeLandlordMinor": 123
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}maintenance-pro
Save decant closure
Choose the outcome (return home or permanent rehousing) and its details
POST
/
maintenance-pro
/
decants
/
{id}
/
closure
Save decant closure
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
returnHome: {
returnOn: '<string>',
providerCheckOutOn: '<string>',
finalReviewOn: '<string>'
},
rehousing: {
newAddress: '<string>',
tenancyStartOn: '<string>',
previousTenancyEndOn: '<string>',
disturbanceAllowanceMinor: 123,
removals: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/decants/{id}/closure"
payload = {
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"case": {
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"householdLabel": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"type": "temporary_decant",
"status": "scheduled",
"startOn": "<string>",
"expectedEndOn": "<string>",
"ownerUserId": "<string>",
"ownerName": "<string>",
"funding": "building_insurer",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"claimReference": "<string>",
"closedAt": "<string>",
"tabs": [
{
"stage": "overview",
"label": "<string>",
"subtitle": "<string>",
"tone": "neutral"
}
]
},
"outcome": "return_home",
"returnHome": {
"returnOn": "<string>",
"providerCheckOutOn": "<string>",
"finalReviewOn": "<string>"
},
"rehousing": {
"newAddress": "<string>",
"tenancyStartOn": "<string>",
"previousTenancyEndOn": "<string>",
"disturbanceAllowanceMinor": 123,
"removals": "<string>"
},
"checklist": [
{
"id": "<string>",
"item": "<string>",
"owner": "<string>",
"status": "not_started",
"completedOn": "<string>"
}
],
"completeCount": 123,
"totalCount": 123,
"canClose": true,
"closedAt": "<string>",
"finalPosition": {
"daysInDecant": 123,
"accommodationMinor": 123,
"allowancesMinor": 123,
"totalMinor": 123,
"recoverableMinor": 123,
"rechargeLandlordMinor": 123
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
Body
application/json
Response
Success