---
title: "Consulta extrato de recebíveis"
method: GET
path: "/baas/v1/cash/companies/{companyId}/extract"
tags: ["Cash"]
---

# Consulta extrato de recebíveis

`GET /baas/v1/cash/companies/{companyId}/extract`

Retorna as movimentações (Balances) e os totais (Totals) de uma empresa em um intervalo de datas.

## Path parameters

- `companyId` integer, required

## Query parameters

- `dateFrom` string, date, required
- `dateTo` string, date, required

## Response `200`

Extrato retornado com sucesso

- ExtractSuccessResponse
  - `version` string, required
  - `status` integer, required
  - `body` ExtractBody, required
    - `Balances` BalanceItem[], required
      - `value` number, double, required — Valor da movimentação (positivo para crédito, negativo para débito/estorno)
      - `friendlyDescription` string, required — Descrição amigável da movimentação
      - `createdAt` string, required — Data e hora da movimentação (YYYY-MM-DD HH:mm:ss)
      - `groupPaymentType` string, required — Grupo do tipo de pagamento
      - `paymentType` 'subacquirerCredit' | 'subacquirerDebitTax' | 'subacquirerReversal', required — Tipo específico de pagamento
      - `transactionId` integer, required — Identificador da transação
    - `Totals` Totals, required
      - `initial` number, double, required — Saldo inicial do período
      - `final` number, double, required — Saldo final do período

## Other responses

- `422` — Erro de validação dos parâmetros informados

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)
