> ## Documentation Index
> Fetch the complete documentation index at: https://juridiqsoftware.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Relatório mensal de transações por categoria



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/by-tags/monthly-report
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /financial/transactions/by-tags/monthly-report:
    get:
      tags:
        - Financial
      summary: Relatório mensal de transações por categoria
      parameters:
        - schema:
            type: string
          in: query
          name: start
          required: false
          description: Data inicial
        - schema:
            type: string
          in: query
          name: end
          required: false
          description: Data final
        - schema:
            type: string
          in: query
          name: startPeriod
          required: false
          description: Período inicial (alternativo)
        - schema:
            type: string
          in: query
          name: endPeriod
          required: false
          description: Período final (alternativo)
        - schema:
            type: string
          in: query
          name: query
          required: false
          description: Busca geral
        - schema:
            type: string
          in: query
          name: descriptionSearch
          required: false
          description: Busca por descrição
        - schema:
            type: string
          in: query
          name: clientSearch
          required: false
          description: Busca por cliente
        - schema:
            type: string
          in: query
          name: categoryId
          required: false
          description: ID da categoria
        - schema:
            type: string
          in: query
          name: type
          required: false
          description: incoming ou outcoming
        - schema:
            type: string
          in: query
          name: billId
          required: false
          description: ID da conta
        - schema:
            type: string
          in: query
          name: status
          required: false
          description: paid ou pending
        - schema:
            type: string
            enum:
              - date
              - paymentAt
          in: query
          name: dateFilterType
          required: false
          description: Campo de data
        - schema:
            type: string
            enum:
              - date
              - paymentDate
          in: query
          name: periodByDate
          required: false
          description: Período por data
        - schema:
            type: string
          in: query
          name: description
          required: false
          description: Descrição
        - schema:
            type: string
          in: query
          name: value
          required: false
          description: Valor
        - schema:
            type: string
          in: query
          name: personId
          required: false
          description: ID da pessoa
        - schema:
            type: string
          in: query
          name: lawSuitId
          required: false
          description: ID do processo
        - schema:
            type: string
          in: query
          name: isPaid
          required: false
          description: true ou false
        - schema:
            type: string
          in: query
          name: isDefaulters
          required: false
          description: true ou false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  periods:
                    type: array
                    items:
                      type: string
                    description: Períodos
                  totalsByPeriod:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        income:
                          type: number
                          description: Entradas
                        expense:
                          type: number
                          description: Saídas
                        balance:
                          type: number
                          description: Saldo
                      required:
                        - income
                        - expense
                        - balance
                      additionalProperties: false
                    description: Totais por período
                  grandTotals:
                    type: object
                    properties:
                      income:
                        type: number
                        description: Entradas
                      expense:
                        type: number
                        description: Saídas
                      balance:
                        type: number
                        description: Saldo
                    required:
                      - income
                      - expense
                      - balance
                    additionalProperties: false
                    description: Totais gerais
                  rows:
                    type: array
                    items:
                      type: object
                      properties:
                        categoryId:
                          type: string
                          description: ID da categoria
                        categoryName:
                          type: string
                          description: Nome da categoria
                        billId:
                          type: string
                          format: uuid
                          description: ID da conta
                        billName:
                          type: string
                          description: Nome da conta
                        totals:
                          type: object
                          properties:
                            income:
                              type: number
                              description: Entradas
                            expense:
                              type: number
                              description: Saídas
                            balance:
                              type: number
                              description: Saldo
                          required:
                            - income
                            - expense
                            - balance
                          additionalProperties: false
                          description: Totais da linha
                        months:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              income:
                                type: number
                                description: Entradas
                              expense:
                                type: number
                                description: Saídas
                              balance:
                                type: number
                                description: Saldo
                            required:
                              - income
                              - expense
                              - balance
                            additionalProperties: false
                          description: Totais por mês
                      required:
                        - categoryId
                        - categoryName
                        - totals
                        - months
                      additionalProperties: false
                    description: Linhas do relatório
                required:
                  - periods
                  - totalsByPeriod
                  - grandTotals
                  - rows
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.