Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Cartola

List 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.

get/v1/cartolas

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring
Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

yearinteger

Filter by year.

monthinteger

Filter by month (1-12).

Headers

company-idstring uuid required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Response

Paginated list of cartolas

idstring uuid required
company_idstring uuid
monthinteger required
yearinteger required
total_incomestring nullable

Total income in the period (decimal).

total_outcomestring nullable

Total outcome in the period (decimal).

initial_balancestring nullable

Opening balance for the period.

final_balancestring nullable

Closing balance for the period.

stampobject nullable

Metadata about the generated document stamp.

pdfobject nullable

Metadata about the generated PDF document.

document_attachedboolean

Whether a generated statement document is currently attached.

cardda_transaction_idsstring[]

Ids of the accounting-ledger transactions assigned to this cartola. Present on the show response only.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "0b1c2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "company_id": "550e8400-e29b-41d4-a716-446655440000",
    "month": 5,
    "year": 2025,
    "total_income": "1250000.0",
    "total_outcome": "-980000.0",
    "document_attached": true
  }
]