pending, overdue, or already delivered.
Why deadlines exist
Report generation answers how and what. Deadlines answer when and whether it was met. Without a tracking layer, a team can produce perfect reports and still miss a filing window. Nothing in the reporting engine itself knows that a report was due. Deadlines solve a delivery-compliance problem. They turn recurring reporting obligations into tracked, dated commitments so that nothing slips silently:
- Regulatory reporting obligations: many filings must reach a regulator on a fixed schedule. A deadline records that obligation, its recurrence, and its delivery state, so a missed or late filing is visible before it becomes a compliance incident.
- Internal SLAs: recurring business reports often carry internal commitments (“finance receives the monthly close pack by the 5th”). Deadlines make those commitments explicit and measurable.
- Audit trails for delivery: each deadline records
deliveredAtand moves throughpending→overdue→delivered. It leaves an auditable history of when each obligation was satisfied, not just that a report exists.
Who uses deadlines
Deadlines are a business and compliance tool layered on top of the reporting engine. Typical users include:
- A fintech delivering regulatory reports to BACEN on fixed monthly or annual schedules. It uses deadlines to track and meet each filing window.
- A treasury or finance team tracking recurring monthly report deliveries, using the calendar and status view to confirm each routine output went out on time.
- A compliance officer monitoring overdue obligations across the organization, filtering by
overduestatus to catch anything at risk before it escalates.
How deadlines fit the Reporter workflow
Deadlines wrap around reports and data sources to add a delivery status layer on top of the reporting engine. Data Sources provide the data, Templates define the output, and the reporting lifecycle produces the file. A deadline sits above all of that. It optionally links to the template that fulfills the obligation, watches the due date, and exposes a single status. The status tells the business whether the obligation has been met. Deadlines are non-intrusive. They never trigger, generate, or submit a report. They observe and record. You still generate reports through the normal lifecycle, and the deadline records the delivery status.
What a deadline tracks
Each deadline captures the due date for a report obligation plus the metadata your team needs to manage it:
Reporter also maintains read-only fields on each deadline:
id, status (pending, overdue, or delivered), deliveredAt, templateName, createdAt, and updatedAt.
Include an
Authorization: Bearer <token> header on every deadline request if your environment enables Access Manager.Creating a deadline
Create a deadline with the Create a Deadline endpoint (
POST /v1/deadlines).
The required fields are name, type, frequency, dueDate, and color. The remaining fields are optional. Set templateId to link the deadline to the template that fulfills it, and notifyDaysBefore to control when reminders begin.
201 Created with the full deadline, including its generated id and an initial status.
Listing deadlines
Retrieve deadlines with the Retrieve Deadlines endpoint (
GET /v1/deadlines). The endpoint paginates results, and you can filter them by status.
For example, to list overdue deadlines, ten per page:
items array plus page, limit, and total for pagination.
Updating a deadline
Update an existing deadline with the Update a Deadline endpoint (
PATCH /v1/deadlines/{id}). The endpoint changes only the fields in the request body, so you can send a partial payload. For example, push back a due date or deactivate a deadline:
200 OK with the updated deadline.
Deleting a deadline
Remove a deadline you no longer need to track with the Delete a Deadline endpoint (
DELETE /v1/deadlines/{id}). A successful request returns 204 No Content.
Marking a deadline as delivered
After you file or send the report behind a deadline, mark the deadline as delivered. Use the Deliver a Deadline endpoint (
PATCH /v1/deadlines/{id}/deliver). It moves the deadline’s status to delivered and stamps deliveredAt.
delivered is a boolean, the same endpoint can also reverse the action. Send "delivered": false to reopen a deadline that you marked delivered by mistake. A successful request returns 200 OK with the updated deadline.
Delivering a deadline only tracks the obligation. It records that the obligation was met. It does not generate or submit the underlying report. Generate the report through the reporting lifecycle, then mark the deadline delivered to keep your tracker accurate.
How deadlines fit the workflow
A typical obligation moves through these states:
1
Create the deadline
Register the obligation with its due date, frequency, and optional template.
2
Track its status
It shows as
pending until the due date, then overdue if you do not deliver the report in time.3
Generate the report
Produce the report through the normal reporting lifecycle, using the linked template.
4
Mark it delivered
Call the deliver endpoint to set
status to delivered and record deliveredAt.Next steps
Getting started with Reporter
Walk through the reporting lifecycle that deadlines track.
Using Reporter
Build the templates that fulfill your deadlines.
BACEN templates
Ready-to-use templates for Brazilian regulatory reporting.
Deadlines API
Full request and response reference for every deadline endpoint.