Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Cartola

Retrieve one cartola

Returns a single cartola by id, including the ids of the accounting-ledger transactions assigned to it (cardda_transaction_ids). Requires the transactions_view permission.

get/v1/cartolas/{cartola_id}

Path parameters

cartola_idstring uuid required

The id of the cartola (monthly account statement).

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

The requested cartola

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
}