Saltar al contenido
Facturador

Provincias

GET /api/catalogs/provinces

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

Provincias del Perú (segundo nivel del ubigeo). Filtra por departamento con department_id.

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
department_id string No Id del departamento (15 = Lima). Sin él devuelve todas las provincias.
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.
department_id string Sí Departamento al que pertenece.
active boolean Sí true si la empresa lo tiene activo.

Errores:

  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
department_id query sí 15 Id del departamento.
all query no 1 1 = incluir también los registros inactivos (cada fila trae active). Por defecto solo activos.

Respuestas

{
  "success": true,
  "data": [
    {
      "id": "1508",
      "description": "HUAURA",
      "department_id": "15",
      "active": true
    },
    {
      "id": "1501",
      "description": "LIMA",
      "department_id": "15",
      "active": true
    },
    {
      "id": "1502",
      "description": "BARRANCA",
      "department_id": "15",
      "active": true
    }
  ]
}

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.