Facturas

Listar los pagos de una factura

Devuelve los pagos de tesorería asignados a una factura, los más recientes primero, con la misma proyección que GET /api/v1/treasury/payments/{paymentId}.

Herramienta
filmo_invoices_payments_list
Acceso: Lectura

Resultado

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

generado desde el esquema

Lo que lee son pagos de tesorería, así que requiere el scope de tesorería, no el de facturas. La factura debe pertenecer a la cuenta: una factura desconocida o ajena es un 404, no una lista vacía.

Argumentos

invoiceIdstringObligatorio

Identificador de la factura.

Límites: longitud mín. 1

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: un único campo, con un "-" inicial para descendente (p. ej. "-updatedAt"). Campos ordenables: date, amount, createdAt, updatedAt. Por defecto, "-date". 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

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.

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 del pago.

directionstring

in cuando entra dinero (un cobro) y out cuando sale (un pago).

amountstring

Importe del pago como cadena decimal, en la moneda indicada.

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

currencystring

Moneda del pago, como código ISO 4217.

datestring<date-time>

Fecha del pago en ISO 8601 UTC.

typestring

normal, o deposit cuando es un pago anticipado.

treasuryAccountIdstring

Cuenta de tesorería por la que pasa el pago.

contactIdstring | null

Cliente o proveedor del pago; null si no se ha declarado.

referencestring | null

Referencia externa del pago; null si no tiene.

linkedDocumentsobject[]

Documentos a los que está asignado el pago; vacío si no está vinculado a ninguno.

Mostrar atributos hijos
linkedDocuments.typestring

Tipo del documento vinculado.

Opciones disponibles: invoice, creditNote, supplierInvoice, quote, proforma, salesReceipt, simpleCreditNote, purchaseOrder

linkedDocuments.idstring

Identificador del documento vinculado.

linkedDocuments.amountstring

Importe de este pago asignado al documento, como cadena decimal.

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

createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/invoices/{invoiceId}/payments.

  • Facturas

    Listar los pagos de una factura

    Devuelve los pagos de tesorería asignados a una factura, los más recientes primero, con la misma proyección que GET /api/v1/treasury/payments/{paymentId}.

  • 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.