Rendiciones de cobranzas

Producto

La rendición de cobranzas registra los pagos y retenciones aplicados sobre tus documentos de deuda (facturas, NC, ND) realizados por tus clientes a través de Frisvy. Podés obtenerla por API REST, por archivo SFTP, y recibir avisos por notificaciones de negocio.

Tres formas de integrarte Notificaciones de negocio para enterarte en tiempo real cuando una orden de pago está lista; API REST para consultar la rendición en JSON; y SFTP para procesar el archivo de rendición por lotes.

1. Notificaciones de negocio (webhook)

El servicio de notificaciones permite a Frisvy informar automáticamente a tu empresa sobre eventos relevantes (por ejemplo, Órdenes de Pago habilitadas para rendición). En lugar de tener que "ir a buscar" la información, los eventos se envían en tiempo real a un endpoint que expone tu empresa.

POST https://{CLIENT_DOMAIN}:{PORT}/business-notifications

El nombre /business-notifications es una recomendación; podés usar el que prefieras. Frisvy hará un POST a la URL que acuerdes.

Request body (lo envía Frisvy)

Ejemplo de notificación recibida

{
  "document_type": "CUIT",
  "document_number": "30556688449",
  "business_unit": "",
  "notification_type": "RENDITION",
  "business_object": "PAYMENT_ORDER",
  "business_object_ids": [],
  "additional_data": { "key1": "val1" },
  "creation_time": "2024-12-13T13:36:01.913Z"
}

Response (lo devuelve tu endpoint)

Response 200

{
  "reception_id": "123456",
  "reception_time": "2024-12-13T13:36:01.913Z"
}

Recomendaciones de seguridad

• Autenticá el endpoint (OAuth 2.0 o JWT) y exponelo siempre sobre HTTPS.
• Devolvé códigos de estado HTTP apropiados y manejá errores adecuadamente.
• El tiempo de respuesta máximo recomendado es de 5 segundos para evitar timeouts.

2. Rendición de Órdenes de Pago mediante API

La Report Manager API genera la rendición de órdenes de pago (con sus documentos, pagos y retenciones) según los parámetros provistos. Requiere un token con el scope ibcobros.renditions.read. Base URL: /report-manager/v1.

Autenticación

Request — POST /auth/login

curl -X POST 'https://apim.{ambiente}.frisvy.com/auth/login' \
  --header 'Authorization: Basic {CREDENCIALES_BASE_64}' \
  --header 'Scope: ibcobros.renditions.read'

Endpoint

POST https://ibcobros.apim.{ambiente}.frisvy.com/report-manager/v1/reports/renditions

Los headers collector-document-type, collector-document-number y business-unit-code se completan internamente; no los envíes. Paginá con page y size (máx 100).

Request body

Ejemplo de request body

curl --location 'https://ibcobros.apim.{ambiente}.frisvy.com/report-manager/v1/reports/renditions?page=0&size=20' \
  --header 'Authorization: Bearer {SESSION_TOKEN}' \
  --header 'Content-Type: application/json' \
  --data '{
    "collector_document_type": "CUIT",
    "collector_document_number": "12345678901",
    "business_unit_code": "CO223",
    "from_date": "2023-12-01T00:00:00Z",
    "to_date": "2023-12-31T23:59:59Z",
    "payment_order_ids": [1234, 1235]
  }'

Respuesta — 200

La rendición se estructura en estos bloques:

Cada PaymentOrder incluye sus documentos, pagos y retenciones:

A su vez, cada Document, Payment y Retention trae su propio detalle (importes, moneda, método de pago, banco, número de transacción, datos de cheque/echeq, código y jurisdicción de retención, etc.).

3. Rendición de Órdenes de Pago mediante SFTP

Frisvy publica el archivo de rendición de órdenes de pago, con la frecuencia pactada, en la carpeta de salida asignada a tu empresa en el servidor SFTP (sftp.frisvy.com, directorio ibcobros-payment-order-rendition/output). El alta SFTP es la misma del resto de integraciones (ver Publicación de deuda).

Nombre del archivo

Formato de nombre

<YYYYMMDDHHMISS>_ROP_<NROSEQ>.csv

# Ejemplo
20251002164510_ROP_1274.csv

Estructura del archivo (registros por tipo)

Es un CSV con registros de distinto tipo, identificados por la primera columna. Cada orden de pago agrupa sus documentos, instrumentos y retenciones:

El archivo incluye tablas de referencia para medios de pago, estados de pago, estados de cheques/echeqs, bancos, códigos de retención, jurisdicciones, tipos de ajuste y códigos de moneda.