Cancel a claim request that is stuck

Operations in Claims

POST /api/v1/invoices/{invoiceId}/claim/cancel

It doesn't contact the insurer: use it for a request that never came back.

The integration client needs CLAIMS:EXECUTE. A practice owner grants it under Permissions on the client.

Request

curl Node.js Python

curl -X POST 'https://dashboard.practor.app/api/v1/invoices/i2q6w8e0r4t7y1u3o5p9a6sd/claim/cancel' \
  -H "Authorization: Bearer $PRACTOR_API_KEY"

const response = await fetch("https://dashboard.practor.app/api/v1/invoices/i2q6w8e0r4t7y1u3o5p9a6sd/claim/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PRACTOR_API_KEY}`,
  },
});
const resource = await response.json();

import os, uuid
import requests

response = requests.post(
    "https://dashboard.practor.app/api/v1/invoices/i2q6w8e0r4t7y1u3o5p9a6sd/claim/cancel",
    headers={
        "Authorization": f"Bearer {os.environ['PRACTOR_API_KEY']}",
    },
)
resource = response.json()

Response 200

{
  "object": "claim",
  "id": "m3k8j5h2g9f6d3s0a7p4o1iu",
  "invoiceId": "i2q6w8e0r4t7y1u3o5p9a6sd",
  "status": "partially_accepted",
  "outcome": "partial",
  "message": null,
  "resubmittable": false,
  "reversible": true,
  "authorizationReference": null,
  "submittedAt": "2026-10-01T08:00:00.000Z",
  "currency": "ZAR",
  "items": [
    {
      "lineNumber": 1,
      "lineItemId": "l8k5j2h9g6f3d0s7a4q1w8ez",
      "decision": "approved_with_warning",
      "submitted": 45000,
      "benefit": 40000,
      "rejections": [],
      "warnings": [
        {
          "code": "306",
          "description": "Tariff paid at scheme rate"
        }
      ]
    }
  ]
}

Parameters

Path

invoiceId string Required: The invoice's id.

Responses

200 Done. Where an invoice's claim stands with the insurer, line by line.

Headers

X-Request-Id string Required: Quote it if you contact support about this request.
X-RateLimit-Limit string Required: Requests allowed in the current window.
X-RateLimit-Remaining string Required: Requests left in the current window.
X-RateLimit-Reset string Required: When the window resets, in seconds since the Unix epoch.

Body

Claim

object "claim" Required
id string Required
invoiceId string Required
status string Required
One of submitting, accepted, rejected, partially_accepted, reversed, reversal_failed, reversing.
outcome string Required
queued while the insurer has not answered, complete when every line was accepted, partial when some were, error when it was refused.

One of queued, complete, partial, error.
message string or null Required
The insurer's reason when the claim or its reversal failed, or why it was not sent.
resubmittable boolean Required
Whether POST /invoices/{invoiceId}/claim/resubmit would be taken: the claim was rejected or reversed.
reversible boolean Required
Whether POST /invoices/{invoiceId}/claim/reverse would be taken: the insurer accepted some or all of it, or a reversal failed.
authorizationReference string or null Required
submittedAt string or null Required
currency string Required
ISO 4217 currency code. Every amount on the resource is in it.
items array of object Required
- lineNumber integer Required
  The invoice line's position, 1 first.
  
  At least -9007199254740991. At most 9007199254740991.
- lineItemId string or null Required
- decision string Required
  One of approved, approved_with_warning, denied.
- submitted integer or null Required
- benefit integer or null Required
- rejections array of object Required
  
  code string Required
  description string Required
- warnings array of object Required
  
  code string Required
  description string Required

Example 200 body

{
  "object": "claim",
  "id": "m3k8j5h2g9f6d3s0a7p4o1iu",
  "invoiceId": "i2q6w8e0r4t7y1u3o5p9a6sd",
  "status": "partially_accepted",
  "outcome": "partial",
  "message": null,
  "resubmittable": false,
  "reversible": true,
  "authorizationReference": null,
  "submittedAt": "2026-10-01T08:00:00.000Z",
  "currency": "ZAR",
  "items": [
    {
      "lineNumber": 1,
      "lineItemId": "l8k5j2h9g6f3d0s7a4q1w8ez",
      "decision": "approved_with_warning",
      "submitted": 45000,
      "benefit": 40000,
      "rejections": [],
      "warnings": [
        {
          "code": "306",
          "description": "Tariff paid at scheme rate"
        }
      ]
    }
  ]
}

400 A query parameter or header is missing or malformed, or the body isn't JSON. errors names the parameter.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 400 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

401 No key was sent, or the key cannot be used: unknown, revoked or expired, its client suspended, or the call made from outside its allowed addresses. All of these answer the same way; the practice audit log names which it was.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 401 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

403 The client lacks the permission this endpoint needs, or the practice's Integrations add-on is off.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 403 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

404 The record doesn't exist in this practice. A record in another practice answers the same way.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 404 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

405 This endpoint doesn't take that method. The Allow header names the one it does.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 405 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

409 The record conflicts with one that exists (detail names it), or a request with the same Idempotency-Key is still running. Wait a moment and retry.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 409 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

413 The body is larger than 256 KB.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 413 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

415 The body wasn't sent as application/json. Set the Content-Type header.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 415 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

422 The body is valid JSON but breaks a rule, or the Idempotency-Key was used with a different body. errors lists every field that is missing or wrong, all at once.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 422 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

429 Too many requests. Wait the number of seconds in the Retry-After header, then send it again.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 429 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

500 Something went wrong on our side. Quote the X-Request-Id if you contact support.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 500 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

503 The request couldn't be written to the practice audit log, so its result is withheld. Wait the number of seconds in the Retry-After header, then send it again.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 503 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}