Facturas
Obtener una factura
Devuelve el detalle de una factura por su identificador.
invoices:readinvoices:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Argumentos
Identificador de la factura.
Límites: longitud mín. 1
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único de la factura.
Número de factura; null mientras es un borrador (el número se asigna al validarla).
Estado del ciclo de vida del documento: draft, validated (validado y numerado) o voided.
Opciones disponibles: draft, validated, voided
Si la factura rectifica una anterior. Las facturas creadas en Filmo nunca son rectificativas, y las notas de crédito se sirven en /api; pero /api aún puede devolver documentos rectificativos importados (por ejemplo, de una importación de Rentman) con este campo en true, así que deduplícalos con las notas de crédito por número.
Fecha de emisión en ISO 8601 con desfase; null mientras es un borrador.
Fecha de vencimiento en ISO 8601 con desplazamiento; null si no está definida.
Moneda de la factura como código ISO 4217 (por ejemplo "EUR").
Referencia compacta al contacto facturado; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contacto.
Nombre del contacto.
Identificador del pedido de origen; null si la factura no procede de un pedido.
Número del pedido de origen; null si la factura no procede de un pedido.
Identificador del proyecto vinculado; null si no está vinculado.
Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Importe cobrado hasta la fecha como cadena decimal "1234.50" (ROUND_HALF_UP); null si no consta.
Límites: patrón ^-?\d+\.\d{2}$
Estado del pago: unpaid (nada cobrado todavía, también para facturas sin cobro registrado), partially_paid, paid, overpaid (cobrado por encima del total), overdue (vencido y sin pagar) o voided (el documento está anulado, sea cual sea lo cobrado antes). El filtro paymentStatus usa los mismos valores.
Opciones disponibles: unpaid, partially_paid, paid, overpaid, overdue, voided
Método de pago de la factura; null si no se ha registrado.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Nombre del proyecto vinculado; null si no está vinculado.
Desglose de impuestos por tipo; null si no se ha calculado.
Mostrar atributos hijosOcultar atributos hijos
Clave del tipo de impuesto (por ejemplo "IVA_21").
Etiqueta de impuesto legible.
Tipo impositivo aplicado, como porcentaje (por ejemplo 21 para el 21%).
Base imponible sobre la que se aplica el impuesto, como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Importe del impuesto como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de descuentos aplicados a nivel de producto, como cadena decimal "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.
Límites: patrón ^-?\d+\.\d{2}$
Total de descuento global del documento, como cadena decimal "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.
Límites: patrón ^-?\d+\.\d{2}$
Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP).
Límites: patrón ^-?\d+\.\d{2}$
Tipo de cambio aplicado cuando la moneda difiere de la moneda base; null si no aplica.
Dirección de facturación; null si no consta.
Mostrar atributos hijosOcultar atributos hijos
Etiqueta descriptiva de la dirección; null si no consta.
Primera línea de la dirección; null si no consta.
Segunda línea de la dirección; null si no consta.
Ciudad; null si no consta.
Provincia o región; null si no se ha registrado.
Código postal; null si no se ha registrado.
País; null si no consta.
Identificadores de los presupuestos de origen; null si la factura no procede de presupuestos.
Identificadores de las proformas de origen; null si la factura no procede de proformas.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
Prompts de ejemplo
Enséñame la factura 2026-0031 con sus líneas y sus pagos.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/invoices/{invoiceId}.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasFacturas
Obtener una factura
Devuelve el detalle de una factura por su identificador.
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?