Clarisa ofrece una API que le permite a su sistema integrarse y realizar nota crédito y nota débito con o sin referencia a factura .
Contamos con la verificación y validación de sus facturas para lograr ser aceptadas y reportadas a la DIAN .
Las acciones disponibles para la API son:
- Crear Nota Crédito
- Crear Nota Crédito Sin Referencia a Factura
- Crear Nota Débito
- Crear Nota Débito Sin Referencia a Factura
Importante !
Para el envío masivo de facturas, es decir mas de un documento, se debe enviar cada petición con intervalo de 5 segundos como mínimo.
Crear Nota Débito (Con Referencia a Factura / Sin Referencia a Factura)
Contamos con la verificación y validación de sus notas débito para lograr ser aceptadas y reportadas a la DIAN :
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
NOTA: Para el reporte de una nota debito Sin referencia debe agregar "tipoDocumentoND": "SIN_REFERENCIA_FACTURA" , y no agregar número de factura asociada, ejemplo:
Información adicional para enviar cuando la Nota Debito es "tipoDocumentoND": SIN_REFERENCIA_FACTURA
Petición
| Nombre del campo | Formato | Tamaño | Descripción |
|---|---|---|---|
| nit | Alfanumérico | 100 | Hace referencia del NIT de la empresa. |
| numeroFacturaAsociada | String | 100 | Numero de la factura asociada a la nota débito. |
| tipo | String | 100 | Código de la DIAN que identifica el Tipo de la nota débito,Son: INTERESES GASTOS_POR_COBRAR CAMBIO_POR_COBRAR OTRO |
| numeroDocumentoComercial | String | 100 | Numero de la Nota Débito |
| codigoDescuento | String | 100 | Código de la dian del tipo de descuento aplicado al item, vease la tabla Valores para codigoDescuento |
| porcentajeDescuentoGeneral | String | 100 | Porcentaje de descuento aplicado al valor total |
| cliente | Datos del Cliente del documento electrónico | ||
| cliente.nombreRazonSocial | Alfanumérico | 100 | Cliente: Razón social o Nombre |
| cliente.tipoIdentificacion | Alfanumérico | 100 | Codigo del tipo de identificación, vease la lista tipo de identificación. |
| cliente.numIdentificacion | númerico | 100 | Número de identificación de cliente |
| cliente.naturaleza | String | 100 | Naturaleza del cliente Juridica o Natural revisar tabla Naturaleza |
| cliente.direccion | Alfanumérico | 100 | Dirección Cliente |
| cliente.ciudad | numérico | 100 | Identificador de la ciudad del cliente, vease la tabla ciudad |
| cliente.telefono | numérico | 100 | Telefono del cliente |
| cliente.email | Alfanumérico | 100 | correo Electronico |
| cliente.responsabilidadesFiscales | Alfanumérico | 100 | Código de responsabilidades fiscales, véase tabla Responsabilidades fiscales cliente |
| cliente.respTributarias | Alfanumérico | 100 | Código de responsabilidades tributarias, véase tabla Valores para Responsabilidades tributarias cliente |
| numeroDocumentoComercial | numérico | 100 | Numero del documento electrónico |
| fechaGeneracion | String | 100 | Fecha de generación del documento electrónico (Formato: yyyy-MM-ddThh:mm:ss) |
| fechaVencimiento | String | 100 | Fecha de vencimiento del documento electrónico(Formato: yyyy-MM-ddThh:mm:ss) |
| mediosPago | Alfanumérico | 100 | Códigos de la DIAN de los medios de pago con los que se pagó el documento electrónico, dichos códigos van separados por coma. revisar tabla medios de pago |
| Observación | Alfanumérico | 100 | Observación. |
| formaPago | numérico | 100 | Código de la DIAN asociado a la forma de pago del documento electrónico. revisar tablaformaPago |
| total | numérico | 100 | Valor total del documento electrónico. |
| items | Array [] | Lineas de la Nota debito. | |
| items.nombreItemVenta | Alfanumérico | 100 | Nombre del producto vendido |
| items.precioVentaUnitario | numérico | 100 | Precio de venta unitario del producto |
| items.precioBaseUnitario | numérico | 100 | Precio base unitario del producto. Este atributo remplaza a items.precioVentaUnitario en caso que desee que los cálculos del item se hagan a partir del precio base y no a partir del precio con impuesto. |
| items.precioReferencia | numérico | 100 | Precio de referencia del producto cuando éste se considera un regalo, es decir, su precio resultante es igual a cero. Este campo es obligatorio si items.descuentoPorcentaje = 100 o si items.precioVentaUnitario = 0 o items.precioBaseUnitario = 0 |
| items.cantidad | numérico | 100 | Cantidad vendida del item |
| items.impuesto | ImpuestoEnum | 100 | Impuesto aplicado, revisar tabla ImpuestoEnum |
| items.codigo | Alfanumérico | 100 | Código del producto vendido. |
| items.unidad | Alfanumérico | 100 | código de la DIAN de la Unidad del producto. REVISAR tabla unidad |
| items.codigoDescuento | Alfanuméricos | 100 | Código de la dian del tipo de descuento aplicado al item. |
| items.descuentoPorcentaje | numérico | 100 | porcentaje de descuento aplicado al item |
| items.observacion | Alfanumérico | 100 | Observación del item |
| Nombre | codigo |
|---|---|
| Descuento por impuesto asumido | 00 |
| Pague uno lleve otro | 01 |
| Descuentos contractulales | 02 |
| Descuento por pronto pago | 03 |
| Envío gratis | 04 |
| Descuentos específicos por inventarios | 05 |
| Descuento por monto de compras | 06 |
| Descuento de temporada | 07 |
| Descuento por actualización de productos / servicios | 08 |
| Descuento general | 09 |
| Descuento por volumen | 10 |
| Otro descuento | 11 |
Consideraciones:
- Si desea que el origen de los cálculos de los ítems de la factura sea el precio con impuesto, debe enviar el atributo items.precioVentaUnitario. Si por el contrario desea que el origen de los cálculos sea el precio base unitario, envíe el atributo items.precioBaseUnitario.
- No envíe en un mismo ítem los atributos items.precioBaseUnitario e items.precioVentaUnitario a la vez.
Respuesta:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| success | Booleano | Determina si la operación fué exitosa o no |
| titleResponse | Alfanumérico | Título de la respuesta |
| textResponse | Alfanumérico | Texto de la respuesta |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual se respondió esta respuesta |
| data.numeroNotaDebito | Alfanumérico | Datos de respuesta |
| data.urlAcuseRecibido | Alfanúmerico | URL para acusar recibido de la información |
| data.cufe | Alfanumérico | Cufe de la nota débito creada |
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
Error
Si la solicitud no es correcta, recibirás un estado HTTP o por consiguiente un mensaje explicando el posible error.
Crear Nota Crédito (Con Referencia a Factura / Sin Referencia a Factura)
Contamos con la verificación y validación de sus notas crédito para lograr ser aceptadas y reportadas a la DIAN :
CABECERAS:
| CABECERAS | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO: "POST"
NOTA: Para el reporte de una nota crédito Sin referencia debe agregar "tipoDocumentoNC": "SIN_REFERENCIA_FACTURA" , y no agregar número de factura asociada, ejemplo:
Información adicional para enviar cuando la Nota Crédito es "tipoDocumentoNC": SIN_REFERENCIA_FACTURA
Consideraciones:
- Si desea que el origen de los cálculos de los ítems de la factura sea el precio con impuesto, debe enviar el atributo items.precioVentaUnitario. Si por el contrario desea que el origen de los cálculos sea el precio base unitario, envíe el atributo items.precioBaseUnitario.
- No envíe en un mismo ítem los atributos items.precioBaseUnitario e items.precioVentaUnitario a la vez.
Petición
| Nombre del campo | Formato | Tamaño | Descripción |
|---|---|---|---|
| nit | Alfanumérico | 100 | Hace referencia del NIT de la empresa. |
| numeroDocumentoComercial | numérico | 100 | Numero de la nota crédito |
| fechaGeneracion | String | 100 | Fecha de generación del documento electrónico (Formato: yyyy-MM-ddThh:mm:ss) |
| fechaVencimiento | String | 100 | Fecha de vencimiento del documento electrónico(Formato: yyyy-MM-ddThh:mm:ss) |
| numeroFacturaAsociada | String | 100 | Numero de la factura asociada a la nota crédito. |
| tipo | String | 100 | Código de la DIAN que identifica el Tipo de la nota crédito, puede ser de tipo DEVOLUCION_BIENES o ANULACION |
| mediosPago | Alfanumérico | 100 | Códigos de la DIAN de los medios de pago con los que se pagó el documento electrónico, dichos códigos van separados por coma. revisar tabla medios de pago |
| Observación | Alfanumérico | 100 | Observación. |
| formaPago | numérico | 100 | Código de la DIAN asociado a la forma de pago del documento electrónico. revisar tablaformaPago |
| total | numérico | 100 | Valor total del documento electrónico. |
| cliente | Datos del Cliente del documento electrónico | ||
| cliente.nombreRazonSocial | Alfanumérico | 100 | Cliente: Razón social o Nombre |
| cliente.tipoIdentificacion | Alfanumérico | 100 | Codigo del tipo de identificación, vease la lista tipo de identificación. |
| cliente.numIdentificacion | númerico | 100 | Número de identificación de cliente |
| cliente.naturaleza | String | 100 | Naturaleza del cliente Juridica o Natural revisar tabla Naturaleza |
| cliente.direccion | Alfanumérico | 100 | Dirección Cliente |
| cliente.ciudad | numérico | 100 | Identificador de la ciudad del cliente, si la factura a la que se hace la nota es de tipo exportación. De lo contrario, enviar código DANE de la ciudad, véase la tabla ciudad |
| cliente.telefono | numérico | 100 | Telefono del cliente |
| cliente.email | Alfanumérico | 100 | correo Electronico |
| cliente.responsabilidadesFiscales | Alfanumérico | 100 | Código de responsabilidades fiscales, véase tabla Responsabilidades fiscales cliente |
| cliente.respTributarias | Alfanumérico | 100 | Código de responsabilidades tributarias, véase tabla Valores para Responsabilidades tributarias cliente |
| items | Array [] | Lineas de la Nota Credito. | |
| items.nombreItemVenta | Alfanumérico | 100 | Nombre del producto vendido |
| items.precioVentaUnitario | numérico | 100 | Precio de venta unitario del producto |
| items.precioBaseUnitario | numérico | 100 | Precio base unitario del producto. Este atributo remplaza a items.precioVentaUnitario en caso que desee que los cálculos del item se hagan a partir del precio base y no a partir del precio con impuesto. |
| items.precioReferencia | numérico | 100 | Precio de referencia del producto cuando éste se considera un regalo, es decir, su precio resultante es igual a cero. Este campo es obligatorio si items.descuentoPorcentaje = 100 o si items.precioVentaUnitario = 0 o items.precioBaseUnitario = 0 |
| items.cantidad | numérico | 100 | Cantidad vendida del item |
| items.impuesto | ImpuestoEnum | 100 | Impuesto aplicado, revisar tabla ImpuestoEnum |
| items.codigo | Alfanumérico | 100 | Código del producto vendido. |
| items.unidad | Alfanumérico | 100 | código de la DIAN de la Unidad del producto. REVISAR tabla unidad |
| items.codigoDescuento | Alfanuméricos | 100 | Código de la dian del tipo de descuento aplicado al item. |
| items.descuentoPorcentaje | numérico | 100 | porcentaje de descuento aplicado al item |
| items.observacion | Alfanumérico | 100 | Observación del item |
Respuesta
| Nombre | Tipo dato | Descripción |
|---|---|---|
| success | Booleano | Determina si la operación fué exitosa o no |
| titleResponse | Alfanumérico | Título de la respuesta |
| textResponse | Alfanumérico | Texto de la respuesta |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual se respondió esta respuesta |
| data.numeroNotaCredito | Alfanumérico | Datos de respuesta |
| data.urlAcuseRecibido | Alfanúmerico | URL para acusar recibido de la información |
| data.cufe | Alfanumérico | Cufe de la nota crédito creada |
| errores | Alfanumérico | Objeto con detalles globales de errores. |
| total_errores | Numérico | Número total de errores |
| errores.errores | Array | Array, con la lista de errores. |
| errores.errores.codError | Alfanúmerico | Código de error. |
| errores.errores.errorMessage | Alfanúmerico | Mensaje del error. |
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
Error
Si la solicitud no es correcta, un ejemplo de respuesta será el siguiente: