Nota de crédito electrónica

Endpoint
PUT /api/2.0/documentos-electronicos/emision/nota-credito/{clave}

Emite una nota de crédito electrónica con la disposición 4.4 sobre un documento ya emitido. A diferencia de la factura y el tiquete, este endpoint usa el método PUT y la clave del documento de referencia viaja en la URL, no en el cuerpo.

La nota de crédito hereda al receptor, la moneda y el tipo de cambio del documento de referencia. Esos campos se ignoran si se envían en el cuerpo. Ver la sección «Datos heredados».

Autenticación

Todas las peticiones requieren los cuatro encabezados siguientes.

Encabezado	Descripción
api-token	Token de API de la cuenta.
access-token	Token de acceso asociado al api-token.
Content-Type	application/json
Accept	application/json. Obligatorio. Si se omite, una petición no autenticada responde con una redirección al formulario de inicio de sesión en lugar de un error JSON.

La emisión por API requiere un plan con acceso a API activo y documentos disponibles en el ciclo vigente.

Documento de referencia

El segmento {clave} de la URL es la clave numérica de 50 dígitos del documento que se desea corregir o anular. El documento debe pertenecer a la misma cuenta que emite la nota; no es posible referenciar comprobantes de otro contribuyente.

PUT /api/2.0/documentos-electronicos/emision/nota-credito/50622032000070175094601000001010000000006118491223

Ejemplo mínimo

curl --location --request PUT 'https://app.facturadorvirtual.com/api/2.0/documentos-electronicos/emision/nota-credito/50622032000070175094601000001010000000006118491223' \
--header 'api-token: iuJPbVCYQY3AmWuVHMflT9ZySlwzxb9ehviLbHNsz6yQnBm4' \
--header 'access-token: IDq4ME4ZUO9YmQ0fOc43AFp7mMO6talIuIALFaUUcs2H2pwLpYN2' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "actividad": "014002",
    "razon": "01",
    "condicion_venta": "01",
    "medio_pago": {
        "01": {
            "codigo": "01",
            "total": 1130
        }
    },
    "comentarios": "Anulación de la factura de referencia",
    "lineas": [
        {
            "codigo": "00001",
            "codigoCabys": "0196109000000",
            "descripcion": "Entrada a CRFW22",
            "cantidad": "1",
            "unidad": "Unid",
            "descuento": 0,
            "naturalezaDescuento": "",
            "precioUnitario": 1000,
            "impuestos": {
                "01": {
                    "tarifa": "08"
                }
            }
        }
    ]
}'

Datos heredados del documento de referencia

Los siguientes datos se toman del documento referenciado y no se leen del cuerpo de la petición. Enviarlos no produce error, pero tampoco tiene efecto.

Dato	Origen
Identificación, tipo de identificación, nombre, nombre comercial, teléfono y correo del receptor	Documento de referencia
Ubicación del receptor (provincia, cantón, distrito, barrio, otras señas)	Documento de referencia, si lo tenía registrado
moneda	Resumen del documento de referencia
tipo_cambio	Resumen del documento de referencia

Por esa razón los campos cedula, tipo_cedula, nombre, correo, telefono, moneda y tipo_cambio no aparecen entre los campos aceptados de este endpoint.

Campos del documento

Obligatorios

Campo	Tipo	Descripción
actividad	string	Código de la actividad económica del emisor. Debe estar registrada en la cuenta.
razon	string	Código de la razón de la nota. Ver la tabla más abajo.
medio_pago	object	De 1 a 4 medios de pago. Se ignora cuando la condición de venta es a crédito.
lineas	array	Al menos una línea de detalle. Ver la sección correspondiente.

Opcionales

Campo	Tipo	Descripción
condicion_venta	string	Código de condición de venta de la nota. Ver la tabla más abajo.
razon_referencia	string	Descripción de la razón. Si se omite, se usa el texto correspondiente al código enviado en razon.
sin_receptor	boolean	Exclusivo de la nota de crédito. Con valor verdadero, la nota se emite sin datos del receptor, aunque el documento de referencia los tuviera.
codigo_actividad_receptor	string	Código de actividad económica del receptor.
sucursal	string	Código de sucursal, por ejemplo 004. Si se omite, se usa el valor configurado en las preferencias de facturación.
punto	string	Punto de emisión, por ejemplo 00001. Si se omite, se usa el valor configurado en las preferencias de facturación.
comentarios	string	Notas del comprobante. Si el texto contiene un patrón #codigo, ese valor se registra además como número de orden.
orden	string u object	Número de orden asociado. Acepta un string con el código, o un objeto {"codigo": "...", "estado": "...", "proveedor": "..."}.
devolucion	number	Monto de devolución de IVA, mayor que cero.
cargos	array	Otros cargos del comprobante.

Campos condicionales

Campo	Se vuelve obligatorio cuando…	Reglas
plazo_credito	condicion_venta es 02 o 10	Entero entre 1 y 99999, expresado en días.
condicion_venta_otros	condicion_venta es 99	Texto entre 5 y 100 caracteres.
medio_pago.<codigo>.detalle	El código del medio de pago es 99	Texto entre 3 y 100 caracteres.

Razón de la nota

Código	Descripción
01	Para anular documento de referencia
02	Por corrección de texto
03	Por corrección de monto

Para anular por completo una factura sin reconstruir el detalle, conviene usar el endpoint de anulación descrito al final de esta página, que arma la nota a partir del documento original.

Condición de venta

Código	Descripción
01	Contado
02	Crédito
03	Consignación
04	Apartado
05	Arrendamiento con opción de compra
06	Arrendamiento en función financiera
07	Cobro a favor de un tercero
08	Servicios prestados al Estado
09	Pago de servicios prestados al Estado
10	Venta a crédito en IVA hasta 90 días
11	Pago de venta a crédito en IVA hasta 90 días
12	Venta de mercancía no nacionalizada
13	Venta de bienes usados no contribuyente
14	Arrendamiento operativo
15	Arrendamiento financiero
99	Otros. Requiere condicion_venta_otros.

Con las condiciones de venta 02, 08 y 10 el comprobante se emite a crédito y los medios de pago enviados se descartan: el XML no incluye el nodo de medio de pago. Aun así el campo medio_pago debe venir presente en la petición.

Medios de pago

medio_pago es un objeto con hasta cuatro entradas, donde la clave y el campo codigo coinciden. total es el monto cubierto por ese medio y debe ser mayor que cero.

"medio_pago": {
    "01": { "codigo": "01", "total": 130 },
    "02": { "codigo": "02", "total": 400 },
    "03": { "codigo": "03", "total": 600 }
}

Código	Descripción
01	Efectivo
02	Tarjeta
03	Cheque
04	Transferencia o depósito bancario
05	Recaudado por terceros
06	SINPE Móvil
07	Plataforma digital
99	Otros. Requiere detalle.

Líneas de detalle

Campos obligatorios de la línea

Campo	Tipo	Descripción
codigo	string	Código del producto o servicio, máximo 20 caracteres.
descripcion	string	Detalle de la línea, entre 3 y 200 caracteres.
cantidad	number	Cantidad, mayor que cero. Se redondea a 3 decimales.
unidad	string	Código de unidad de medida del catálogo de Hacienda. Debe coincidir exactamente con un código del catálogo, por ejemplo Unid, Sp, Os, kgKg, L, Al, Alc.
precioUnitario	number	Precio unitario, mayor o igual a cero.
descuento	number	Monto del descuento. Envíe 0 si no aplica.
naturalezaDescuento	string	Naturaleza del descuento. Envíe cadena vacía si no aplica; si se envía texto, debe tener entre 3 y 80 caracteres.

codigoCabys no es rechazado por la validación, pero Hacienda exige el código CABYS en todos los comprobantes. Omitirlo produce un rechazo del lado de Hacienda, no del API.

Campos opcionales de la línea

Campo	Tipo	Descripción
codigoCabys	string	Código CABYS de 13 dígitos.
codigoInternoFV	string	Código del producto en el catálogo de Facturador Virtual.
id_producto	integer	Identificador del producto en Facturador Virtual.
unidadMedidaComercial	string	Unidad de medida comercial, máximo 20 caracteres.
partidaArancelaria	string	Partida arancelaria de la mercancía.
tipoTransaccion	string	Código de tipo de transacción de la versión 4.4.
tipoDescuento	string	Código del tipo de descuento, máximo 2 caracteres. Si se omite se asume 08. Con los códigos 01 y 03 el impuesto de la línea se registra como asumido por el emisor.
tipoDescuentoOtro	string	Descripción cuando tipoDescuento corresponde a «otros». Entre 5 y 100 caracteres.
ivaCobradoFabrica	number	IVA cobrado en fábrica.
vinSerie	string	Número VIN o serie, para vehículos.
esCabysMedicamento	boolean	Marca la línea como medicamento. Al activarse se toman registroMedicamento (máximo 100 caracteres) y formaFarmaceutica (3 caracteres).
es_combo	boolean	Marca la línea como combo. Los componentes se envían en componentes, un arreglo con la misma estructura de una línea de detalle.
impuestos	object	Impuestos aplicados a la línea. Ver la siguiente sección.

Impuestos

impuestos es un objeto cuya clave es el código del impuesto. El campo tarifa recibe el código de tarifa, no el porcentaje: el porcentaje se resuelve a partir de ese código.

"impuestos": {
    "01": {
        "tarifa": "08"
    }
}

Código de impuesto	Descripción
01	Impuesto al Valor Agregado
02	Impuesto Selectivo de Consumo
03	Impuesto Único a los Combustibles
04	Impuesto específico de Bebidas Alcohólicas
05	Impuesto Específico sobre las bebidas envasadas sin contenido alcohólico y jabones de tocador
06	Impuesto a los Productos de Tabaco
07	IVA (cálculo especial)
08	IVA Régimen de Bienes Usados (Factor)
12	Impuesto Específico al Cemento
99	Otros. Se describe en descripcionOtro.

Código de tarifa	Descripción	Porcentaje aplicado
01	Tarifa 0% (Artículo 32, num 1, RLIVA)	0
02	Tarifa reducida 1%	1
03	Tarifa reducida 2%	2
04	Tarifa reducida 4%	4
05	Transitorio 0%	0
06	Transitorio 4%	4
07	Tarifa transitoria 8%	8
08	Tarifa general 13%	13
09	Tarifa reducida 0.5%	0.5
10	Tarifa exenta	0
11	Tarifa 0% sin derecho a crédito	0

Para el impuesto 08 se envía además factor. Para los impuestos 03, 04, 05 y 06 pueden enviarse los datos específicos cantidadUnidadMedida, porcentaje, proporcion, volumenUnidadConsumo e impuestoUnidad. La exoneración se declara dentro del impuesto 01 con los campos exoneracionTipo, exoneracionNumero, exoneracionInstitucion, exoneracionFecha en formato dd/mm/aaaa y exoneracionTarifa.

Respuesta

Una emisión procesada devuelve HTTP 200. El campo codigo del cuerpo indica el resultado de la recepción en Hacienda y es independiente del código HTTP.

{
  "codigo": 200,
  "contenidoXml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iV…",
  "contenidoXmlFirmado": "Nfdsfffadeec2lvbj0iMS4wIiBlbmNvZGluZz0iV…",
  "documento": {
    "clave": "50622032000070175094601000001030000000007118491223",
    "consecutivo": "00400001030000000007",
    "recepcion": "recibido",
    "comprobacion": "por_comprobar"
  },
  "errores": []
}

La clave y el consecutivo devueltos corresponden a la nota de crédito recién emitida, no al documento de referencia. El tipo de documento 03 en la posición correspondiente identifica la nota de crédito.

Campo	Descripción
codigo	Resultado de la recepción en Hacienda. 200 si el documento fue recibido; 500 si no se pudo entregar.
contenidoXml	XML generado, codificado en base64.
contenidoXmlFirmado	XML firmado, codificado en base64. Es null cuando la firma o el envío no se completaron.
documento.clave	Clave numérica de 50 dígitos de la nota de crédito.
documento.consecutivo	Consecutivo de 20 dígitos de la nota de crédito.
documento.recepcion	Estado de la recepción: recibido o por_enviar.
documento.comprobacion	Estado de la comprobación: por_comprobar, aceptado o rechazado.
errores	Arreglo de objetos {"tipo": "...", "mensaje": "..."} devueltos por Hacienda.

Errores

HTTP	Cuerpo	Causa
302	Redirección al inicio de sesión	Falta el encabezado Accept: application/json en una petición no autenticada.
401	{"message": "Unauthenticated."}	api-token o access-token inválidos o ausentes.
403	{"error": "No posee un Plan Api activo"}	El plan de la cuenta no incluye acceso a API.
403	{"error": "Ha llegado al límite de facturas del Plan Api contratado"}	Se agotaron los documentos del ciclo vigente.
422	{"errors": {"campo": ["mensaje"]}}	Uno o más campos no cumplen las reglas de validación.
500	{"0": "Ha ocurrido un error", "error": "...", "stack": [...]}	Error no controlado. Incluye el caso de una clave de referencia inexistente o perteneciente a otra cuenta: la búsqueda del documento lanza una excepción en lugar de devolver un mensaje de «no encontrado».

Verifique que la clave del documento de referencia sea correcta y pertenezca a su cuenta antes de emitir. Una clave inválida no produce un error descriptivo, sino un 500.

Anulación completa de un documento

Cuando el objetivo es anular por completo una factura, existe un endpoint que construye la nota de crédito a partir del documento original —líneas, impuestos, medios de pago y resumen— sin necesidad de reenviar el detalle.

Endpoint
POST /api/2.0/documentos-electronicos/anular/factura/{clave}

curl --location --request POST 'https://app.facturadorvirtual.com/api/2.0/documentos-electronicos/anular/factura/50622032000070175094601000001010000000006118491223' \
--header 'api-token: iuJPbVCYQY3AmWuVHMflT9ZySlwzxb9ehviLbHNsz6yQnBm4' \
--header 'access-token: IDq4ME4ZUO9YmQ0fOc43AFp7mMO6talIuIALFaUUcs2H2pwLpYN2' \
--header 'Accept: application/json'

La petición no lleva cuerpo. La respuesta tiene el mismo formato que la de la nota de crédito y corresponde a la nota generada. Si la anulación no puede completarse, responde 500 con el mensaje No fue posible anular la factura.

Comprobación

La recepción es el primer paso: significa que Hacienda recibió el documento, no que lo aprobó. La comprobación se realiza automáticamente, por lo general en uno o dos minutos, y el estado pasa de por_comprobar a aceptado o rechazado.