Facturas

Listar facturas

Devuelve las facturas emitidas (solo documentos de tipo factura), paginadas por cursor.

Herramienta
filmo_invoices_list
Acceso: Lectura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_invoices_list",
    "arguments": {
      "limit": 20
    }
  }
}

generado desde el esquema

Filtra por estado del documento o del pago. Aislamiento estricto por suscripción.

Argumentos

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

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

paymentStatusstring

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

paymentStatusesstring[]

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

contactIdstring

Filtra por identificador del contacto de la factura.

Límites: longitud mín. 1, longitud máx. 100

contactIdsstring[]

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

orderIdstring

Filtra por identificador del pedido de origen de la factura.

Límites: longitud mín. 1, longitud máx. 100

orderIdsstring[]

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

projectIdstring

Filtra por identificador del proyecto vinculado a la factura.

Límites: longitud mín. 1, longitud máx. 100

projectIdsstring[]

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

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

dateFiltersobject

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 hijos
dateFilters.createdobject

Mostrar atributos hijos
dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.dueobject

Mostrar atributos hijos
dateFilters.due.gtestring

Desde este día o instante, inclusive.

dateFilters.due.ltestring

Hasta este día o instante, inclusive.

dateFilters.due.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.due.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.due.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.invoiceDateobject

Mostrar atributos hijos
dateFilters.invoiceDate.gtestring

Desde este día o instante, inclusive.

dateFilters.invoiceDate.ltestring

Hasta este día o instante, inclusive.

dateFilters.invoiceDate.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.invoiceDate.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.invoiceDate.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos
dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

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
idstring

Identificador único de la factura.

invoiceNumberstring | null

Número de factura; null mientras es un borrador (el número se asigna al validarla).

statusstring

Estado del ciclo de vida del documento: draft, validated (validado y numerado) o voided.

Opciones disponibles: draft, validated, voided

isRectificationboolean

Si la factura rectifica una anterior. Las facturas creadas en Filmo nunca son rectificativas, y las notas de crédito se sirven en /api/v1/credit-notes; pero /api/v1/invoices 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.

invoiceDatestring<date-time> | null

Fecha de emisión en ISO 8601 con desfase; null mientras es un borrador.

dueDatestring<date-time> | null

Fecha de vencimiento en ISO 8601 con desplazamiento; null si no está definida.

currencystring

Moneda de la factura como código ISO 4217 (por ejemplo "EUR").

contactobject | null

Referencia compacta al contacto facturado; null si no hay.

Mostrar atributos hijos
contact.idstring

Identificador único del contacto.

contact.namestring

Nombre del contacto.

orderIdstring | null

Identificador del pedido de origen; null si la factura no procede de un pedido.

orderNumberstring | null

Número del pedido de origen; null si la factura no procede de un pedido.

projectIdstring | null

Identificador del proyecto vinculado; null si no está vinculado.

subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

discountTotalstring

Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

taxesPricestring

Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

netPricestring

Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

grossPricestring

Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

totalPaidstring | null

Importe cobrado hasta la fecha como cadena decimal "1234.50" (ROUND_HALF_UP); null si no consta.

Límites: patrón ^-?\d+\.\d{2}$

paymentStatusstring

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

paymentMethodstring | null

Método de pago de la factura; null si no se ha registrado.

tagsobject[]

Etiquetas adjuntas a la factura, con su identificador y nombre.

Mostrar atributos hijos
tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

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].text; 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.

  • Facturas

    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: true y el problema en el primer bloque de texto. Ramifica por su code.