Vodett API← vodett.ai

Errors

Errors use a consistent JSON envelope:

{ "detail": { "code": "PLAN_PATIENT_LIMIT", "message_key": "subscriptions.patient_limit" } }
StatusCodeDescription
401API_KEY_INVALIDMissing, invalid, or revoked API key.
402SUBSCRIPTION_REQUIREDThe clinic has no active subscription.
403PLAN_PATIENT_LIMITThe clinic's plan patient limit is reached.
404PATIENT_NOT_FOUNDNo patient with that id in this clinic.
422PATIENT_CONTACT_REQUIREDEmail and mobile are both required when creating a patient.
422DOCUMENT_TYPE_INVALIDThe document type is not a valid category.
422(validation)A required field is missing or invalid.
429RATE_LIMITEDToo many requests; retry after the Retry-After seconds.
400PAYMENT_METHOD_INVALIDThe payment method is not one of cash/card/bank/other.
400PAYMENT_INVOICE_NOT_PAYABLEThe invoice is not issued, or is already paid/void.
400PAYMENT_EXCEEDS_BALANCEThe amount is more than the invoice's outstanding balance.
402MODULE_NOT_IN_PLANThe clinic's plan doesn't include the required module (billing/payments).

OpenAPI

Machine-readable spec: https://api.vodett.ai/api/public/v1/openapi.json