Pay decant entitlements
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/payments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"entitlementIds": [
"<string>"
],
"paidOn": "<string>",
"payee": "<string>",
"method": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
entitlementIds: ['<string>'],
paidOn: '<string>',
payee: '<string>',
method: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/payments', 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}/payments"
payload = {
"requestId": "<string>",
"entitlementIds": ["<string>"],
"paidOn": "<string>",
"payee": "<string>",
"method": "<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"
}
]
},
"entitlements": [
{
"id": "<string>",
"item": "<string>",
"basis": "<string>",
"fromOn": "<string>",
"toOn": "<string>",
"days": 123,
"rateText": "<string>",
"rateMinor": 123,
"unit": "per_day",
"amountMinor": 123,
"rechargeTo": "building_insurer",
"paidOn": "<string>",
"paymentId": "<string>",
"runningCostId": "<string>"
}
],
"payments": [
{
"id": "<string>",
"paidOn": "<string>",
"payee": "<string>",
"method": "<string>",
"reference": "<string>",
"amountMinor": 123,
"rechargeTo": "building_insurer"
}
],
"rates": [
{
"id": "<string>",
"item": "<string>",
"rateText": "<string>",
"rateMinor": 123,
"unit": "per_day",
"applies": "<string>"
}
],
"totals": {
"entitledMinor": 123,
"paidMinor": 123,
"outstandingMinor": 123
},
"payee": {
"name": "<string>",
"method": "<string>",
"verifiedOn": "<string>"
}
}{
"_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
Pay decant entitlements
Pay entitlements: one payment (PAY-#####) to the payee
POST
/
maintenance-pro
/
decants
/
{id}
/
payments
Pay decant entitlements
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/payments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"entitlementIds": [
"<string>"
],
"paidOn": "<string>",
"payee": "<string>",
"method": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
entitlementIds: ['<string>'],
paidOn: '<string>',
payee: '<string>',
method: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/payments', 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}/payments"
payload = {
"requestId": "<string>",
"entitlementIds": ["<string>"],
"paidOn": "<string>",
"payee": "<string>",
"method": "<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"
}
]
},
"entitlements": [
{
"id": "<string>",
"item": "<string>",
"basis": "<string>",
"fromOn": "<string>",
"toOn": "<string>",
"days": 123,
"rateText": "<string>",
"rateMinor": 123,
"unit": "per_day",
"amountMinor": 123,
"rechargeTo": "building_insurer",
"paidOn": "<string>",
"paymentId": "<string>",
"runningCostId": "<string>"
}
],
"payments": [
{
"id": "<string>",
"paidOn": "<string>",
"payee": "<string>",
"method": "<string>",
"reference": "<string>",
"amountMinor": 123,
"rechargeTo": "building_insurer"
}
],
"rates": [
{
"id": "<string>",
"item": "<string>",
"rateText": "<string>",
"rateMinor": 123,
"unit": "per_day",
"applies": "<string>"
}
],
"totals": {
"entitledMinor": 123,
"paidMinor": 123,
"outstandingMinor": 123
},
"payee": {
"name": "<string>",
"method": "<string>",
"verifiedOn": "<string>"
}
}{
"_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