v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cash

Consulta extrato de recebíveis

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

get/baas/v1/cash/companies/{companyId}/extract

Path parameters

companyIdinteger required

Example:41006982

Identificador da empresa

Query parameters

dateFromstring date required

Example:2027-06-01

Data inicial do período (YYYY-MM-DD)

dateTostring date required

Example:2027-06-30

Data final do período (YYYY-MM-DD)

Response

Extrato retornado com sucesso

versionstring required

statusinteger required

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "Balances": [
      {
        "value": 35,
        "friendlyDescription": "Recebimento Cartão de Crédito - Transação 246",
        "createdAt": "2026-06-26 19:23:26",
        "groupPaymentType": "subacquirer",
        "paymentType": "subacquirerCredit",
        "transactionId": 246
      }
    ],
    "Totals": {
      "initial": 20000,
      "final": 30040.83
    }
  }
}