Listar departamentos
GET /api/catalogos/departamento/
Departamento de Colombia, código DANE de 2 dígitos. El id es la posición del código en orden (05 Antioquia = 1 … 99 Vichada = 33) y es el mismo en todos los entornos.
Lista DIAN: Departamentos. Anexo técnico: Factura Electrónica de Venta v1.9 (Resolución 000165 de 2023).
Campos que reciben sus valores:
| Ruta | Campo | Se envía |
|---|---|---|
/api/documentos/documento/ | adquiriente.departamento | id |
/api/emisores/emisor/ | departamento | codigo |
/api/nomina/empleado/ | departamento | id |
/api/nomina/nomina/ | empleado.departamento | id |
/api/nomina/nomina/ | lugar_trabajo_departamento | id |
Paginado; search busca por código y nombre.
operationId: catalogos_departamento_list
Autenticación
Sección titulada «Autenticación»Cualquiera de estas credenciales:
Parámetros
Sección titulada «Parámetros»| Nombre | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
page | query | integer | no | Un número de página dentro del conjunto de resultados paginado. |
search | query | string | no | Un término de búsqueda. |
Ejemplo
Sección titulada «Ejemplo»curl "https://api.rededoc.uk/api/catalogos/departamento/"Respuestas
Sección titulada «Respuestas»| Código | Descripción |
|---|---|
200 | |
429 | Error |
200 — cuerpo
Sección titulada «200 — cuerpo»| Campo | Tipo | Descripción |
|---|---|---|
count | integer | |
next | string (uri) | Admite null. |
previous | string (uri) | Admite null. |
results | array<ElementoCatalogo> |
{ "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": 1, "codigo": "texto", "nombre": "texto", "activo": true } ]}429 — cuerpo
Sección titulada «429 — cuerpo»| Campo | Tipo | Descripción |
|---|---|---|
detail | string | Mensaje para mostrar a la persona. |
errores | array<object> | Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio. |
{ "detail": "texto", "errores": [ { "codigo": "texto", "mensaje": "texto" } ]}RedEDoc es un servicio de Semántica Digital S.A.S.