List cartolas

get

https://api.cardda.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

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

_end

integer

≥ 0

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

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

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

year

integer

Filter by year.

month

integer

Filter by month (1-12).

Headers

company-id

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.

Responses

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of cartolas

400Bad Request — the query used an unknown filter field or malformed filter DSL.