Tesorería

Vincular un pago a un documento

Vincula un pago ya registrado con la factura, la nota de crédito, el presupuesto, la proforma o el pedido de compra que salda.

Herramienta
filmo_treasury_payments_link
Acceso: Escritura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_treasury_payments_link",
    "arguments": {
      "paymentId": "paym_8f2a1c",
      "linkedDocumentType": "invoice",
      "linkedDocumentId": "https://example.com"
    }
  }
}

generado desde el esquema

Es un subrecurso plural porque un pago puede acabar vinculado a varios documentos. Devuelve el pago completo, con linkedDocuments tal como quedan ahora, la misma proyección que su GET.

Argumentos

paymentIdstringObligatorio

Identificador del pago de tesorería.

Límites: longitud mín. 1

linkedDocumentTypestringObligatorio

Tipo del documento al que está vinculado el pago.

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

linkedDocumentIdstringObligatorio

Documento al que está vinculado el pago.

Límites: longitud mín. 1

idempotencyKeystring

Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.

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

ifMatchstring

Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.

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 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 POST /api/v1/treasury/payments/{paymentId}/links.

  • Tesorería

    Vincular un pago a un documento

    Vincula un pago ya registrado con la factura, la nota de crédito, el presupuesto, la proforma o el pedido de compra que salda.

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

¿Te ha resultado útil esta página?