Variables HTML para Formatos de Impresión
Esta pantalla es una referencia: para cada tipo de documento de AdmCloud (facturas,
pedidos, recepciones, órdenes de trabajo, etc.) lista los datos (@Model.Propiedad) que
puedes usar al escribir el código de un Formato de Impresión con HTML
para ese documento: su nombre exacto, una descripción y su tipo de dato. No es una pantalla donde se
capturan ni editan documentos; es una guía de consulta para quien esté diseñando o ajustando un
formato de impresión a la medida.
¿Qué es y para qué sirve?
Cuando escribes un Formato de Impresión con HTML, tu código HTML se
combina con expresiones Razor (por ejemplo @Model.Header.Number o
@Model.Relationship.Name) que AdmCloud reemplaza por el dato real del documento al
imprimir. Pero el conjunto exacto de propiedades disponibles en Model cambia según el
tipo de documento que estés formateando: una Factura a Crédito no tiene las mismas
propiedades que una Orden de Trabajo o una Transferencia de Ubicación.
Esta pantalla resuelve justo eso: es un catálogo, documento por documento, de qué propiedades existen,
qué representan y de qué tipo son (texto, fecha, un registro relacionado como
SA_Relationships, o una lista como List SA_Trans_Items). Cuando el tipo de
dato es un registro u objeto de AdmCloud, el enlace de la columna te lleva al
Diccionario de Datos de esa tabla, donde puedes ver
a su vez todos sus propios campos.
Es el mismo contenido que encuentras en la pestaña Diccionario de Datos dentro del editor de Formatos de Impresión con HTML cuando esa pestaña está habilitada para tu cuenta: aquí puedes consultarlo de forma independiente, por documento, sin necesidad de tener abierto un formato en edición.
Cómo se usa
- Entra a Variables HTML (dirección
/PFDocumentation). Verás el listado de todos los tipos de documento disponibles para formatear. - Elige el documento sobre el que estás trabajando tu Formato de Impresión con HTML (por ejemplo, Factura a Crédito o Pedido de Venta).
- En la tabla de esa página, busca el campo que necesitas por su Nombre de Campo; la columna Descripción te dice qué representa y la columna Tipo de Dato te dice si es texto, fecha, número o un objeto/lista relacionado.
- Si el tipo de dato es un enlace a una tabla (por ejemplo
SA_RelationshipsoList SA_Trans_Items), pulsa el enlace para abrir el Diccionario de Datos de esa tabla y ver los campos internos disponibles dentro de esa propiedad (por ejemplo,Header.Items.Item.Descriptiondentro de las líneas de una factura). - Usa el nombre de campo exacto, tal como aparece en la tabla, precedido de
Model., dentro del código de tu Formato de Impresión con HTML.
Estructura de los datos: comunes a todos los documentos
Todos los tipos de documento comparten un mismo grupo base de propiedades, sin importar si estás formateando una factura, una recepción o una orden de trabajo:
| Campo | Para qué sirve | Tipo de dato |
|---|---|---|
Relationship | El cliente, proveedor o contacto del documento. | SA_Relationships |
Logo | El logo de tu empresa configurado en el sistema. | SA_Files |
Address | La dirección del cliente/proveedor asociada al documento. | SA_Relationships_Addresses |
Division / Department | La división y el departamento del documento, si tu empresa los usa. | GL_Divisions / SA_Departments |
ItemClass | La clasificación del artículo, disponible dentro de las líneas del documento. | IC_ItemClasses |
BarCodeBath | Código de barras del documento, para imprimir junto al número de comprobante. | Texto |
CurrentUserName / CreatedBy | El usuario que está imprimiendo el documento y quién lo creó originalmente. | Texto |
CompanyInfo | Los datos de tu empresa (razón social, RNC/RFC, dirección, teléfonos, etc.). | _CompanyInfo |
Header | El encabezado completo de la transacción (número, fecha, totales, moneda, etc.). | SA_Transactions |
Header.Items | Las líneas (artículos o servicios) del documento, para recorrerlas con un ciclo en tu plantilla. | Lista de SA_Trans_Items |
Header.Items.Item | El artículo o servicio de cada línea, con sus propios datos (código, descripción, unidad, etc.). | IC_Items |
Location | La ubicación/almacén asociado al documento. | SA_Locations |
Caption | El nombre visible del tipo de documento (por ejemplo, "Factura a Crédito"), útil para títulos genéricos. | Texto |
BankAccountName | El nombre de la cuenta bancaria o de caja del documento, cuando aplica. | Texto |
Sobre esa base, cada tipo de documento agrega sus propios campos particulares. Por ejemplo, en
documentos de ventas es común encontrar Terms (términos de pago), SalesRep
(vendedor), Taxes (resumen de impuestos) o FiscalSequenceType (tipo de
comprobante fiscal); en documentos de compras e inventario aparecen campos como
PO_Items (artículos de la orden de compra relacionada) o Prices (niveles de
precio); y en Pedidos de Venta encontrarás además Stock, con el inventario disponible del
artículo al momento de imprimir. El detalle exacto de cada documento está siempre en su propia página
dentro de esta referencia.
Documentos incluidos en esta referencia
| Documento | Para qué se usa |
|---|---|
| Factura a Crédito / Factura al Contado | Ventas facturadas a plazo o de contado, con términos de pago, vendedor, impuestos y método de envío. |
| Recibo de Ingreso | Cobros recibidos de clientes y los documentos que se les aplicaron. |
| Devolución de Efectivo | Devoluciones de mercancía con reembolso en efectivo. |
| Nota de Crédito de Proveedor / Anticipo de Proveedor | Créditos recibidos de proveedores y anticipos entregados a cuenta de compras. |
| Cotización / Solicitud de Cotización | Propuestas de precio enviadas a un cliente y solicitudes de presupuesto recibidas. |
| Pedido de Venta / Solicitud de Devolución de Cliente | Órdenes de venta pendientes de facturar y solicitudes de devolución de mercancía. |
| Orden de Compra | Órdenes de compra enviadas a un proveedor. |
| Recepción / Recepción de Proveedor / Liquidación de Recepción | Entradas de mercancía por compra y su liquidación fiscal o de costos. |
| Transferencia de Ubicación / Liquidación de Transferencia | Movimientos de inventario entre ubicaciones o almacenes. |
| Despacho | Entrega o envío de mercancía asociada a un documento de venta. |
| Orden de Mantenimiento / Orden de Trabajo | Trabajos de mantenimiento sobre activos fijos u órdenes de trabajo generales. |
| Orden de Servicio | Trabajos de servicio al cliente. |
| Factura de Promoción | Facturas de ventas con artículos o condiciones promocionales. |
| Estado de Cuenta | Extracto de movimientos y saldo pendiente de un cliente o proveedor a una fecha. |
Además de estos documentos, la referencia incluye dos páginas de apoyo: BaseModel, con el detalle de los campos comunes descritos arriba, y GenericModel, con los campos genéricos reutilizables en cualquier plantilla independientemente del documento.
Consejos y errores comunes
¿No sabes si un campo existe para tu documento? Busca primero en la página específica de ese documento; si no lo encuentras ahí, revisa las tablas de BaseModel y GenericModel, ya que son comunes a todos los tipos.
El nombre del campo debe escribirse exactamente igual a como aparece en la tabla
(incluyendo mayúsculas y minúsculas) y siempre precedido de Model.; un nombre mal
escrito produce un error de compilación al previsualizar o imprimir el formato.
Cuando un campo es una lista (como Header.Items) o un objeto con sus propios campos
(como Header o Relationship), sigue el enlace de su Tipo de Dato hacia
el Diccionario de Datos para ver qué propiedades
internas puedes usar, por ejemplo Header.Items.Item.Description o
Relationship.Name.