Mark interim measure collected
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/interim-measures/{id}/collected \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"collectedOn": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({collectedOn: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/interim-measures/{id}/collected', 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/interim-measures/{id}/collected"
payload = { "collectedOn": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"repairId": "<string>",
"repairReference": "<string>",
"caseId": "<string>",
"caseReference": "<string>",
"measures": [
{
"id": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"caseId": "<string>",
"caseReference": "<string>",
"measureType": "<string>",
"quantity": 123,
"location": "<string>",
"source": "stock",
"supplierName": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"deliveryFrom": "<string>",
"deliveryTo": "<string>",
"tenantToldAt": "<string>",
"tenantMessageId": "<string>",
"deliveredAt": "<string>",
"deliveryEvidence": "tenant_confirmation",
"deliveryDocumentId": "<string>",
"installedOn": "<string>",
"collectBy": "<string>",
"collectedOn": "<string>",
"chargedTo": "work_order",
"chargedWorkOrderId": "<string>",
"chargedWorkOrderReference": "<string>",
"chargedToLabel": "<string>",
"costMinor": 123,
"status": "arranged",
"actions": [
"tell_tenant"
],
"busy": true,
"createdAt": "<string>",
"createdByName": "<string>"
}
],
"runningCosts": [
{
"id": "<string>",
"repairId": "<string>",
"caseId": "<string>",
"meter": "<string>",
"unit": "<string>",
"startReading": 123,
"startOn": "<string>",
"latestReading": 123,
"latestOn": "<string>",
"units": 123,
"ratePence": 123,
"amountMinor": 123,
"entitlementId": "<string>"
}
],
"summary": {
"inPlace": 123,
"collected": 123,
"overdue": 123,
"runningCostsMinor": 123,
"plannedCollectionOn": "<string>"
},
"suppliers": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<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
Mark interim measure collected
Record that a measure was collected
POST
/
maintenance-pro
/
interim-measures
/
{id}
/
collected
Mark interim measure collected
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/interim-measures/{id}/collected \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"collectedOn": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({collectedOn: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/interim-measures/{id}/collected', 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/interim-measures/{id}/collected"
payload = { "collectedOn": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"repairId": "<string>",
"repairReference": "<string>",
"caseId": "<string>",
"caseReference": "<string>",
"measures": [
{
"id": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"caseId": "<string>",
"caseReference": "<string>",
"measureType": "<string>",
"quantity": 123,
"location": "<string>",
"source": "stock",
"supplierName": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"deliveryFrom": "<string>",
"deliveryTo": "<string>",
"tenantToldAt": "<string>",
"tenantMessageId": "<string>",
"deliveredAt": "<string>",
"deliveryEvidence": "tenant_confirmation",
"deliveryDocumentId": "<string>",
"installedOn": "<string>",
"collectBy": "<string>",
"collectedOn": "<string>",
"chargedTo": "work_order",
"chargedWorkOrderId": "<string>",
"chargedWorkOrderReference": "<string>",
"chargedToLabel": "<string>",
"costMinor": 123,
"status": "arranged",
"actions": [
"tell_tenant"
],
"busy": true,
"createdAt": "<string>",
"createdByName": "<string>"
}
],
"runningCosts": [
{
"id": "<string>",
"repairId": "<string>",
"caseId": "<string>",
"meter": "<string>",
"unit": "<string>",
"startReading": 123,
"startOn": "<string>",
"latestReading": 123,
"latestOn": "<string>",
"units": 123,
"ratePence": 123,
"amountMinor": 123,
"entitlementId": "<string>"
}
],
"summary": {
"inPlace": 123,
"collected": 123,
"overdue": 123,
"runningCostsMinor": 123,
"plannedCollectionOn": "<string>"
},
"suppliers": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<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
Response
Success