DIdirectdigital
Exato - Consumo

List consumption transactions

Lists the completed queries of the token's organization and of all of its child organizations, one item per query, with filters and pagination.

Source: Exato platform data.

Returns: the period sent, the totals of the filtered period (summary: transactions, credits and amount in BRL; first page only), the transactions of the page (transactions) and the cursor of the next page (next_cursor, null on the last page).

Execution: synchronous.

Note:

  • Times are America/Sao_Paulo local time; the period is keyed on the completion time and may span at most 31 days.
  • Next page: send the next_cursor of the previous response in cursor, with the same filters.
  • Authentication: access token of the organization; a missing, invalid, expired or suspended token gets HTTP 401, and a call from an IP outside the token's allowlist gets HTTP 403.
  • At most 2 simultaneous calls per organization (HTTP 429 beyond that). A period too heavy to compute gets HTTP 504: reduce the range or add filters.
  • /tokens/consumption/transactions is an older path for this same route.
post/consumption/organization/transactions

Request

Query parameters

test_modeboolean

true returns simulated data, without querying the source. Queries that do not offer test mode return code 7.

lightweightboolean

Lightweight mode (internal use).

Request body application/x-www-form-urlencoded

fromstring date-time

Start of the period, by completion time, inclusive (America/Sao_Paulo). Format: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss. Required.

tostring date-time

End of the period, by completion time (America/Sao_Paulo). A date without time (or with 00:00:00) includes that whole day and may be at most 30 days after from; with a time, the period ends just before it and may be at most 31 days after from. Format: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss. Required.

typestring

Comma-separated public IDs of query types, as returned in each transaction's type field (lowercase letters, digits and underscores). Optional.

resultstring

Comma-separated public IDs of result types, as returned in each transaction's result field (lowercase letters, digits and underscores). Optional.

documentstring

Exact document queried; a formatted CPF or CNPJ is reduced to digits. Optional.

requested_bystring

Exact requester, case-insensitive; matches the transaction's requested_by_name or requested_by_email. Optional.

only_billableboolean

When true, returns only billable transactions. Optional.

page_sizeinteger

Number of transactions per page. Default 200, maximum 1000.

cursorstring

Cursor returned in next_cursor by the previous page. Omit for the first page.

Response

Success

Changes

No operation changes recorded.