Referencia
Recurso
Metadata
Estructura e introspección de modelos
2 endpoints · base https://stage03.env.clickbalance.net/api/v1
get
/metadataListar modelos disponibles
Retorna la lista de modelos habilitados para API con nombre, app, verbose_name y endpoint.
públicohttps://stage03.env.clickbalance.net/api/v1/metadata
Respuestas
200Lista de modelos
| Campo | Tipo | Descripción |
|---|---|---|
| data | object | — |
| data.models | object[] | — |
| data.models[].model | string | — |
| data.models[].app | string | — |
| data.models[].verbose_name | string | — |
| data.models[].endpoint | string | URL path en snake_case |
get
/metadata/{modelo}Estructura de un modelo
Retorna columnas, relaciones, admin config, capture fields y grid display.
públicohttps://stage03.env.clickbalance.net/api/v1/metadata/{modelo}
Parámetros
| Nombre | En | Tipo | Descripción |
|---|---|---|---|
| modelo* | path | string | Nombre del modelo en snake_case (ej: moneda, tipo_venta, comprobante) |
Respuestas
200Metadata del modelo
| Campo | Tipo | Descripción |
|---|---|---|
| data | object | — |
| data.model | string | — |
| data.app | string | — |
| data.table | string | — |
| data.columns | object | — |
| data.relations | object | — |
| data.admin | object | — |
| data.capture | object | — |
| data.grid | object | — |
400Modelo no encontrado o no habilitado
| Campo | Tipo | Descripción |
|---|---|---|
| data | null | — |
| meta | object | — |
| errors | object[] | — |
| errors[].code | string | — |
| errors[].message | string | — |
| errors[].field | string | — |