Consultar municipio
GET /api/catalogos/municipio/{id}/
Municipio de Colombia, código DANE de 5 dígitos, con su departamento. El id es la posición del código en orden y es el mismo en todos los entornos. codigo_postal no es de la lista DIAN: es el de la cabecera municipal, del dataset de 4-72 en datos.gov.co.
Lista DIAN: Municipio. 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.municipio | id |
/api/emisores/emisor/ | municipio | codigo |
/api/nomina/empleado/ | municipio | id |
/api/nomina/nomina/ | empleado.municipio | id |
/api/nomina/nomina/ | lugar_trabajo_municipio | id |
operationId: catalogos_municipio_retrieve
Autenticación
Sección titulada «Autenticación»Cualquiera de estas credenciales:
Parámetros
Sección titulada «Parámetros»| Nombre | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id | path | integer (int64) | sí | Un valor único que identifique este municipio. |
Ejemplo
Sección titulada «Ejemplo»curl "https://api.rededoc.uk/api/catalogos/municipio/<id>/"Respuestas
Sección titulada «Respuestas»| Código | Descripción |
|---|---|
200 | |
404 | Error |
429 | Error |
200 — cuerpo
Sección titulada «200 — cuerpo»| Campo | Tipo | Descripción |
|---|---|---|
id | integer | Solo lectura. |
codigo | string | |
nombre | string | |
codigo_postal | string | El de la cabecera. Respalda el cbc:PostalZone del XML cuando el emisor o el adquiriente no informan el suyo. |
departamento | integer (int64) | Admite null. |
departamento_codigo | string | Solo lectura. |
activo | boolean |
{ "id": 1, "codigo": "texto", "nombre": "texto", "codigo_postal": "texto", "departamento": -9223372036854776000, "departamento_codigo": "", "activo": true}404 — cuerpo
Sección titulada «404 — 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" } ]}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.