Accept invoice suggestion
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/suggestions/{id}/accept-invoice \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"job": {
"id": "<string>"
},
"invoice": {
"number": "<string>",
"issuedOn": "<string>",
"lines": [
{
"description": "<string>",
"netMinor": 0,
"vatMinor": 0
}
],
"dueOn": "<string>",
"currency": "<string>",
"contractorContactId": "<string>",
"documentId": "<string>",
"tenancyId": "<string>",
"chargePropertyId": "<string>",
"paidOn": "<string>",
"paidReference": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
job: {id: '<string>'},
invoice: {
number: '<string>',
issuedOn: '<string>',
lines: [{description: '<string>', netMinor: 0, vatMinor: 0}],
dueOn: '<string>',
currency: '<string>',
contractorContactId: '<string>',
documentId: '<string>',
tenancyId: '<string>',
chargePropertyId: '<string>',
paidOn: '<string>',
paidReference: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/suggestions/{id}/accept-invoice', 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/suggestions/{id}/accept-invoice"
payload = {
"requestId": "<string>",
"job": { "id": "<string>" },
"invoice": {
"number": "<string>",
"issuedOn": "<string>",
"lines": [
{
"description": "<string>",
"netMinor": 0,
"vatMinor": 0
}
],
"dueOn": "<string>",
"currency": "<string>",
"contractorContactId": "<string>",
"documentId": "<string>",
"tenancyId": "<string>",
"chargePropertyId": "<string>",
"paidOn": "<string>",
"paidReference": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"suggestion": {
"state": "not_included",
"note": "<string>",
"id": "<string>",
"kind": "contractor-suitability",
"subjectKind": "<string>",
"subjectId": "<string>",
"result": {
"kind": "contractor-suitability",
"contractor": {
"status": "suggested",
"note": "<string>",
"stated": [
{
"id": "<string>",
"label": "<string>",
"phrase": "<string>"
}
],
"contractors": [
{
"contractorId": "<string>",
"name": "<string>",
"status": "suggested",
"rank": 123,
"overall": 123,
"note": "<string>",
"capabilities": [
{
"id": "<string>",
"label": "<string>",
"state": "fits",
"evidence": "<string>",
"note": "<string>"
}
]
}
],
"notRanked": [
{
"contractorId": "<string>",
"name": "<string>",
"reason": "<string>"
}
]
},
"inspection": {
"status": "suggested",
"note": "<string>",
"findings": [
{
"findingId": "<string>",
"label": "<string>",
"status": "suggested",
"sentences": [
{
"partKey": "<string>",
"text": "<string>",
"status": "suggested",
"kindLabel": "<string>",
"note": "<string>"
}
]
}
],
"suggestedFindingIds": [
"<string>"
],
"truncated": true
},
"invoice": {
"status": "suggested",
"note": "<string>",
"suggestedJob": {
"kind": "repair",
"id": "<string>",
"label": "<string>",
"propertyId": "<string>",
"blockId": "<string>",
"contractorContactId": "<string>"
},
"confidence": 123,
"descriptionMismatch": true,
"possibleDuplicate": true,
"alreadyInvoiced": true,
"current": {
"jobId": "<string>",
"label": "<string>",
"levelLabel": "<string>",
"credible": true,
"mismatch": true,
"duplicate": true,
"alreadyInvoiced": true,
"existingInvoiceNumber": "<string>"
},
"otherJobSuggested": true,
"candidates": [
{
"kind": "repair",
"id": "<string>",
"label": "<string>",
"levelLabel": "<string>",
"credible": true,
"existingInvoiceNumber": "<string>",
"current": true
}
]
}
},
"reviews": [
{
"item": "<string>",
"decision": "accepted",
"recordKind": "<string>",
"recordId": "<string>",
"reviewedByUserId": "<string>",
"note": "<string>",
"createdAt": "<string>"
}
],
"partCount": 123,
"failedParts": 123,
"retrying": true,
"canRetry": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"invoice": {
"id": "<string>",
"subjectKind": "<string>",
"subjectId": "<string>",
"subjectLabel": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"tenancyId": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"number": "<string>",
"issuedOn": "<string>",
"dueOn": "<string>",
"currency": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123,
"borneBy": "landlord",
"documentId": "<string>",
"status": "received",
"approvedAt": "<string>",
"creditedMinor": 123,
"paidMinor": 123,
"outstandingMinor": 123,
"disputedMinor": 123,
"payableMinor": 123,
"recoveredMinor": 123,
"recoverableMinor": 123,
"disputeReason": "<string>",
"disputedAt": "<string>",
"voidedAt": "<string>",
"voidReason": "<string>",
"legacy": true,
"legacyStatus": "<string>",
"legacySettled": true,
"revision": 123,
"createdAt": "<string>",
"lines": [
{
"id": "<string>",
"ordinal": 123,
"kind": "labour",
"description": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123
}
],
"payments": [
{
"id": "<string>",
"amountMinor": 123,
"paidOn": "<string>",
"reference": "<string>",
"legacy": true,
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"creditNotes": [
{
"id": "<string>",
"number": "<string>",
"issuedOn": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123,
"reason": "<string>",
"documentId": "<string>",
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"recoveries": [
{
"id": "<string>",
"amountMinor": 123,
"receivedOn": "<string>",
"reference": "<string>",
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"authorisation": {
"state": "within",
"basis": "approved_quote",
"authorisedMinor": 123,
"authorisedCurrency": "<string>",
"earlierMinor": 123,
"chargedMinor": 123,
"remainingMinor": 123,
"excessMinor": 123
},
"limitOverride": {
"id": "<string>",
"state": "<string>",
"basis": "<string>",
"authorisedMinor": 123,
"authorisedCurrency": "<string>",
"earlierMinor": 123,
"chargedMinor": 123,
"excessMinor": 123,
"reason": "<string>",
"userId": "<string>",
"createdAt": "<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
Accept invoice suggestion
Record an invoice that had no job against the job a person chose, through that job’s own invoice command
POST
/
maintenance-pro
/
suggestions
/
{id}
/
accept-invoice
Accept invoice suggestion
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/suggestions/{id}/accept-invoice \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"job": {
"id": "<string>"
},
"invoice": {
"number": "<string>",
"issuedOn": "<string>",
"lines": [
{
"description": "<string>",
"netMinor": 0,
"vatMinor": 0
}
],
"dueOn": "<string>",
"currency": "<string>",
"contractorContactId": "<string>",
"documentId": "<string>",
"tenancyId": "<string>",
"chargePropertyId": "<string>",
"paidOn": "<string>",
"paidReference": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
job: {id: '<string>'},
invoice: {
number: '<string>',
issuedOn: '<string>',
lines: [{description: '<string>', netMinor: 0, vatMinor: 0}],
dueOn: '<string>',
currency: '<string>',
contractorContactId: '<string>',
documentId: '<string>',
tenancyId: '<string>',
chargePropertyId: '<string>',
paidOn: '<string>',
paidReference: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/suggestions/{id}/accept-invoice', 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/suggestions/{id}/accept-invoice"
payload = {
"requestId": "<string>",
"job": { "id": "<string>" },
"invoice": {
"number": "<string>",
"issuedOn": "<string>",
"lines": [
{
"description": "<string>",
"netMinor": 0,
"vatMinor": 0
}
],
"dueOn": "<string>",
"currency": "<string>",
"contractorContactId": "<string>",
"documentId": "<string>",
"tenancyId": "<string>",
"chargePropertyId": "<string>",
"paidOn": "<string>",
"paidReference": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"suggestion": {
"state": "not_included",
"note": "<string>",
"id": "<string>",
"kind": "contractor-suitability",
"subjectKind": "<string>",
"subjectId": "<string>",
"result": {
"kind": "contractor-suitability",
"contractor": {
"status": "suggested",
"note": "<string>",
"stated": [
{
"id": "<string>",
"label": "<string>",
"phrase": "<string>"
}
],
"contractors": [
{
"contractorId": "<string>",
"name": "<string>",
"status": "suggested",
"rank": 123,
"overall": 123,
"note": "<string>",
"capabilities": [
{
"id": "<string>",
"label": "<string>",
"state": "fits",
"evidence": "<string>",
"note": "<string>"
}
]
}
],
"notRanked": [
{
"contractorId": "<string>",
"name": "<string>",
"reason": "<string>"
}
]
},
"inspection": {
"status": "suggested",
"note": "<string>",
"findings": [
{
"findingId": "<string>",
"label": "<string>",
"status": "suggested",
"sentences": [
{
"partKey": "<string>",
"text": "<string>",
"status": "suggested",
"kindLabel": "<string>",
"note": "<string>"
}
]
}
],
"suggestedFindingIds": [
"<string>"
],
"truncated": true
},
"invoice": {
"status": "suggested",
"note": "<string>",
"suggestedJob": {
"kind": "repair",
"id": "<string>",
"label": "<string>",
"propertyId": "<string>",
"blockId": "<string>",
"contractorContactId": "<string>"
},
"confidence": 123,
"descriptionMismatch": true,
"possibleDuplicate": true,
"alreadyInvoiced": true,
"current": {
"jobId": "<string>",
"label": "<string>",
"levelLabel": "<string>",
"credible": true,
"mismatch": true,
"duplicate": true,
"alreadyInvoiced": true,
"existingInvoiceNumber": "<string>"
},
"otherJobSuggested": true,
"candidates": [
{
"kind": "repair",
"id": "<string>",
"label": "<string>",
"levelLabel": "<string>",
"credible": true,
"existingInvoiceNumber": "<string>",
"current": true
}
]
}
},
"reviews": [
{
"item": "<string>",
"decision": "accepted",
"recordKind": "<string>",
"recordId": "<string>",
"reviewedByUserId": "<string>",
"note": "<string>",
"createdAt": "<string>"
}
],
"partCount": 123,
"failedParts": 123,
"retrying": true,
"canRetry": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"invoice": {
"id": "<string>",
"subjectKind": "<string>",
"subjectId": "<string>",
"subjectLabel": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"tenancyId": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"number": "<string>",
"issuedOn": "<string>",
"dueOn": "<string>",
"currency": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123,
"borneBy": "landlord",
"documentId": "<string>",
"status": "received",
"approvedAt": "<string>",
"creditedMinor": 123,
"paidMinor": 123,
"outstandingMinor": 123,
"disputedMinor": 123,
"payableMinor": 123,
"recoveredMinor": 123,
"recoverableMinor": 123,
"disputeReason": "<string>",
"disputedAt": "<string>",
"voidedAt": "<string>",
"voidReason": "<string>",
"legacy": true,
"legacyStatus": "<string>",
"legacySettled": true,
"revision": 123,
"createdAt": "<string>",
"lines": [
{
"id": "<string>",
"ordinal": 123,
"kind": "labour",
"description": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123
}
],
"payments": [
{
"id": "<string>",
"amountMinor": 123,
"paidOn": "<string>",
"reference": "<string>",
"legacy": true,
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"creditNotes": [
{
"id": "<string>",
"number": "<string>",
"issuedOn": "<string>",
"netMinor": 123,
"vatMinor": 123,
"grossMinor": 123,
"reason": "<string>",
"documentId": "<string>",
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"recoveries": [
{
"id": "<string>",
"amountMinor": 123,
"receivedOn": "<string>",
"reference": "<string>",
"createdAt": "<string>",
"correctedAt": "<string>",
"correctionReason": "<string>"
}
],
"authorisation": {
"state": "within",
"basis": "approved_quote",
"authorisedMinor": 123,
"authorisedCurrency": "<string>",
"earlierMinor": 123,
"chargedMinor": 123,
"remainingMinor": 123,
"excessMinor": 123
},
"limitOverride": {
"id": "<string>",
"state": "<string>",
"basis": "<string>",
"authorisedMinor": 123,
"authorisedCurrency": "<string>",
"earlierMinor": 123,
"chargedMinor": 123,
"excessMinor": 123,
"reason": "<string>",
"userId": "<string>",
"createdAt": "<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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Path Parameters
Body
application/json