Counterparty summary (CSV / XLSX / PDF / preview)

GEThttps://api.veriko.mx/v1/finance/counterparties

Audience: public
Auth: API key
Permission: finance:generate_self

Groups the month's verifications by beneficiary account and bank, with totals, valid count, total amount, and first/last-seen dates. 7 columns: Cuenta beneficiaria, Banco, Verificaciones, Válidas, Monto total, Primera, Última.

format=csv (default, text/csv) / format=xlsx (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet): flat list.
format=pdf (application/pdf): ledger with a Totales row at the bottom (Verificaciones, Válidas, Monto). Capped at 1000 rows.
format=preview (application/json): first 20 rows as FinancePreviewResponse.

What every export shares — the download header, what happens when one fails midway, and the caps — is in exports and formats.

Parameters
Parameter	In	Type	Required	Description
`format`	query	`string`	optional	Output format. `csv` and `xlsx` are spreadsheet data; `pdf` is the document ready to file or send; `preview` returns the same data as JSON, to render on screen without downloading anything. Default: `csv` e.g. `csv`
`limit`	query	`integer`	optional	Trims the number of rows when the output is `csv` or `xlsx`. It only lowers the cap: a value above 100,000, or below 1, leaves it as it was. It does not affect the PDF, which carries its own 1,000-row cap. e.g. `500`
`month`*	query	`string`	required	Month to report in `YYYY-MM` format. e.g. `2026-04`
`user_id`	query	`string (uuid)`	optional	Admins with `finance:generate_all` only. UUID of the user to query. e.g. `f47ac10b-58cc-4372-a567-0e02b2c3d479`

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/finance/counterparties' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`FinancePreviewResponse` — CSV/XLSX/PDF stream, or JSON envelope in preview mode.
Field	Type	Description
`data`	`object`	Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
`type`	`string`	JSON:API resource type (always `finance_preview`). e.g. `finance_preview`
`attributes`	`object`	Report preview fields.
`report`	`string`	Report type: `monthly` — monthly statement; `counterparties` — top counterparties; `by-bank` — bank breakdown; `accounting` — accounting ledger. e.g. `monthly`
`month`	`string`	Report month in YYYY-MM format. e.g. `2026-04`
`headers`	`array`	CSV column names, in the same order as the values in `rows`. e.g. `["Fecha","Monto","Clave de rastreo","Estado"]`
`rows`	`array` (items: ?–20)	First 20 data rows of the report (maximum). e.g. `[["2026-04-15","15000.50","MXBA20260415001234","valid"]]`
`meta`	`object`	Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
`version`	`string`	API version that processed the request. e.g. `1.47.0`
`api_version`	`string`	API route prefix version (e.g. `v1`). e.g. `v1`
`request_id`	`string`	Unique request identifier (hex). e.g. `a1b2c3d4e5f6`
`datetime`	`object`	Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. e.g. `{"timezone":"UTC","format":"ISO 8601"}`
`timezone`*	`string`	Always `UTC` — the canonical timezone for every datetime field in the body. e.g. `UTC`
`format`*	`string`	Always `ISO 8601` — explicit `Z` suffix on every datetime. e.g. `ISO 8601`
`links`	`object`	Pagination or related links, present only when the endpoint returns a paginated collection.

**Response status codes**`GET /v1/finance/counterparties`
Status	Class	Description	Body
200	`2xx`	CSV/XLSX/PDF stream, or JSON envelope in preview mode.	`FinancePreviewResponse`
400	`4xx`	Invalid or missing `month` parameter	`ErrorResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`
500	`5xx`	`pdf_render_failed` — PDF renderer crashed. Try CSV or XLSX.	`ErrorResponse`

**Response headers**`200`
Header	Type	Description
`Cache-Control`	`string`	Disables intermediary caching of the download (does not apply to preview mode).
`Content-Disposition`	`string`	Suggested filename (does not apply in preview mode).

**Errors from `GET /v1/finance/counterparties`**
Status	Code	Example
400	`invalid_month`	'month' is required and must be YYYY-MM. Envelope meta.request_id `d5e6f7a8b9c1`
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c0`