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 Crédito Salud
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 Crédito a Factura / Sin Referencia
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.
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:
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 |
| Nombre | Codigo |
|---|---|
| cedula de ciudadania | CC |
| NIT | NI |
| tarjeta de identidad | TI |
| Pasaporte | PA |
| Tarjeta de extranjeria | TE |
| Cedula de extranjeria | CE |
| Registro civil de nacimiento | RC |
| Nit de otro país | NO |
| NUIP | NU |
| Permiso Especial de permanencia | PE |
| Documento extranjero | DE |
| Documento de identificación extranjero | DE |
| PEP | PE |
Si el cliente presenta varias responsabilidades fiscales, sus códigos deben ir separados por coma
| Nombre | Código |
|---|---|
| Gran contribuyente | O-13 |
| Autorretenedor | O-15 |
| Agente de retención en el impuesto sobre las ventas | O-23 |
| Régimen de tributación- SIMPLE | O-47 |
| No responsable | R-99-PN |
| Nombre | Código |
|---|---|
| Impuesto al valor agregado | IVA |
| Impuesto Nacional al Consumo | INC |
| IVA + INC | IVA_E_INC |
| No aplica | NO_APLICA |
| Nombre | Código |
|---|---|
| Responsable del impuesto sobre las ventas - IVA | IMPUESTO_SOBRE_VENTAS |
| No responsable de IVA | NO_RESPONSABLE_IVA |
| Nombre | código |
|---|---|
| Acuerdo mutuo | ZZZ |
| Efectivo | 10 |
| Consiganción bancaria | 42 |
| Tarjeta crédito | 30 |
| Tarjeta Débito | 49 |
| Bonos | 71 |
| Bookentry Crédito | 15 |
| Bookentry Débito | 16 |
| Cheque | 20 |
| Cheque bancario | 23 |
| Cheque certificado | 25 |
| Cheque Local | 26 |
| Cheque local transferible | 92 |
| Clearing entre partners | 97 |
| Clearing Nacional o Regional | 9 |
| Concentración de la demanda en efectivo / Desembolso (CCD) débito | 18 |
| Concentración de la demanda en efectivo /Desembolso Crédito (CCD) | 17 |
| Concentración Efectivo / Desembolso Crédito plus (CCD+) | 32 |
| Concentración efectivo / Desembolso Débito plus (CCD+) | 43 |
| Concentración Efectivo / Desembolso Débito plus (CCD+) | 33 |
| Concentración efectivo ahorros / Desembolso Crédito (CCD) | 35 |
| Concentración efectivo ahorros / Desembolso Drédito (CCD) | 36 |
| Concentración efectivo/Desembolso Crédito plus (CCD+) | 41 |
| Crédito ACH | 2 |
| Crédito Ahorro | 13 |
| Crédito de demanda ACH | 6 |
| Crédito Negocio Intercambio Corporativo (CTX) | 28 |
| Crédito Negocio Intercambio Corporativo (CTX) | 39 |
| Crédito Pago negocio corporativo (CTP) | 19 |
| Débito ACH | 3 |
| Débito Ahorro | 14 |
| Débito de demanda ACH | 7 |
| Débito Negocio Intercambio Corporativo (CTX) | 40 |
| Débito Negocio Intercambio Corporativo (CTX) | 29 |
| Débito Pago Negocio Corporativo (CTP) | 27 |
| Giro formato abierto | 95 |
| Giro referenciado | 93 |
| Giro urgente | 94 |
| Instrumento no definido | 1 |
| Mantener | 8 |
| Método de pago solicitado no usuado | 96 |
| Nota bancaria transferible | 91 |
| Nota cambiaria | 44 |
| Nota cambiaria esperando aceptación | 24 |
| Nota promisoria | 60 |
| Nota promisoria firmada | 66 |
| Nota promisoria firmada por el acreedor | 61 |
| Nota promisoria firmada por el acreedor, avalada por el banco | 62 |
| Nota promisoria firmada por el acreedor, avalada por un tercero | 63 |
| Nota promisoria firmada por el banco | 64 |
| Nota promisoria firmada por un banco avalada por otro banco | 65 |
| Nota promisoria firmada por un tercero avalada por un banco | 67 |
| Pago comercial urgente | 52 |
| Pago Negocio Corporativo Ahorros Crédito (CTP) | 37 |
| Pago Neogcio Corporativo Ahorros Débito (CTP) | 38 |
| Pago Tesorería Urgente | 53 |
| Pago y depósito pre acordado (PPD) | 34 |
| Postgiro | 50 |
| Poyecto bancario | 21 |
| Proyecto bancario certificado | 22 |
| Retiro de nota por el acreedor | 70 |
| Retiro de nota por el acreedor sobre un banco | 74 |
| Retiro de nota por el acreedor, avalada por otro banco | 75 |
| Retiro de nota por el acreedor, sobre un banco avalada por un tercero | 76 |
| Retiro de una nota por el acreedor sobre un tercero | 77 |
| Retiro de una nota por el acreedor sobre un tercero avalada por un banco | 78 |
| Reversión Crédito Ahorro | 11 |
| Reversión crédito de demanda ACH | 5 |
| Reversión Débito Ahorro | 12 |
| Reversión débito de demanda ACH | 4 |
| Tarjeta Crédito | 48 |
| Tarjeta débito | 31 |
| Telex estándar bancario francés | 51 |
| Transferencia Crédito Bancario | 45 |
| Transferencia Débito Bancaria | 47 |
| Transferencia Débito Interbancario | 46 |
| Vales | 72 |
| Nombre | código |
|---|---|
| Contado | 1 |
| Crédito | 2 |
| Nombre del campo | código |
|---|---|
| Unidad | 94 |
| Pieza | 94 |
| Centímetro | CMT |
| Metro | MTR |
| Pulgada | INH |
| Centímetro cuadrado | CMK |
| Metro cuadrado (m2) | MTK |
| Pulgada cuadrada | INK |
| Mililitro | MLT |
| Litro | LTR |
| Galón | A76 |
| Gramo | GGR |
| Kilogramo | KGM |
| Tonelada | 54 |
| Libra | LBR |
| Servicio | 94 |
| Centímetro Cúbico (cm3) | CMQ |
| Metro Cúbico | MTQ |
| Nombre | código |
|---|---|
| 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 |
| Descripción | código |
|---|---|
| Excluido de impuesto | EXCLUIDO |
| Exento de impuesto | EXENTO |
| Impuesto al consumo 4% | IMPUESTO_CONSUMO_4 |
| Impuesto al consumo 8% | IMPUESTO_CONSUMO_8 |
| Impuesto al consumo 16% | IMPUESTO_CONSUMO_16 |
| IVA 19% + INC Bolsas | BOLSA_IVA |
| IVA 5% | IVA_5 |
| IVA 19% | IVA_19 |
| Código naturaleza | Descripción |
|---|---|
| NATURALES | Persona natural |
| JURIDICAS | Persona Jurídica |
| Revisar el excel con los datos de las ciudades |
| Descripción | código |
|---|---|
| Devolución parcial de los bienes y/o no aceptación parcial del servicio | DEVOLUCION_BIENES |
| Anulación de factura electrónica | ANULACION |
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. |
Crear Nota Crédito a Factura de Salud
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"
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: