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.
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 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
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, 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
Filtra por estado del ciclo de vida del documento: draft, validated o voided.
Opciones disponibles: draft, validated, voided
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
Filtra por identificador del contacto al que se emite la nota de crédito.
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 nota de crédito.
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 nota de crédito.
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
Filtra por identificador de la factura que rectifica la nota de crédito.
Límites: longitud mín. 1, longitud máx. 100
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
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, issueDate, 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.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador de la nota de crédito.
Número de la nota de crédito; null mientras es un borrador.
Estado del ciclo de vida del documento: draft, validated o voided (los mismos valores que admite el filtro status).
Opciones disponibles: draft, validated, voided
Fecha de emisión en ISO 8601 UTC; null si no consta.
Moneda, como código ISO 4217.
Contacto al que se emite la nota de crédito; null si no consta.
Factura que rectifica esta nota de crédito; null si no está asociada a ninguna.
Subtotal antes de descuentos e impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total de impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Base imponible, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total con impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Fecha de creación en ISO 8601 UTC.
Fecha de la última modificación en ISO 8601 UTC.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/credit-notes.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasAbonos
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: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?