Extratos e relatórios — /consolidation (descontinuado)

WARNING

Sem equivalente na API v1 ainda.

Todas 🔒 (Authorization: Bearer <token>), operam sobre a conta ativa. Valores em reais. Transações têm status: 1 = confirmada, 2 = pendente, 4 = estornada, 5 = cartão.

Parâmetros de data comuns de listagem: created_at_start/_end (YYYY-MM-DD), payment_date_start/_end (YYYY-MM-DD, obrigatórios juntos, intervalo ≤ 45 dias), type/type_id/type_ids[], search (≤100), status (-1,0,1,2,3), per_page, page.

---

Saldo

GET /consolidation/balance

Entrada: header Authorization. Saída: 200 { "balance": 1523.45 }.

GET /consolidation/balance-days

Entrada: header Authorization. Saída: 200 — a conta com dailysBalances (saldo por dia) e as transactions de cada dia carregadas.

GET /consolidation/v2/transactions/balance-summary

Entrada (query): group_by (obrigatório, days|months), date_start (obrigatório), date_end (obrigatório, ≥ start). Saída: 200:

{
 "data": [ { "period":"2026-09-01","sum":300,"running_balance":300,"income":500,"expenses":-200,
 "income_count":3,"expenses_count":1,"transactions_count":4,
 "transactions_in":[...],"transactions_out":[...] } ],
 "resume": { "period":"total","sum":300,"running_balance":300,"income":500,"expenses":-200,
 "income_count":3,"expenses_count":1,"transactions_count":4 }
}

---

Transações

GET /consolidation/transactions

Entrada (query): filtros de listagem. Saída: 200:

{
 "data": [ transação ],
 "sumary": { "total_transactions": 120, "income_value": 5000, "expenses_value": -1200 },
 "meta": { "current_page": 1, "per_page": 15, "total": 120, "last_page": 8 }
}

GET /consolidation/transactionsV2

Entrada (query): filtros + fromDate/toDate. Saída: 200 — { data: [transações], current_page, total_pages, per_page, total, next_page_url, prev_page_url, … } (objeto de paginação com muitos aliases).

GET /consolidation/transactions-v2

Entrada (query): status (default 1), datetime_start_date/datetime_end_date, created_start_date/created_end_date, per_page, page. Saída: 200:

{ "data": [ …transações… ],
 "summary": [ { "type_id": 1, "count": 8, "amount_sum": 4000, "type": {...} } ],
 "pagination": { "current_page":1,"per_page":15,"total":120,"last_page":8 } }

GET /consolidation/transaction?id=

Entrada (query): id. Saída: 200 — detalhe de uma transação.

GET /consolidation/transaction/{id}/generate-pdf

Entrada: path id; query download (bool — attachment vs inline). Saída: 200, application/pdf, filename transacao-{id}-<timestamp>.pdf.

GET /consolidation/transactions/totals

Entrada (query): start_date (default −30 d), end_date (default hoje). Saída: 200 { "pix_in": …, "boleto_in": …, "bolepix_in": …, "pix_out": …, "balance": … }.

GET /consolidation/transactions/grouped-by-method

Entrada (query): start_date, end_date, type_id (opcionais). Saída: 200 { "success": true, "data": [ { "type": {...}, "type_id": 1, "type_name": "Pix In", "type_slug": "pix-in", "total_value": 4000, "total_transactions": 8 } ] }.

GET /consolidation/transaction-types

Entrada: —. Saída: 200 — JSON string com todos os tipo de transação (cacheado 60 min).

GET /consolidation/methods-payment

Entrada: —. Saída: 200, data = array de métodos de pagamento (PaymentMethod::values), message: "Metodos de Pagamento".

GET /consolidation/get-settlement-statement

Entrada (query): start_date (opcional; default: fim do mês anterior). Saída: 200 { "total_received": 12000, "start_date": "2026-08-31" } (soma de type_id 1 e 7 confirmados).

GET /consolidation/transactions/sales-per-month

Entrada (query): start_date (−30 d), end_date (hoje). Saída: 200 — array { date, balance, balance_in, balance_out, balance_boleto } por dia.

GET /consolidation/transactions/sales-per-month-group-month

Entrada: —. Saída: 200 — objeto de gráfico { labels: ["Janeiro",…], datasets: [ { label:"Transações", backgroundColor:"#42A5F5", data:[…] } ] } (tipos 1, 6, 11; cacheado 60 min).

---

Extrato

GET /consolidation/extract

Entrada (query): start_date/end_date ou fromDate/toDate (default: hoje), search (≤255), type (id de tipo), per_page (1–10000, default 1000), page. Saída: 200:

{
 "summary_by_type": [ { "type_id":1,"type_slug":"pix-in","type_name":"Pix In","qtd":8,"total":4000 } ],
 "transactions": { "data": [...], "current_page":1,"last_page":1,"per_page":1000,"total":8 },
 "totals": { "total_positives":4000,"total_negatives":-1200,"total_count":9,"balance":2800 },
 "period": { "start_date":"2026-09-01","end_date":"2026-09-08" }
}

422 em datas inválidas.

POST /consolidation/extract/export-document

Entrada (corpo JSON): start_date (obrigatório, data), end_date (obrigatório, ≥ start; período ≤ 60 dias). Saída: 200 { "message": "A exportação do seu documento foi iniciada. …" } (PDF gerado em background e enviado por notificação). 422 se o período > 2 meses.

GET /consolidation/transactions/statement-detailed

Extrato com saldo de abertura/fechamento por dia, paginado por datas. Entrada (query): created_at_start/_end (default: −30 d … hoje), per_page (datas por página, default 15), page. Saída: 200, data = paginação de dias:

[ { "date":"2026-09-01","opening_balance":1000,"closing_balance":1300,
 "transactions":[ { "id":1,"datetime":"…","description":"…","value":300,"balance":1300,"type":{...},"metadata":null } ] } ]

GET /consolidation/transactions/extract

Entrada (query): payment_date_start (obrigatório), payment_date_end (obrigatório, ≥ start); demais filtros opcionais. Saída: 200:

{
 "data": [ { "date":"2026-09-01","transactions":[transação],"transactions_count":4,
 "summary":{ "day_total":300,"balance_end_of_day":1300 } } ],
 "summary": { "balance":1300,"total_transactions":12,
 "by_type":[ { "type_id":1,"type_name":"Pix In","count":8,"total":4000 } ] }
}

POST /consolidation/transactions/export-document

Entrada (query/corpo): format (xlsx|csv|pdf, default xlsx), download (bool), search, type, created_at_start/_end. Saída: com download=true → arquivo. Sem → 200 { message: "A exportação foi iniciada. …" } (envia notificação). 404 se nada encontrado; 422 formato inválido.

---

Estatísticas (gráficos)

POST /consolidation/statistic/balance · /consolidation/statistic/cards

Entrada (corpo JSON):

Campo	Tipo	Regras
cards	array	obrigatório — quais métricas retornar: PIXS_COUNT, BOLETOS_COUNT, CLIENTS_COUNT, CHARGE_COUNT_PAID, PIX_IN_SUM, CHARGE_SUM_PAID, PIX_OUT_SUM, TOTAL_CHARGE_EXPECTED_TO_RECEIVE
start_date	date	opcional
end_date	date	opcional

Saída: 200 — objeto com apenas as chaves pedidas em cards, ex.:

{ "PIXS_COUNT": 42, "PIX_IN_SUM": 12000, "CHARGE_COUNT_PAID": 15 }

GET /consolidation/statistic/boletos

Entrada (query): group_by (day|month|year, default month). Saída: 200 — array { date_group, qtd_pending, qtd_paid, qtd_cancelled, qtd_expired, qtd_failed, qtd_deleted, qtd_paidwithpix } por período.

---

Exportações — download

GET /consolidation/exports/download/{id}

Regenera e baixa um arquivo de exportação a partir de uma notificação (id = id da notificação). Entrada: path id. (O link é público, identificado apenas pelo id do export.) Saída: arquivo (xlsx/csv/pdf) via download. 404 se a notificação/dados não existirem; 400 tipo inválido.

---

Cartão de crédito

GET /consolidation/card-transactions

Extrato das transações de cartão (entradas geradas por cobranças pagas). Entrada (query): status (PENDING|WITHDRAWN), payment_date_start/_end (YYYY-MM-DD), per_page (1–500, default 15). Saída: 200, data = coleção paginada de transações de cartão ({ id, charge:{...,client}, gross_amount, fee_amount, net_amount, status, payment_date }).

GET /consolidation/card-transactions/summary

Entrada (query): payment_date_start/_end. Saída: 200, data:

{ "total": { "count":10,"gross":5000,"fee":250,"net":4750 },
 "pending": { "count":4,"net":1900 },
 "withdrawn": { "count":6,"net":2850 } }

GET /transactions/card

Transações de liquidação (tipo 16) e saque (17) de cartão, status = 5. Entrada (query): page, perPage (1–100, default 15), start_date, end_date (≥ start). Saída: 200 — objeto de resposta paginada com as transações.

GET /transactions/card/balance

Entrada (query): start_date, end_date (≥ start). Saída: 200 { "balance": 1550.75 } (soma dos tipos 16 e 17 com status = 5).

POST /transactions/card/withdraw

Move o saldo de cartão para o saldo principal. Entrada (corpo JSON): amount (obrigatório, ≥0.01). Saída: 200 { "message": "Saque realizado com sucesso.", "amount": 500, "balance": 1050.75, "txid": "<uuid>", "transactions": [...] }. 400 { "error": "Saldo insuficiente." }; 500 em erro de processamento.

---

v2 — /consolidation/v2/*

GET /consolidation/v2/transactions

Entrada (query): created_at_start/_end (default −30 d … hoje), search (busca em txid/endtoend/descrição/pagador/recebedor), type/type_id/type_ids[], per_page, page. Saída: 200, { data: [transações], meta: {...}, statistics: { total_received, total_paid, initial_balance, final_balance, current_balance, period:{start_date,end_date} } }. Cada item traz balance recalculado (running balance).

GET /consolidation/v2/transactions/statement

Entrada (query): igual ao index (created_at_start/_end, type*, per_page, page). Saída: 200, { data: [transações], meta: {...}, statistics: { initial_balance, final_balance, total_received, total_paid, daily_evolution: [ {date,balance,change} ], period, summary: [ {type,slug,quantity,total_value} ] } }.

GET /consolidation/v2/transactions/{id}

Entrada: path id. Saída: 200, data = transação, message: "Transaction details retrieved successfully." 404 se não existir.

GET /consolidation/v2/transactions/{id}/download-pdf

Entrada: path id; query download (bool, default true). Saída: 200, application/pdf, filename transacao-v2-{id}-<timestamp>.pdf.

GET /consolidation/v2/extract

Entrada (query): search, type/type_id/type_ids[], per_page, page. Saída: 200, { data: [transações], meta: {...} } (só status = 1).

GET /consolidation/v2/extract/report/transactions

Histórico de entradas, saídas e taxas por dia. Entrada (query): payment_date_start/_end (default −30 d … hoje), type_id, type_ids[], status. Saída: 200 — coleção de linha de relatório ({ date, type_id, total_value, type:{...} }).

GET /consolidation/v2/extract/report/summary

Entrada (query): payment_date_start/_end. Saída: 200 — coleção de linha de relatório ({ type_id, total_count, total_value, type:{...} }).

GET /consolidation/v2/extract/report/payment-methods

Entrada (query): payment_date_start/_end. Saída: 200 — coleção de linha de relatório ordenada por total_count desc.