List Insurance Plans
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
page | query | integer | No |
page_size | query | integer | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PagedResponse_InsurancePlanOut_ |
| 422 | Error de validación | HTTPValidationError |
Create Insurance Plan
Cuerpo obligatorio InsurancePlanCreateIn
| Campo | Tipo | Obl. |
|---|
code | string | Sí |
name | string | Sí |
provider_name | string | Sí |
is_active | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | InsurancePlanOut |
| 422 | Error de validación | HTTPValidationError |
List Managed Plans
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
page | query | integer | No |
page_size | query | integer | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PagedResponse_PlanOut_ |
| 422 | Error de validación | HTTPValidationError |
Create Managed Plan
Cuerpo obligatorio PlanCreate
| Campo | Tipo | Obl. |
|---|
code | string | Sí |
name | string | Sí |
monthly_price_cents | integer | No |
annual_price_cents | integer | No |
module_keys | lista de string | Sí |
max_branches | integer | No |
max_users | integer | No |
max_doctors | integer | No |
max_patients | integer | No |
is_active | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | PlanOut |
| 422 | Error de validación | HTTPValidationError |
Update Managed Plan
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
plan_id | path | string | Sí |
Cuerpo obligatorio PlanUpdate
| Campo | Tipo | Obl. |
|---|
name | string o nulo | No |
monthly_price_cents | integer o nulo | No |
annual_price_cents | integer o nulo | No |
module_keys | lista de string o nulo | No |
max_branches | integer o nulo | No |
max_users | integer o nulo | No |
max_doctors | integer o nulo | No |
max_patients | integer o nulo | No |
is_active | boolean o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PlanOut |
| 422 | Error de validación | HTTPValidationError |
List Managed Tenants
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
page | query | integer | No |
page_size | query | integer | No |
search | query | string o nulo | No |
status | query | string o nulo | No |
clientType | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | TenantListOut |
| 422 | Error de validación | HTTPValidationError |
Create Managed Tenant
Cuerpo obligatorio TenantCreateIn
| Campo | Tipo | Obl. |
|---|
slug | string | Sí |
name | string | Sí |
commercial_name | string | Sí |
email | string (email) | Sí |
phone | string | Sí |
client_type | string | Sí |
is_active | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | TenantOut |
| 422 | Error de validación | HTTPValidationError |
GET/v1/tenants/{tenant_id}Get Managed Tenant
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | TenantDetailOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/v1/tenants/{tenant_id}Update Managed Tenant
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
Cuerpo obligatorio TenantUpdateIn
| Campo | Tipo | Obl. |
|---|
slug | string o nulo | No |
name | string o nulo | No |
commercial_name | string o nulo | No |
email | string (email) o nulo | No |
phone | string o nulo | No |
client_type | string o nulo | No |
description | string o nulo | No |
city | string o nulo | No |
website | string o nulo | No |
logo_url | string o nulo | No |
services_offered | lista de string o nulo | No |
is_active | boolean o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | TenantOut |
| 422 | Error de validación | HTTPValidationError |
GET/v1/tenants/{tenant_id}/modulesList Managed Tenant Modules
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
page | query | integer | No |
page_size | query | integer | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PagedResponse_TenantModuleListOut_ |
| 422 | Error de validación | HTTPValidationError |
PATCH/v1/tenants/{tenant_id}/modulesBulk Update Managed Tenant Modules
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
Cuerpo obligatorio TenantModuleBulkUpdateIn
| Campo | Tipo | Obl. |
|---|
modules | lista de TenantModuleBulkItemIn | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de TenantModuleListOut |
| 422 | Error de validación | HTTPValidationError |
GET/v1/tenants/{tenant_id}/subscriptionGet Managed Subscription
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | TenantSubscriptionOut o nulo |
| 422 | Error de validación | HTTPValidationError |
POST/v1/tenants/{tenant_id}/subscriptionAssign Managed Subscription
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | path | string | Sí |
Cuerpo obligatorio TenantSubscriptionAssignIn
| Campo | Tipo | Obl. |
|---|
plan_code | string o nulo | No |
plan_id | string o nulo | No |
status | string | No |
expires_at | string (date-time) o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | TenantSubscriptionOut |
| 422 | Error de validación | HTTPValidationError |