Add decant stay
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/stays \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fromOn": "<string>",
"toOn": "<string>",
"nightlyRateMinor": 123,
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fromOn: '<string>',
toOn: '<string>',
nightlyRateMinor: 123,
reason: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/stays', 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}/stays"
payload = {
"fromOn": "<string>",
"toOn": "<string>",
"nightlyRateMinor": 123,
"reason": "<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"
}
]
},
"placement": {
"provider": "<string>",
"address": "<string>",
"accommodationType": "<string>",
"bedrooms": 123,
"checkInOn": "<string>",
"bookedToOn": "<string>",
"nightlyRateMinor": 123,
"bookingReference": "<string>",
"invoicedByProviderMinor": 123
},
"providerContacts": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<string>"
}
],
"suitability": [
{
"requirement": "<string>",
"result": "met",
"detail": "<string>"
}
],
"stays": [
{
"id": "<string>",
"fromOn": "<string>",
"toOn": "<string>",
"nights": 123,
"nightlyRateMinor": 123,
"amountMinor": 123,
"approvedBy": "building_insurer",
"approvedByName": "<string>",
"status": "approved",
"reason": "<string>"
}
],
"options": [
{
"provider": "<string>",
"type": "<string>",
"bedrooms": 123,
"distanceToSchool": "<string>",
"pets": true,
"nightlyRateMinor": 123,
"availableFrom": "<string>",
"outcome": "<string>"
}
],
"cost": {
"nightsToDate": 123,
"costToDateMinor": 123,
"bookedTotalMinor": 123,
"bookedTotalWithRequestedMinor": 123,
"invoicedByProviderMinor": 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
Add decant stay
Add a stay period
POST
/
maintenance-pro
/
decants
/
{id}
/
stays
Add decant stay
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/stays \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fromOn": "<string>",
"toOn": "<string>",
"nightlyRateMinor": 123,
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fromOn: '<string>',
toOn: '<string>',
nightlyRateMinor: 123,
reason: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/stays', 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}/stays"
payload = {
"fromOn": "<string>",
"toOn": "<string>",
"nightlyRateMinor": 123,
"reason": "<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"
}
]
},
"placement": {
"provider": "<string>",
"address": "<string>",
"accommodationType": "<string>",
"bedrooms": 123,
"checkInOn": "<string>",
"bookedToOn": "<string>",
"nightlyRateMinor": 123,
"bookingReference": "<string>",
"invoicedByProviderMinor": 123
},
"providerContacts": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<string>"
}
],
"suitability": [
{
"requirement": "<string>",
"result": "met",
"detail": "<string>"
}
],
"stays": [
{
"id": "<string>",
"fromOn": "<string>",
"toOn": "<string>",
"nights": 123,
"nightlyRateMinor": 123,
"amountMinor": 123,
"approvedBy": "building_insurer",
"approvedByName": "<string>",
"status": "approved",
"reason": "<string>"
}
],
"options": [
{
"provider": "<string>",
"type": "<string>",
"bedrooms": 123,
"distanceToSchool": "<string>",
"pets": true,
"nightlyRateMinor": 123,
"availableFrom": "<string>",
"outcome": "<string>"
}
],
"cost": {
"nightsToDate": 123,
"costToDateMinor": 123,
"bookedTotalMinor": 123,
"bookedTotalWithRequestedMinor": 123,
"invoicedByProviderMinor": 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