---
title: "Read Collexus Return File"
method: GET
path: "/integrations/collexus/return-file"
tags: ["integrations", "collexus"]
---

# Read Collexus Return File

`GET /integrations/collexus/return-file`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/integrations/collexus/return-file`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Generate one day's activity return file and report it, without uploading.

How the agreed format gets checked before anything lands in the creditor's
folder: the response carries the complete CSV, its digest and its row
count, and the scheduled delivery sweep is not involved. Generating is
free of side effects, so this is safe to call repeatedly and on a day that
has already been delivered — it says so, and the delivery itself stays
refused.

Admin-only because the file is customer data by nature: references, phone
numbers and call summaries, the same exposure as the accounts CSV export.
It answers cleanly on a deployment that produces no return file at all,
reporting the agreed column order either way.

## Query parameters

- `business_date` string, date, nullable: Creditor-local day to cover (see COLLEXUS_RETURN_FILE_TIMEZONE). Defaults to the most recent complete local day — the one a delivery pass right now would be filing.

## Response `200`

Successful Response

- CollexusReturnFileResponse: One generated activity return file, reported without being uploaded. ``csv_text`` is the complete file exactly as it would be delivered, so the agreed format can be checked before anything reaches the creditor's folder. It therefore carries customer phone numbers, references and call summaries — the same admin-only exposure as ``GET /accounts/export``, and the reason this route is gated to admins.
  - `status` 'ok' | 'not_configured', required
  - `detail` string, required
  - `business_date` string, date, nullable
  - `timezone` string, nullable
  - `scenarios` string[]
  - `filename` string, nullable
  - `remote_path` string, nullable
  - `row_count` integer, nullable
  - `byte_size` integer, nullable
  - `content_sha256` string, nullable
  - `columns` string[]
  - `delivered_at` string, date-time, nullable
  - `delivered_sha256` string, nullable
  - `csv_text` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/whispa/apis/whispa-api.md) - [All operations](https://skmtc.dev/whispa/apis/whispa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whispa/apis/whispa-api/revisions/12c2e4aca43c?raw)