Rendición de instrumentos de cobro

Referencia de API · v1.5

Permite obtener los instrumentos de cobro (transferencias, cheques y echeqs) acreditados a tu empresa, en base a parámetros específicos provistos por el cliente.

Autenticación Este endpoint requiere un token de sesión válido. Generalo con el scope ibcobros.renditionsintrument.read según la guía de gestión de credenciales. Base URL: /report-manager/v1.

Endpoint

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

Headers

Header	Tipo	Requerido	Descripción
`Authorization`	string	Sí	Bearer JWT obtenido en la autenticación.
`Content-Type`	string	Sí	application/json

Query params

Parámetro	Tipo	Requerido	Descripción
`page`	number	Sí	Número de página (0-based). Ejemplo: 0.
`size`	number	Sí	Cantidad de registros por página. Máximo 100. Ejemplo: 20.

Request body

Campo	Tipo	Requerido	Descripción
`collector_document_type`	string	Sí	Tipo de documento de la compañía recaudadora (ej. "CUIT").
`collector_document_number`	string	Sí	Número de documento de la empresa recaudadora (ej. "30691576510").
`business_unit_code`	string	No	Código de unidad de negocio.
`include_payer_without_cuit`	boolean	Sí	Filtro de presencia de CUIT/CUIL del pagador.
`exclude_status_list`	`array<string>` (nullable)	Sí	Excluye únicamente los estados listados.
`from_date`	string	Sí	Fecha de inicio del rango, formato `yyyy-mm-dd` (UTC-0).
`to_date`	string	Sí	Fecha de fin del rango, formato `yyyy-mm-dd` (UTC-0).

Ejemplo de request body

{
  "collector_document_type": "CUIT",
  "collector_document_number": "30999999999",
  "business_unit_code": "CO223",
  "include_payer_without_cuit": false,
  "exclude_status_list": ["RECHAZADO", "ANULADO"],
  "from_date": "2025-12-01",
  "to_date": "2025-12-07"
}

Respuesta — 200

Rendición de instrumentos generada exitosamente. La respuesta tiene la siguiente estructura:

Campo	Tipo	Descripción
`instruments`	List	Lista de instrumentos.
`total_elements`	number	Cantidad total de registros.
`total_pages`	number	Cantidad total de páginas.
`first`	boolean	Indicador de primera página.
`last`	boolean	Indicador de última página.
`empty`	boolean	Indicador de existencia de registros.

Campos comunes del instrumento

Campo	Tipo	Descripción
`date`	date	Fecha de cobro. (Fecha en que se detecta el cobro. Para transferencias es la fecha de acreditación; para cheques, el día en que se emite o endosa a la empresa.)
`instrument_id`	string	Id único de instrumento (interno Frisvy).
`collector_document_type`	string	Tipo de documento del vendedor. Ej. "CUIT".
`collector_document_number`	string	Número de documento del vendedor.
`payer_document_type`	string	Tipo de documento del cliente. Ej. "CUIT".
`payer_document_number`	string	Número de documento del cliente.
`payment_method_id`	string	Id del método de pago. Ver Tabla 1.
`payment_method_description`	string	Descripción del método de pago.
`amount`	number	Monto pagado.
`currency_code`	string	Código de moneda.
`status_id`	number	Id de estado del pago. Ver Tabla 2.
`status_description`	string	Descripción del estado.
`custom_data`	json	Datos específicos opcionales informados como etiqueta/valor.

Campos de echeq / cheque

Se informan cuando el instrumento es un echeq o cheque.

Campo	Tipo	Descripción
`issuer_document_number`	string	CUIT de quién dio origen al echeq.
`issuer_name`	string	Razón social de quién dio origen al echeq.
`issuer_bank_code`	string	Código de entidad financiera de origen (según BCRA).
`issuer_bank_name`	string	Razón social de la entidad financiera de origen.
`cmc7echeq`	string	CMC7 del echeq.
`bank_code`	string	Código de banco emisor del instrumento.
`bank_name`	string	Nombre del banco emisor.
`bank_branch_code`	string	Código de sucursal del banco.
`account_number`	string	Número de cuenta bancaria emisora del instrumento.
`check_number`	string	Número de cheque o echeq.
`id_coelsa`	string	Id del echeq (Coelsa).
`postal_code`	string	Código postal. (Aplica para echeqs/cheques.)
`issuing_date`	string	Fecha de emisión. (Aplica para echeqs/cheques.)
`payment_date`	string	Fecha del pago. Ejemplo: "2025-03-05T00:00:00". (Para echeqs/cheques es la fecha de pago/vencimiento del instrumento.)

Campos de transferencia

Se informan cuando el instrumento es una transferencia.

Campo	Tipo	Descripción
`transaction_number`	number	Número de transacción de la transferencia. (Es la referencia en los extractos.)
`bank_code`	string	Código de banco de la cuenta crédito.
`bank_name`	string	Nombre del banco de la cuenta crédito.
`account_type`	string	Tipo de cuenta.
`account_number`	string	Número de cuenta bancaria. (Cuenta donde se acreditó la transferencia.)

Ejemplo — transferencia

Response body (transferencia)

{
  "instruments": [
    {
      "date": "2025-10-07T06:24:02",
      "instrument_id": "3afda19a-0bf4-4c12-85b0-b8e61b883e81",
      "collector_document_type": "CUIT",
      "collector_document_number": "30714684759",
      "payer_document_type": "CUIT",
      "payer_document_number": "30615288248",
      "payment_method_id": 5,
      "payment_method_description": "Transferencia bancaria",
      "amount": 220522.5,
      "currency_code": "ARS",
      "status_id": 1,
      "status_description": "Acreditado",
      "custom_data": null,
      "transaction_number": null,
      "bank_code": "015",
      "bank_name": "INDUSTRIAL AND COMMERCIAL BANK OF CHINA",
      "account_type": "CC",
      "account_number": "08490210437858"
    }
  ],
  "total_pages": 13,
  "total_elements": 13,
  "last": false,
  "first": true,
  "empty": false
}

Ejemplo — echeq

Response body (echeq)

{
  "instruments": [
    {
      "date": "2024-12-13",
      "instrument_id": "12345678",
      "issuer_document_number": "30263379724",
      "issuer_name": "FERRETERIA INDUSTRIAL S.A.",
      "issuer_bank_code": "007",
      "issuer_bank_name": "BANCO SRL",
      "payer_document_type": "CUIT",
      "payer_document_number": "30123456789",
      "payment_method_id": "7",
      "payment_method_description": "Echeq de pago diferido",
      "amount": 93000,
      "currency_code": "ARS",
      "status_id": 8,
      "status_description": "ACTIVO",
      "cmc7echeq": "0079999999999999",
      "bank_code": "007",
      "bank_branch_code": "999",
      "postal_code": "999",
      "account_number": "99999999",
      "check_number": "99999999",
      "id_coelsa": "XRP84466684888ZZZZ",
      "bank_name": "Banco Galicia",
      "issuing_date": "2025-08-20T00:00:00",
      "payment_date": "2025-10-05T00:00:00",
      "custom_data": {}
    }
  ],
  "total_elements": 1,
  "total_pages": 1,
  "last": false,
  "first": true,
  "empty": false
}

Ejemplo de consumo

cURL (ambiente QA)

curl --location 'https://ibcobros.apim.qa.frisvy.com/report-manager/v1/reports/instruments?page=0&size=1000' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Scope: ibcobros.renditionsintrument.read' \
  --header 'Authorization: Bearer eyJraWQiOiJCQVFF...' \
  --data '{
    "collector_document_type": "CUIT",
    "collector_document_number": "30999999999",
    "include_payer_without_cuit": false,
    "exclude_status_list": ["RECHAZADO", "ANULADO"],
    "from_date": "2025-12-01",
    "to_date": "2025-12-07"
  }'

Todas las fechas deben estar en formato ISO 8601 con time zone offset.

Códigos de error

Código HTTP	Descripción
400	Parámetros de la solicitud inválidos.
401	Acceso no autorizado.
404	Recurso no encontrado.
500	Error interno del servidor.

Tablas de referencia

Tabla 1 — Métodos de pago

Id	Descripción
1	B2B
2	Efectivo
3	Tarjeta de crédito
4	Tarjeta de débito
5	Transferencia bancaria
6	Cheque
7	Echeq
8	Echeq de pago diferido
9	Cheque de pago diferido

Tabla 2 — Estados de instrumentos

Id	Descripción
1	ACREDITADO
2	ANULADO
3	REPUDIADO
4	PAGADO
5	RECHAZADO
6	EMITIDO-PENDIENTE
7	ACTIVO
8	ACTIVO-PENDIENTE
9	CUSTODIA

Notas

Todas las fechas usan formato ISO 8601 con zona horaria.
La empresa recaudadora se identifica con collector_document_type y collector_document_number en el body.
Usá exclude_status_list para filtrar estados que no querés recibir (ej. RECHAZADO, ANULADO).