Void archive
curl --request GET \
--url https://api.sortx.co.uk/handovers/voids/archive \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/handovers/voids/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/handovers/voids/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"period": "<string>",
"periods": [
{
"id": "<string>",
"label": "<string>"
}
],
"rows": [
{
"voidId": "<string>",
"propertyId": "<string>",
"label": "<string>",
"emptySince": "<string>",
"closedOn": "<string>",
"days": 123,
"worksCostMinor": 123,
"taskCount": 123,
"outcome": "let",
"outcomeLabel": "<string>"
}
],
"totals": {
"count": 123,
"totalDays": 123,
"totalWorksMinor": 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>"
}handovers
Void archive
Finished voids in a year (YYYY, default this year) or all, with outcome, days, works cost and totals
GET
/
handovers
/
voids
/
archive
Void archive
curl --request GET \
--url https://api.sortx.co.uk/handovers/voids/archive \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/handovers/voids/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/handovers/voids/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"period": "<string>",
"periods": [
{
"id": "<string>",
"label": "<string>"
}
],
"rows": [
{
"voidId": "<string>",
"propertyId": "<string>",
"label": "<string>",
"emptySince": "<string>",
"closedOn": "<string>",
"days": 123,
"worksCostMinor": 123,
"taskCount": 123,
"outcome": "let",
"outcomeLabel": "<string>"
}
],
"totals": {
"count": 123,
"totalDays": 123,
"totalWorksMinor": 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>"
}