Obtém extrato financeiro do estabelecimento.

GET /api/{userId}/establishment/{establishmentId}/financial/extract

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento

Requisição

• Método: GET
• Path: /api/\{userId\}/establishment/\{establishmentId\}/financial/extract
• Headers: Authorization, Accept: application/json
• Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

Nome	Tipo	Descrição
startDate	string (YYYY-MM-DD)	Data inicial do período. Obrigatório.
endDate	string (YYYY-MM-DD)	Data final do período. Obrigatório.
startTime	string (HH:MM:SS)	Hora inicial. Padrão: 00:00:00.
endTime	string (HH:MM:SS)	Hora final. Padrão: 23:59:59.
costCenter	number	Filtra pelo costCenterId da categoria.
category	number	Filtra pelo categoryId da transação.
paymentMethod	number	Filtra pelo establishmentPaymentMethodId.
transactionType	number	1 = entrada (receita), 2 = saída (despesa).
page	number	Número da página. Padrão: 1.

A rota considera transações pendentes pela data de previsão, confirmadas/pagas pela data de pagamento e canceladas pela data da transação.

Resposta

• Status: 200 OK
• Content-Type: application/json

Exemplo de resposta

{
  "response": "success",
  "data": {
    "content": [
      {
        "transactionId": "12020260419143211",
        "cashierId": 845,
        "storeCashierId": null,
        "establishmentId": 1234,
        "sourceId": null,
        "amount": 120.00,
        "transactionDateTime": "2026-04-19 14:32:11",
        "paymentDateTime": "2026-04-19 14:32:11",
        "previsionDateTime": "2026-04-19 14:32:11",
        "confirmationDateTime": "2026-04-19 14:32:11",
        "description": "Mensalista - Maria Oliveira",
        "accountId": 55,
        "categoryId": 201,
        "nfseStatus": null,
        "nfseLink": null,
        "paymentMethodId": 17,
        "situationId": 3,
        "lastSync": "2026-04-19 14:32:12",
        "categorySourceId": 1,
        "transactionTypeId": 1,
        "orderDateTime": "2026-04-19 14:32:11"
      },
      {
        "transactionId": "12020260418101553",
        "cashierId": 842,
        "storeCashierId": null,
        "establishmentId": 1234,
        "sourceId": null,
        "amount": -250.00,
        "transactionDateTime": "2026-04-18 10:15:53",
        "paymentDateTime": "2026-04-18 10:15:53",
        "previsionDateTime": "2026-04-18 10:15:53",
        "confirmationDateTime": "2026-04-18 10:15:53",
        "description": "Pagamento de fornecedor",
        "accountId": 55,
        "categoryId": 312,
        "nfseStatus": null,
        "nfseLink": null,
        "paymentMethodId": 18,
        "situationId": 2,
        "lastSync": "2026-04-18 10:15:54",
        "categorySourceId": 3,
        "transactionTypeId": 2,
        "orderDateTime": "2026-04-18 10:15:53"
      }
    ],
    "total": 124,
    "perPage": 20,
    "currentPage": 1,
    "lastPage": 7
  }
}

Principais situações (situationId)

Valor	Descrição
1	Pendente
2	Confirmada
3	Paga/Recebida
4	Cancelada
5	Faturada (pós-paga)
6	Incluída em fatura fechada