Saltar al contenido
Facturador

Distritos (ubigeo)

GET /api/catalogs/districts

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Distritos de una provincia. El id del distrito es el ubigeo de 6 dígitos que se envía en district_id / ubigeo.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).

Formato de respuesta: estándar {success, data, message?} (registro único). Aquí data es la lista completa (sin paginación ni pagination): son catálogos cortos.

Activos e inactivos: por defecto solo devuelve los registros activos de la empresa (los que se ofrecen en los formularios del sistema). Envía all=1 para incluir también los inactivos; cada fila trae active para distinguirlos. Un código inactivo puede ser rechazado al registrar comprobantes: usa siempre los activos.

Parámetros de la URL (query):

Campo Tipo Obligatorio Descripción / valores permitidos
province_id string (4) Sí Id de la provincia (1501 = Lima). Obligatorio.
all 0 / 1 No 1 = incluir inactivos.

Campos de cada fila de data:

Campo Tipo Obligatorio Descripción / valores permitidos
id string Sí Código a enviar en el campo correspondiente del comprobante / registro.
description string Sí Descripción para mostrar al usuario.
province_id string Sí Provincia a la que pertenece.
active boolean Sí true si la empresa lo tiene activo.

Errores:

  • 422 {success: false, message: {province_id: [...]}} si falta province_id o no tiene 4 caracteres.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
province_id query sí 1501 Id de la provincia (obligatorio).
all query no 1 1 = incluir también los registros inactivos (cada fila trae active). Por defecto solo activos.

Respuestas

{
  "success": true,
  "data": [
    {
      "id": "150101",
      "description": "LIMA",
      "province_id": "1501",
      "active": true
    },
    {
      "id": "150122",
      "description": "MIRAFLORES",
      "province_id": "1501",
      "active": true
    },
    {
      "id": "150131",
      "description": "SAN ISIDRO",
      "province_id": "1501",
      "active": true
    },
    {
      "id": "150140",
      "description": "SANTIAGO DE SURCO",
      "province_id": "1501",
      "active": true
    }
  ]
}

422 — Falta province_id

{
  "success": false,
  "message": {
    "province_id": [
      "El campo province id es obligatorio."
    ]
  }
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.