Buzón Tributario (Inbox) del Contribuyente

Este endpoint permite la consulta directa y síncrona del historial de alertas y notificaciones oficiales recibidas por un contribuyente en su buzón tributario. La consulta se realiza a través del ID interno del contribuyente.

Detalles Técnicos

Endpoint y Método

• Método: GET
• Endpoint: /taxpayer/{taxpayerId}/inbox

Parámetro de Ruta

• (string): El ID interno del contribuyente asociado a la organización (ej. 8198fb21-b64b-43c1-8549-f8d94d62998e)

Headers Requeridos

• x-api-key: [Tu Clave] - Tu llave de acceso al servicio

Body/Payload

No Aplica. Es una consulta GET.

Código de Ejemplo

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://staging-api.taxo.ws/taxpayer/8198fb21-b64b-43c1-8549-f8d94d62998e/inbox',
  headers: { 
    'x-api-key': 'tu_api_key'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Respuesta de la solicitud

La respuesta devuelve un objeto que contiene los listados de alertas y notificaciones recibidas por el contribuyente:

{
  "status": "success",
  "data": {
    "alerts": [
      {
        "codigoDocumentoBuzon": 627473775,
        "fechaGeneracion": "2025-11-07",
        "descripcion": "Comprobantes Electrónicos - Solicitud atendida",
        "valoresPantillaXML": [],
        "esLeida": "SI"
      }
    ],
    "notices": [],
    "totalNotifications": 1
  }
}

Campos de la Respuesta

• status (string): "success"
• data.alerts (array): Lista de objetos, donde cada uno representa una alerta o mensaje del buzón
• data.alerts.codigoDocumentoBuzon (integer): ID único del mensaje en el buzón
• data.alerts.fechaGeneracion (string): Fecha de emisión del mensaje (formato AAAA-MM-DD)
• data.alerts.descripcion (string): El título del mensaje o alerta
• data.alerts.esLeida (string): Indica si el mensaje ha sido marcado como leído ("SI" o null)
• data.totalNotifications (integer): Un contador de las notificaciones importantes (o no leídas) para un vistazo rápido

Código de Respuesta HTTP

200 OK: Es el código estándar para una consulta síncrona exitosa que devuelve el recurso solicitado inmediatamente.