> ## 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.

# Listar transações



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: ''
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /financial/transactions:
    get:
      tags:
        - Financial
      summary: Listar transações
      parameters:
        - schema:
            type: string
          in: query
          name: page
          required: false
          description: Página
        - schema:
            type: string
          in: query
          name: limit
          required: false
          description: Itens por página
        - 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
          in: query
          name: periodType
          required: false
          description: monthly, annual ou custom
        - schema:
            type: string
          in: query
          name: startDate
          required: false
          description: Data inicial
        - schema:
            type: string
          in: query
          name: endDate
          required: false
          description: Data final
        - 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: orderBy
          required: false
          description: Ordenação
        - schema:
            type: string
          in: query
          name: orderByField
          required: false
          description: Campo de ordenação
        - 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: date
          required: false
          description: Data
        - schema:
            type: string
          in: query
          name: personId
          required: false
          description: ID da pessoa
        - schema:
            type: string
          in: query
          name: accountId
          required: false
          description: ID da conta
        - schema:
            type: string
          in: query
          name: lawSuitId
          required: false
          description: ID do processo
        - schema:
            type: string
          in: query
          name: month
          required: false
          description: Mês
        - schema:
            type: string
          in: query
          name: year
          required: false
          description: Ano
        - schema:
            type: string
          in: query
          name: start
          required: false
          description: Início do período
        - schema:
            type: string
          in: query
          name: end
          required: false
          description: Fim do período
        - 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:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID da transação
                        transactionId:
                          type: string
                          format: uuid
                          description: ID da transação
                        description:
                          type: string
                          description: Descrição
                        type:
                          type: string
                          description: incoming ou outcoming
                        value:
                          type: number
                          description: Valor
                        partialValue:
                          type: number
                          nullable: true
                          description: Valor parcial
                        date:
                          anyOf:
                            - type: string
                            - type: string
                              format: date-time
                          description: Data
                        paymentDate:
                          anyOf:
                            - type: string
                            - type: string
                              format: date-time
                          nullable: true
                          description: Data de pagamento
                        officeId:
                          type: string
                          format: uuid
                          description: ID do escritório
                        personId:
                          type: string
                          format: uuid
                          nullable: true
                          description: ID da pessoa
                        billId:
                          type: string
                          format: uuid
                          nullable: true
                          description: ID da conta
                        categoryId:
                          type: string
                          format: uuid
                          nullable: true
                          description: ID da categoria
                        lawSuitId:
                          type: string
                          format: uuid
                          nullable: true
                          description: ID do processo
                        isPaid:
                          type: boolean
                          description: Pago
                        isFixed:
                          type: boolean
                          description: Fixa
                        hasScheduling:
                          type: boolean
                          description: Possui parcelamento
                        installmentLabel:
                          type: string
                          nullable: true
                          description: Rótulo da parcela
                        annotations:
                          type: string
                          nullable: true
                          description: Anotações
                        billName:
                          type: string
                          description: Nome da conta
                        billIcon:
                          type: string
                          description: Ícone da conta
                        billIsPrivate:
                          type: boolean
                          description: Conta privada
                        categoryName:
                          type: string
                          nullable: true
                          description: Nome da categoria
                        categoryColor:
                          type: string
                          nullable: true
                          description: Cor da categoria
                        categoryIcon:
                          type: string
                          nullable: true
                          description: Ícone da categoria
                        personName:
                          type: string
                          nullable: true
                          description: Nome da pessoa
                        lawSuitProcessNumber:
                          type: string
                          nullable: true
                          description: Número do processo
                        isExternalGateway:
                          type: boolean
                          description: Gateway externo
                        gateway:
                          type: object
                          properties:
                            kind:
                              type: string
                              enum:
                                - PAYMENT
                                - INSTALLMENT
                                - SUBSCRIPTION
                            value:
                              type: number
                            createdAt:
                              type: string
                            status:
                              type: string
                            dueDate:
                              type: string
                            paymentDate:
                              type: string
                              nullable: true
                            installmentNumber:
                              type: number
                              nullable: true
                            discount:
                              type: object
                              properties:
                                value:
                                  type: number
                                dueDateLimitDays:
                                  type: integer
                                  exclusiveMinimum: true
                                  minimum: 0
                                type:
                                  type: string
                                  enum:
                                    - FIXED
                                    - PERCENTAGE
                              additionalProperties: false
                            fine:
                              type: object
                              properties:
                                value:
                                  type: number
                                type:
                                  type: string
                                  enum:
                                    - FIXED
                                    - PERCENTAGE
                              additionalProperties: false
                            interest:
                              type: object
                              properties:
                                value:
                                  type: number
                              additionalProperties: false
                            invoiceUrl:
                              type: string
                            gatewayPaymentUrl:
                              type: string
                          required:
                            - kind
                            - value
                            - createdAt
                            - status
                            - dueDate
                            - paymentDate
                            - installmentNumber
                            - discount
                            - fine
                            - interest
                            - invoiceUrl
                            - gatewayPaymentUrl
                          additionalProperties: false
                          nullable: true
                          description: Dados do gateway
                      required:
                        - description
                        - type
                        - value
                        - date
                        - officeId
                        - isPaid
                      additionalProperties: true
                    description: Transações
                  totals:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total
                      incoming:
                        type: number
                        description: Entradas
                      outcoming:
                        type: number
                        description: Saídas
                    required:
                      - total
                      - incoming
                      - outcoming
                    additionalProperties: false
                    description: Totais
                  chartIncome:
                    type: object
                    properties:
                      partialValue:
                        type: number
                        description: Valor parcial
                      totalValue:
                        type: number
                        description: Valor total
                    required:
                      - partialValue
                      - totalValue
                    additionalProperties: false
                    description: Gráfico de entradas
                  chartOutcome:
                    type: object
                    properties:
                      partialValue:
                        type: number
                        description: Valor parcial
                      totalValue:
                        type: number
                        description: Valor total
                    required:
                      - partialValue
                      - totalValue
                    additionalProperties: false
                    description: Gráfico de saídas
                  totalResults:
                    type: number
                    description: Total de registros
                  totalPages:
                    type: number
                    description: Total de páginas
                  currentPage:
                    type: number
                    description: Página atual
                required:
                  - data
                  - totals
                  - chartIncome
                  - chartOutcome
                  - totalResults
                  - totalPages
                  - currentPage
                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.

````