Cobre’s Report Scheduler API extends the Reports API by enabling automated and recurring report generation.
This cross-feature service allows clients to define schedules that automatically generate reports without manual intervention, ensuring that operational and financial data is always available at the right time.

Report Schedulers centralize the configuration and lifecycle of automated reports, making them ideal for reconciliation processes, operational controls, and bank-facing integrations that require periodic data delivery.

Creating Report Schedulers

Report Schedulers are created through the Create Report Scheduler API (POST /v1/report_schedulers).
This endpoint allows clients to define:

The resource to generate reports from

The scheduler layout, which defines the scheduling behavior

Required metadata associated with the scheduler configuration

Once created, the scheduler will automatically generate reports according to its predefined execution pattern.

Report Schedulers Catalog

The following catalog describes all available scheduler configurations and the reports they generate.

Account-Based Schedulers

These schedulers generate reports related to Cobre Balance accounts.

Resource	Geo	Scheduler Layout	Account Provider ID	Generated Reports (file_layout)
accounts	COL	cobre_balance_multicash_v1	pr_col_cobre	cobre_balance_multicash_header_v1 cobre_balance_multicash_detail_v1

The cobre_balance_multicash_v1 scheduler generates two reports per execution: a header file and a detail file.

Scheduler Layouts

The scheduler layout defines how and when reports are generated.

Layout	Country	Description
cobre_balance_multicash_v1	Colombia	Generates the daily Multicash report for Cobre Balance COL accounts. The scheduler runs at 05:00 a.m. COT (10:00 a.m. UTC) for the previous business day, using a consecutive range from 1–9999 and producing output compatible with banking systems.

Actions performed on Report Schedulers

🧾 Create

🔍 Retrieval

🧹 Delete

Description: Create a new report scheduler configuration.

What to expect after the action:
A Report Scheduler object in active state, including:

id (e.g., reps_xxxxx)

active_status

schedule_pattern

resource and layout

metadata

created_at and updated_at

📘 Learn more: POST /v1/report_schedulers

Report Scheduler Object

A Report Scheduler represents an automated configuration that triggers report generation on a recurring basis.

Key Attributes

Field	Description
id	Unique identifier of the scheduler (`reps_XXXXX`)
active_status	Indicates whether the scheduler is active
schedule_pattern	Cron-based execution pattern
resource	Resource used to generate reports
layout	Scheduler layout applied
execution_number	Number of times the scheduler has executed
metadata	Additional configuration (e.g., account_id)
created_at	Creation timestamp
updated_at	Last update timestamp

How to Get Started

Before using the Report Scheduler API, consider the following steps:

Identify automation requirements

Determine which reports need to be generated automatically and at what frequency.

Select the appropriate scheduler layout

Choose a scheduler layout from the Report Schedulers Catalog that matches your use case.

Prepare required metadata

Ensure all required metadata fields (such as account_id) are available before creating the scheduler.

Create the report scheduler

Use the Create Report Scheduler API to activate automated report generation.

Monitor generated reports

Retrieve and download generated reports through the Reports API.

What to expect after using this API

Automated report generation

Reports will be generated automatically according to the defined schedule without manual intervention.

Operational consistency

Ensure reports are always generated at the same time with the same configuration.

Reduced operational overhead

Eliminate manual report creation for recurring workflows.

Seamless integration with Reports API

Generated reports follow the same lifecycle as manually created reports and can be retrieved and downloaded using standard Reports endpoints.

Get more details about the technical implementation of scheduled reports through the following resources:

Report Scheduler API

Learn how to create, retrieve, and manage report schedulers, including scheduler layouts, metadata requirements, and lifecycle states.

Reports API

Review the Reports API to understand how scheduled reports are generated, retrieved, and downloaded once created by a scheduler.

Report Scheduler

Creating Report Schedulers#

Report Schedulers Catalog#

Scheduler Layouts#

Actions performed on Report Schedulers#

Report Scheduler Object#

Key Attributes#

How to Get Started#

What to expect after using this API#

Related API Documentation#

Creating Report Schedulers

Report Schedulers Catalog

Scheduler Layouts

Actions performed on Report Schedulers

Report Scheduler Object

Key Attributes

How to Get Started

What to expect after using this API

Related API Documentation