Ctrlk
Status

Extrato com Saldo

Extrato com Saldo

get

Exporta os lançamentos financeiros do vendedor com o saldo da conta após cada lançamento. Os registros são ordenados por data_lancamento de forma crescente.

A resposta é transmitida via streaming: os dados começam a chegar ao cliente assim que o motor analítico inicia a geração do arquivo, sem aguardar a conclusão total do relatório.

O Content-Type da resposta reflete o formato solicitado:

  • csv → text/csv; charset=utf-8
  • json → application/json
  • xlsx → application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Authorizations
X-Token-ApistringRequired

Chave de API do vendedor

Query parameters
export_formatstring · enumOptional

Formato de exportação do relatório

Default: csvPossible values:
date_filterstringOptional

Filtro de data dos lançamentos. Aceita os seguintes formatos:

Períodos nomeados: today, yesterday, thisweek, thismonth, thisquarter, thisyear, lastweek, lastmonth, lastquarter, lastyear

Últimos N períodos: past{N}{unit} onde unit é days, weeks, months, quarters ou years. Adicionar ~ ao final inclui o período corrente (ex: past30days~).

Data específica: YYYY-MM-DD

Intervalo de datas: YYYY-MM-DD~YYYY-MM-DD

Default: past7days~Example: past30days~
Responses
200

Relatório gerado com sucesso (resposta em streaming)

string · binaryOptional
get
/report/statement_with_balance
PreviousCriar Pedido com Autenticação Externa (MPI)NextExtrato (Statement)

Last updated

Was this helpful?