Facturas
Listar facturas
Devuelve las facturas emitidas (solo documentos de tipo factura), paginadas por cursor.
invoices:readinvoices:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Filtra por estado del documento o del pago. Aislamiento estricto por suscripción.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, invoiceNumber, invoiceDate, dueDate, subTotal, grossPrice. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra por estado de pago, con el mismo vocabulario que devuelve el campo paymentStatus: unpaid (nada cobrado todavía), partially_paid, paid, overpaid (cobrado por encima del total), overdue (vencido y sin pagar) o voided (el documento está anulado).
Opciones disponibles: unpaid, partially_paid, paid, overpaid, overdue, voided
Filtra por paymentStatus, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Opciones disponibles: unpaid, partially_paid, paid, overpaid, overdue, voided
Límites: mín. 1 elementos, máx. 50 elementos
Filtra por identificador del contacto de la factura.
Límites: longitud mín. 1, longitud máx. 100
Filtra por contactId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100
Filtra por identificador del pedido de origen de la factura.
Límites: longitud mín. 1, longitud máx. 100
Filtra por orderId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100
Filtra por identificador del proyecto vinculado a la factura.
Límites: longitud mín. 1, longitud máx. 100
Filtra por projectId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, due, invoiceDate, updated.
Mostrar atributos hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
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.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
Prompts de ejemplo
¿Qué facturas están sin pagar y tienen más de 30 días?
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/invoices.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasFacturas
Listar facturas
Devuelve las facturas emitidas (solo documentos de tipo factura), paginadas por cursor.
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?