Apariencia
Enviar documento fiscal
POST /api/Invoice/send_document
Envía por correo electrónico un documento fiscal ya emitido por el negocio del token (factura, nota de crédito o débito, orden de entrega, guía de despacho o comprobante de retención). Por defecto se envía al correo registrado del cliente; puedes indicar otro destinatario. Devuelve el correo al que se envió.
Autenticación: Authorization: Bearer <token> (cómo obtenerlo) · Content-Type: application/json
Cuerpo de la solicitud
Los nombres de campo no distinguen mayúsculas/minúsculas.
| Campo | Tipo | Obligatorio | Descripción y reglas |
|---|---|---|---|
tipo_documento | string | Sí | Tipo de documento a enviar. Ver la tabla de valores aceptados abajo. |
numero_documento | string | Condicional | Número del documento. Obligatorio si no envías numero_control. Para retenciones, puede ser el número de comprobante completo (por ejemplo 20260100000010). |
numero_control | string | Condicional | Número de control del documento (por ejemplo 00-00000456). Obligatorio si no envías numero_documento. |
correo | string | No | Correo destinatario. Si se omite, se usa el correo registrado del cliente del documento. |
Puedes enviar numero_documento y numero_control juntos para identificar el documento con más precisión; en ese caso deben coincidir ambos.
Valores de tipo_documento
El valor se compara sin distinguir mayúsculas y basta con que contenga el texto indicado. También se acepta el código numérico.
| Documento | Texto aceptado | Código |
|---|---|---|
| Factura | factura | 1 |
| Nota de crédito | nota de credito / nota de crédito | 2 |
| Nota de débito | nota de debito / nota de débito | 3 |
| Orden de entrega | orden de entrega | 4 |
| Guía de despacho | guia de despacho / guía de despacho | 6 |
| Comprobante de retención ISLR | texto que contenga islr | 7 |
| Comprobante de retención IVA | texto que contenga iva | 8 |
Ejemplo de solicitud
json
{
"tipo_documento": "factura",
"numero_documento": "00000123",
"numero_control": "00-00000456",
"correo": "cliente@example.com"
}Respuesta exitosa
HTTP 200
json
{
"success": true,
"message": "El documento fue enviado exitosamente por correo electrónico.",
"correo_receptor": "cliente@example.com"
}| Clave | Descripción |
|---|---|
success | true si el correo se envió. |
message | Mensaje de confirmación. |
correo_receptor | Correo al que se envió el documento. |
Errores
| HTTP | Mensaje (ejemplo) | Causa |
|---|---|---|
| 400 | Cuerpo JSON vacío. | No se envió cuerpo. |
| 400 | El JSON enviado es inválido o está mal formado. | El cuerpo no es JSON válido. |
| 400 | tipo_documento es requerido, y debe enviar al menos numero_documento o numero_control. | Falta tipo_documento, o faltan ambos identificadores. |
| 400 | Tipo de documento no reconocido. | tipo_documento no coincide con ningún valor de la tabla. |
| 404 | El documento no fue encontrado o no pertenece a este comercio. | No existe un documento de ese tipo con esos datos en el negocio del token. |
| 400 | El cliente asociado al documento no existe. | El cliente del documento ya no está disponible. |
| 400 | No hay correo válido para enviar. Provea uno en la petición o registre uno al cliente. | No se envió correo y el cliente no tiene correo registrado. |
| 400 | El comercio indicado no existe. | El negocio asociado al token no existe. |
| 401 | Token inválido o ausente. | Falta el encabezado Authorization o no tiene el formato Bearer <token>. |
| 401 | Usuario no autorizado. / ver Errores | Token inválido o expirado. |
| 500 | Hubo un fallo en los servidores de correo al intentar procesar el envío. | El servidor de correo no pudo enviar el mensaje. Puedes reintentar. |
| 500 | Error en el servidor: ... | Error interno. |
Notas
- El documento queda marcado como enviado (con fecha de envío) en el panel del negocio.
- Puedes llamar al endpoint varias veces para reenviar el mismo documento; cada llamada envía un correo nuevo.
- El correo indicado en
correono se valida en formato; asegúrate de enviar una dirección válida. - El asunto del correo tiene la forma
Factura #<número> from <nombre del negocio>(o el tipo de documento correspondiente). - Si envías solo
numero_control(o solonumero_documento) y hubiera más de un documento que coincida, se envía el primero encontrado; envía ambos cuando los tengas.
