Clarisa ofrece una avanzada API, diseñada para una integración sencilla, que le permitirá conectar su sistema y agilizar diversas operaciones.
Este servicio describe la funcionalidad de la API para la creación y gestión de Documento Soporte en adquisiciones efectuadas a no obligados a facturar. Incluye un riguroso proceso de verificación y validación, asegurando la aceptación y correcta presentación del documento ante la DIAN .
Antes de continuar:
Para utilizar cualquier servicio de la API, es importante contar con un token de autenticación y autorización. Si necesita asistencia para obtenerlo, consulte la documentación detallada que se indica en el siguiente link.
https://ayuda.clarisa.co/guia-para-consumir-api-de-login/
Importante !
Para el envío masivo de documentos electrónicos, es decir mas de un Documento Soporte, se debe enviar cada petición con intervalo de 3 segundos como mínimo para evitar el cruce de peticiones.
Documentación
| Nombre | Formato | Oc | Tamaño | Descripción |
|---|---|---|---|---|
| NIT | Alfanumérico | 1..1 | 3-13 | NIT de la empresa sin dígito de verificación |
| numeroResolucion | numérico | 1..1 | 14 | Número de resolucion aprobada en la DIAN |
| prefijoDcto | Alfanumérico | 0..1 | 0-4 | Prefijo asociado a la numeración |
| consecutivoDcto | Numérico | 1..1 | 1-9 | Número del consecutivo asociado al documento |
| fechaGeneracion | String | 1..1 | 10 | Fecha de generación del documento electrónico(Formato: yyyy-MM-ddThh:mm:ss) |
| fechaVencimiento | String | 1..1 | 10 | Fecha de vencimiento del documento electrónico(Formato: yyyy-MM-dd) |
| mediosPago | Array [] | 1..N | 3 | 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 valores para medios de pago |
| formaPago | String | 1..1 | 1 | Código DIAN asociado a la forma de pago del documento electrónico. revisar tabla valores para forma de Pago |
| proveedor | 1..1 | Datos del proveedor del documento electrónico | ||
| proveedor.nombreRazonSocial | Alfanumérico | 1..1 | 5-255 | Proveedor: Razón social o Nombre |
| proveedor.tipoIdentificacion | Alfanumérico | 1..1 | 2 | Código del tipo de identificación, véase la lista Tipo de identificación. |
| proveedor.numIdentificacion | númerico | 1..1 | 3-13 | Número de identificación de proveedor, sin dígito de verificación. |
| proveedor.naturaleza | String | 1..1 | 7-8 | Código de la naturaleza del proveedor, véase valores para Naturaleza |
| proveedor.direccion | Alfanumérico | 0..1 | 0-100 | Dirección proveedor |
| proveedor.ciudad | String | 0..1 | 5 | Código DANE de la ciudad. La ciudad del proveedor, véase la tabla valores para ciudad |
| proveedor.telefono | numérico | 0..1 | 0-15 | Télefono del proveedor |
| proveedor.email | Alfanumérico | 0..1 | 0-100 | correo Electrónico |
| proveedor.respFiscales | Alfanumérico | 1..1 | 3 | Código de responsabilidades fiscales, véase tabla Responsabilidades fiscales proveedor |
| proveedor.respTributarias | Alfanumérico | 1..1 | 3 | Código de responsabilidades tributarias, véase tabla Valores para Responsabilidades tributarias del proveedor |
| proveedor.procedencia | Alfanumérico | 1..1 | 12 | Código para la procedencia del proveedor, véase tabla Valores Procedencia Proveedor |
| Observación | String | 0..1 | 0-1000 | Texto libre para incluir una observación en el documento |
| total | numérico | 1..1 | 0-15 Dec 0-6 | Valor total del documento electrónico. |
| ítems | Array [] | 1..N | Items asociados al documento soporte. | |
| items.nombreItemVenta | Alfanumérico | 1..1 | 4-1000 | Nombre del producto vendido |
| items.precioBaseUnitario | numérico | 1..1 | 0-15 Dec 0-6 | Precio base por unidad del item |
| items.cantidad | numérico | 1..1 | 1-9 | Cantidad vendida del ítem |
| items.código | Alfanumérico | 1..1 | 15 | Código del producto vendido. |
| items.unidad | Alfanumérico | 1..1 | 4 | código de la DIAN de la Unidad del producto. REVISAR tabla Valores para unidad |
| items.valorDescuento | numérico | 0..1 | 0-15 Dec 0-6 | Valor de descuento aplicado al precio base del item por unidad |
| items.observacion | Alfanumérico | 0..1 | 0-1000 | Observación del ítem |
| items.formaTransmision | Alfanumérico | 0..1 | 20 | Forma de generación y transmisión del ítem. REVISAR tabla Valores para Forma de Generación y Transmisión |
| items.fechaCompra | String | 1..1 | 10 | Fecha de compra del ítem (Formato: yyyy-MM-dd) |
| items.impuestos | Array [] | 1..N | Lista de impuestos asociados | |
| items.impuestos.tipo | String | 1..1 | 5 | Tipo de impuesto aplicado al item, Valores para tipo impuestos |
| items.impuestos.claseImpuesto | String | 1..1 | 2 | Clase de impuesto porcentual o nominal Valores para clase impuestos |
| items.impuestos.tarifaTributo | numérico | 1..1 | 4 | Valor del impuesto fijado segun normativa |
| items.impuestos.factor | numérico | 0..1 | 0-15 Dec 0-2 | Atributo que solo aplica a impuesto que requieren un cálculo especial |
| listaDescuentosCargos | Array [] | 0..N | Descuento o recargos asociados a la factura | |
| listaDescuentosCargos.tipo | String | 1..1 | 10 | Indicador si pertenece a un descuento o un cargo Valores Descuento o Cargo |
| listaDescuentosCargos.codigo | String | 1..1 | 2 | Indicador de la condicion del Descuento o Cargo Valores el código del Descuento o Cargo |
| listaDescuentosCargos.valor | numérico | 1..1 | 0-15 Dec 0-2 | Valor que afecta al total del documento segun sea Descuento o Cargo |
| listaDescuentosCargos.observacion | String | 0..1 | 0-1000 | Texto libre para indicar una observación al Descuento o Cargo |
| docReferenciados | Array [] | 1..1 | 3 | Documento al cual se aplica el ajuste |
| docReferenciados.tipoReferencia | Alfanumérico | 1..1 | 4-20 | Se permite ORDER_REFERENCE para DS |
| docReferenciados.numeroDocumento | Alfanumérico | 1..1 | 4-1000 | Prefijo y consecutivo documento electrónico |
| docReferenciados.fechaGeneracion | String | 1..1 | 10 | Fecha de generacion del documento electrónico(Formato: yyyy-MM-dd) |
| Nombre | Codigo |
|---|---|
| Tarjeta de extranjería | TE |
| Cédula de extranjería | CE |
| NIT | NI |
| Pasaporte | PA |
| Documento de identificación extranjero | DE |
| Permiso Especial de Permanencia | PE |
| NIT de otro país | NO |
| Nombre | código |
|---|---|
| Instrumento no definido | 1 |
| Crédito ACH | 2 |
| Débito ACH | 3 |
| Reversión débito de demanda ACH | 4 |
| Reversión crédito de demanda ACH | 5 |
| Crédito de demanda ACH | 6 |
| Débito de demanda ACH | 7 |
| Clearing Nacional o Regional | 9 |
| Efectivo | 10 |
| Reversión Crédito Ahorro | 11 |
| Reversión Débito Ahorro | 12 |
| Crédito Ahorro | 13 |
| Débito Ahorro | 14 |
| Bookentry Crédito | 15 |
| Bookentry Débito | 16 |
| Desembolso Crédito (CCD) | 17 |
| Desembolso (CCD) débito | 18 |
| Crédito Pago negocio corporativo (CTP) | 19 |
| Cheque | 20 |
| Poyecto bancario | 21 |
| Proyecto bancario certificado | 22 |
| Cheque bancario de gerencia | 23 |
| Nota cambiaria esperando aceptación | 24 |
| Cheque certificado | 25 |
| Cheque Local | 26 |
| Débito Pago Negocio Corporativo (CTP) | 27 |
| Crédito Negocio Intercambio Corporativo (CTX) | 28 |
| Débito Negocio Intercambio Corporativo (CTX) | 29 |
| Transferencia Crédito | 30 |
| Transferencia Débito | 31 |
| Desembolso Crédito plus (CCD+) | 32 |
| Desembolso Débito plus (CCD+) | 33 |
| Pago y depósito pre acordado (PPD) | 34 |
| Desembolso Crédito (CCD) | 35 |
| Desembolso Débito (CCD) | 36 |
| Pago Negocio Corporativo Ahorros Crédito (CTP) | 37 |
| Pago Negocio Corporativo Ahorros Débito (CTP) | 38 |
| Crédito Intercambio Corporativo (CTX) | 39 |
| Débito Intercambio Corporativo (CTX) | 40 |
| Desembolso Crédito plus (CCD+) | 41 |
| Consignación bancaria | 42 |
| Desembolso Débito plus (CCD+) | 43 |
| Nota cambiaria | 44 |
| Transferencia Crédito Bancario | 45 |
| Transferencia Débito Interbancario | 46 |
| Transferencia Débito Bancaria | 47 |
| Tarjeta Crédito | 48 |
| Tarjeta Débito | 49 |
| Postgiro | 50 |
| Telex estándar bancario | 51 |
| Pago comercial urgente | 52 |
| Pago Tesorería Urgente | 53 |
| Nota promisoria | 60 |
| 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 | 66 |
| Nota promisoria firmada por un tercero avalada por un banco | 67 |
| Retiro de nota por el acreedor | 70 |
| Bonos | 71 |
| Vales | 72 |
| 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 |
| Nota bancaria transferible | 91 |
| Cheque local transferible | 92 |
| Giro referenciado | 93 |
| Giro urgente | 94 |
| Giro formato abierto | 95 |
| Método de pago solicitado no usuado | 96 |
| Clearing entre partners | 97 |
| Otro* | ZZZ |
| Nombre | Código |
|---|---|
| Contado | 1 |
| Crédito | 2 |
| Descripción | código |
|---|---|
| Persona Natural | NATURAL |
| Persona Jurídica | JURIDICA |
Si el cliente presenta varias responsabilidades fiscales, sus códigos deben ir separados por coma
| Nombre | Código |
|---|---|
| Gran contribuyente | GRC |
| Autorretenedor | ART |
| Agente de retención en el impuesto sobre las ventas | RIV |
| Régimen de tributación- SIMPLE | RST |
| No aplica – Otros | NOA |
| Nombre | Código |
|---|---|
| Impuesto al valor agregado | IVA |
| Impuesto Nacional al Consumo | INC |
| IVA + INC | IEC |
| No aplica (ZZ) | NOA |
| 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 |
| Para mas unidades descargue archivo DIAN | Descargar Excel |
| Descripción | Código |
|---|---|
| Impuesto sobre la Ventas | IVA |
Nota: Para el impuesto Exento se debe enviar:
| tipo | EXE |
| claseImpuesto | PO |
| tarifaTributo | 0 |
Para cuando el ítem es Excluido se debe enviar:
| tipo | EXC |
| claseImpuesto | PO |
| tarifaTributo | 0 |
| Descripción | Código |
|---|---|
| Impuesto de tipo porcentual | PO |
| Nombre | Código |
|---|---|
| No condicionado | 00 |
| Condicionado | 01 |
| Nombre | Código |
|---|---|
| Residente en el país | RESIDENTE |
| No residente, proveedor extranjero | NO_RESIDENTE |
| Descripción | Código |
|---|---|
| Por Operación | POR_OPERACION |
| Acumulado Semanal | ACUMULADO_SEMANAL |
Crear Documento Soporte
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO : "POST"
NOTA: El ejemplo anterior corresponde a un petición con los datos mínimos
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Error
Si la solicitud no es correcta, puede recibir una respuesta como la siguiente:
CÓDIGO HTTP: 206
Propiedades Adicionales
Agregar descuento a un ítem
Nota Adicional
Todos los descuentos aplicados a un ítem afectan a las bases imponibles.
Agregar descuento general al total del documento
Nota Adicional
Es posible aplicar tanto descuentos como recargos generales sin afectar las bases imponibles del documento.
Agregar documento referenciado en Documento Soporte
Además, puedes visualizar el JSON correspondiente a estos escenarios seleccionando la opción 'Ver JSON'.
Si desea emitir una Nota de Ajuste al Documento Soporte, puede dirigirse a:
> Nota de Ajuste Crédito a DS
Estamos comprometidos en brindarle una experiencia eficiente y segura en la gestión de sus documentos electrónicos.