Apariencia
Anular retención
POST /api/Invoice/cancel_retention
Anula un comprobante de retención de IVA o de ISLR emitido por el negocio del token. La anulación marca el comprobante completo (todas sus líneas) como Anulada y devuelve el enlace al PDF anulado.
Autenticación: Authorization: Bearer <token> (cómo obtenerlo) · Content-Type: application/json
Cuerpo de la solicitud
| Campo | Tipo | Obligatorio | Descripción y reglas |
|---|---|---|---|
numero_comprobante | string | Sí | Número de comprobante tal como lo devolvió la emisión o la consulta (AAAAMM + correlativo, p. ej. 20260700000012). Se eliminan los caracteres que no sean letras o números; el resultado debe tener al menos 7 caracteres. |
numero_control | string | Sí | Número de control del comprobante, exactamente como fue asignado (p. ej. 00-00000070). |
tipo_documento | string | Sí | IVA o ISLR (no distingue mayúsculas; se ignoran espacios al inicio y al final). |
Los nombres de las claves no distinguen mayúsculas (NUMERO_COMPROBANTE también se acepta).
Ejemplo de solicitud
json
{
"numero_comprobante": "20260700000012",
"numero_control": "00-00000070",
"tipo_documento": "IVA"
}Respuesta exitosa
HTTP 200
json
{
"success": true,
"message": "La retención de IVA ha sido anulada correctamente.",
"pdf": [
"https://<servidor>/readonly/exportPdf/MTIzfDl8NnxDTElFTlRFIEVKRU1QTE8..."
],
"details": {
"numero_comprobante": "20260700000012",
"numero_control": "00-00000070",
"tipo_documento": "IVA",
"periodo": "202607"
}
}| Clave | Descripción |
|---|---|
success | true. |
message | Confirmación; menciona el tipo (IVA o ISLR). |
pdf | Enlace al PDF del comprobante con estado anulado. |
details | Eco de los datos recibidos y el período (AAAAMM) extraído del número de comprobante. |
Errores
| HTTP | Mensaje (ejemplo) | Causa |
|---|---|---|
| 401 | Token inválido o ausente. | Falta el encabezado Authorization o no tiene la forma Bearer <token>. |
| 401 | Usuario no autorizado. | Token inválido o expirado. Ver Errores. |
| 400 | El comercio indicado no existe. | El token no corresponde a un negocio. |
| 400 | Cuerpo JSON vacío. | No se envió cuerpo. |
| 400 | El JSON enviado es inválido o está mal formado. | Cuerpo mal formado. |
| 400 | Los campos numero_comprobante, numero_control y tipo_documento son obligatorios. | Falta alguno de los tres campos o está vacío. |
| 400 | El campo tipo_documento debe ser "IVA" o "ISLR". | Tipo no reconocido. |
| 400 | El formato del numero_comprobante es inválido. | Menos de 7 caracteres alfanuméricos. |
| 404 | La retención especificada no existe, los datos no coinciden, o no pertenece a su comercio. | No hay un comprobante de ese tipo con ese correlativo y ese número de control en el negocio. |
| 400 | El período del número de comprobante no coincide con la fecha de asignación de la retención. | Los 6 primeros dígitos (AAAAMM) no coinciden con el período del comprobante. |
| 400 | La retención ya se encuentra anulada. | El comprobante ya estaba anulado. |
| 500 | Error al intentar anular la retención en la base de datos. | Error interno al guardar. |
Notas
- Cómo se identifica el comprobante. Los 6 primeros caracteres de
numero_comprobanteson el período y el resto es el correlativo; ambos, junto connumero_controlytipo_documento, deben coincidir con un comprobante del negocio. - Irreversible desde el API. No existe un endpoint para revertir la anulación. El número de control usado no se libera.
- No idempotente. Una segunda anulación del mismo comprobante responde
400conLa retención ya se encuentra anulada. - Tras anular, el comprobante aparece con
status: "Anulada"en Consultar retenciones de IVA o de ISLR. - A diferencia de la emisión, aquí
pdfes un arreglo plano de enlaces (no un arreglo de arreglos).
