---
title: "List cartolas"
method: GET
path: "/v1/cartolas"
tags: ["Cartola"]
---

# List cartolas

`GET /v1/cartolas`

Returns a paginated list of the company's cartolas (monthly account statements). By default
results are ordered by year and month descending. Each item reports whether a generated
statement document is currently attached (`document_attached`). Requires the
`transactions_view` permission on the company.

## Query parameters

- `_start` integer
- `_end` integer
- `_order` 'asc' | 'desc'
- `_field` string
- `year` integer
- `month` integer

## Headers

- `company-id` string, uuid, required

## Response `200`

Paginated list of cartolas

- Cartola[]
  - `id` string, uuid, required
  - `company_id` string, uuid
  - `month` integer, required
  - `year` integer, required
  - `total_income` string, nullable — Total income in the period (decimal).
  - `total_outcome` string, nullable — Total outcome in the period (decimal).
  - `initial_balance` string, nullable — Opening balance for the period.
  - `final_balance` string, nullable — Closing balance for the period.
  - `stamp` object, nullable — Metadata about the generated document stamp.
  - `pdf` object, nullable — Metadata about the generated PDF document.
  - `document_attached` boolean — Whether a generated statement document is currently attached.
  - `cardda_transaction_ids` string[] — Ids of the accounting-ledger transactions assigned to this cartola. Present on the show response only.
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `400` — Bad Request — the query used an unknown filter field or malformed filter DSL.
- `401` — Unauthorized

---

[API](https://skmtc.dev/cardda/apis/banking-api.md) · [All operations](https://skmtc.dev/cardda/apis/banking-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cardda/banking-api/revisions/ff1aeb3fda8b/schema)