Saltar al contenido principal

Documentos Personalizados

Índice​

Introducción​

Este documento está diseñado para ayudar a usuarios sin conocimientos de programación a editar una plantilla de factura en formato DOCX para ser utilizada en TurpialAPP. El sistema permite que el cliente edite la plantilla del documento fiscal y luego suba el archivo con las variables adecuadas. Las variables serán reemplazadas automáticamente por los valores correspondientes cuando se genere el documento.

En resumen, las variables son campos especiales dentro del archivo DOCX que serán reemplazados automáticamente por los valores reales cuando se utilice la plantilla. Este documento explica cómo utilizar esas variables en la plantilla para que puedas personalizar tu documento según tus necesidades.

Cómo Editar la Plantilla DOCX​

  1. Descargar el Archivo DOCX: Primero, descarga el archivo DOCX de la plantilla de factura desde el sistema TurpialAPP. Este archivo contiene el formato básico de la factura que se utilizará para la creación de documentos personalizados.

  2. Abrir el Archivo en un Editor de Texto: Utiliza un programa como Microsoft Word o cualquier otro editor de texto compatible con archivos DOCX.

  3. Modificar el Contenido de la Plantilla: Puedes cambiar el diseño de la factura, agregar o eliminar información de los campos de texto, pero las variables deben mantenerse tal cual están para que el sistema pueda reemplazarlas correctamente.

  4. Guardar y Subir la Plantilla: Una vez que hayas editado la plantilla según tus necesidades, guarda los cambios y sube el archivo al sistema ERP para utilizarlo en la generación de futuras facturas.

Cómo Usar las Variables​

Las variables son elementos especiales de texto dentro del archivo DOCX que se reemplazarán automáticamente por los valores reales cuando se genere un documento. Las variables están delimitadas por llaves {} y, en algunos casos, pueden estar dentro de bucles que permiten generar una lista de elementos (como productos o pagos).

¿Cómo funciona el reemplazo de las variables?​

Cuando se genera un documento, el sistema toma el archivo DOCX y reemplaza cada variable por el valor correspondiente. Por ejemplo, la variable {customer_name} será reemplazada por el nombre del cliente, {document_number} será reemplazada por el número del documento, etc.

Ejemplo:
Si el nombre del cliente es "Juan Pérez", el sistema reemplazará {customer_name} por "Juan Pérez".

Lista de Variables Disponibles​

A continuación se muestra una lista de las variables disponibles que puedes usar en la plantilla:

Información del Cliente​

  • {customer_name}: Nombre del cliente.
  • {customer_dni}: R.I.F./C.I./Identificación Fiscal del cliente.
  • {customer_address}: Dirección del cliente.
  • {customer_phone}: Teléfono del cliente.
  • {customer_email}: Correo electrónico del cliente.

Información del Documento​

  • {document_date}: Fecha del documento.
  • {document_number}: Número de la factura.

Detalles de los Productos​

  • {#products}: Marca el inicio de un grupo de productos (se usa para crear listas de productos).
    • {name}: Nombre del producto.
    • {unit_price}: Precio unitario del producto.
    • {quantity}: Cantidad del producto.
    • {total}: Total por producto (cantidad * precio unitario).
  • {/}: Marca el final del grupo.

Ejemplo: {#products}{name} {unit_price} {quantity} {total}{/}: Esto indica que la información del producto se repetirá para cada producto que se agregue a la factura.

Impuestos​

  • {#taxes}: Marca el inicio de un grupo de impuestos.
    • {name}: Nombre del impuesto.
    • {taxable_amount}: Base imponible del impuesto.
    • {amount}: Monto del impuesto.
  • {/}: Marca el final del grupo.

Ejemplo: {#taxes}{name} {taxable_amount} {amount}{/}: Similar a los productos, esto repetirá la información de cada impuesto.

Forma de Pago​

  • {#payments}: Marca el inicio de un grupo de pagos (útil cuando hay más de una forma de pago).
    • {name}: Nombre del método de pago.
    • {amount}: Monto pagado con ese método.
  • {/}: Marca el final del grupo.

Ejemplo: {#payments}{name} {amount}{/}: Se repite para cada método de pago.

Totales​

  • {document_subtotal}: Subtotal de la factura antes de impuestos.
  • {document_total_taxes}: Total de los impuestos aplicados.
  • {document_total}: Total de la factura (incluyendo impuestos).
  • {document_total_taxes_retained}: Total de los impuestos retenidos.
  • {document_total_to_pay}: Total final que el cliente debe pagar después de impuestos y descuentos.

Ejemplos de Variables en el Documento​

Puedes descargar estos ejemplos: