Abonos

Obtener una nota de crédito

Devuelve una nota de crédito por su identificador: qué se reembolsa al cliente y contra qué factura, la misma ficha que GET /api/v1/credit-notes.

Herramienta
filmo_credit_notes_get
Acceso: Lectura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_credit_notes_get",
    "arguments": {
      "creditNoteId": "cred_8f2a1c"
    }
  }
}

generado desde el esquema

El documento fiscal firmado, el desglose de impuestos, las líneas y el motivo de la corrección no se publican.

Argumentos

creditNoteIdstringObligatorio

Identificador de la nota de crédito.

Límites: longitud mín. 1

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/{creditNoteId}.

  • Abonos

    Obtener una nota de crédito

    Devuelve una nota de crédito por su identificador: qué se reembolsa al cliente y contra qué factura, la misma ficha que GET /api/v1/credit-notes.

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