Abonos

Listar notas de crédito

Devuelve las notas de crédito emitidas a clientes, paginadas por cursor: qué se reembolsa y contra qué factura.

Herramienta
filmo_credit_notes_list
Acceso: Lectura

Resultado

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

generado desde el esquema

Filtra por estado del ciclo de vida, contacto, pedido de origen, proyecto, factura rectificada y fecha de emisión. El documento fiscal firmado, el desglose de impuestos, las líneas y el motivo de la corrección no se publican. Ordenadas por fecha de emisión, las más recientes primero.

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, issueDate, grossPrice. Por defecto, "-issueDate". 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

statusstring

Filtra por estado del ciclo de vida del documento: draft, validated o voided.

Opciones disponibles: draft, validated, voided

statusesstring[]

Filtra por status, 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: draft, validated, voided

Límites: mín. 1 elementos, máx. 50 elementos

contactIdstring

Filtra por identificador del contacto al que se emite la nota de crédito.

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 nota de crédito.

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 nota de crédito.

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

invoiceIdstring

Filtra por identificador de la factura que rectifica la nota de crédito.

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

invoiceIdsstring[]

Filtra por invoiceId, 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, issueDate, 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.issueDateobject

Mostrar atributos hijos
dateFilters.issueDate.gtestring

Desde este día o instante, inclusive.

dateFilters.issueDate.ltestring

Hasta este día o instante, inclusive.

dateFilters.issueDate.gtstring

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

dateFilters.issueDate.ltstring

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

dateFilters.issueDate.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 de la nota de crédito.

creditNoteNumberstring | null

Número de la nota de crédito; null mientras es un borrador.

statusstring

Estado del ciclo de vida del documento: draft, validated o voided (los mismos valores que admite el filtro status).

Opciones disponibles: draft, validated, voided

issueDatestring<date-time> | null

Fecha de emisión en ISO 8601 UTC; null si no consta.

currencystring

Moneda, como código ISO 4217.

contactIdstring | null

Contacto al que se emite la nota de crédito; null si no consta.

invoiceIdstring | null

Factura que rectifica esta nota de crédito; null si no está asociada a ninguna.

subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal.

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

taxesPricestring

Total de impuestos, como cadena decimal.

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

netPricestring

Base imponible, como cadena decimal.

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

grossPricestring

Total con impuestos, 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/credit-notes.

  • Abonos

    Listar notas de crédito

    Devuelve las notas de crédito emitidas a clientes, paginadas por cursor: qué se reembolsa y contra qué factura.

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