> ## Documentation Index
> Fetch the complete documentation index at: https://developers.pontua.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Lista todas as Unidades de Negócio



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /unidade-negocio
openapi: 3.0.0
info:
  title: Pontua Public API
  description: >-
    API oficial da Pontua para integrações de clientes externos. Autentique com
    o token gerado no dashboard em **Configurações → API**. Envie o token no
    header `Authorization: Bearer <SEU_TOKEN>`.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /unidade-negocio:
    get:
      tags:
        - Unidade de Negócio
      summary: Lista todas as Unidades de Negócio
      operationId: UnidadeNegocioController_getUnidadesNegocio
      parameters:
        - name: searchText
          description: Texto pesquisado para filtrar consulta
          required: false
          in: query
          schema:
            type: string
        - name: pagina
          description: Página que deseja retornar os resultados
          required: false
          in: query
          schema:
            example: 0
            type: number
        - name: limite
          description: Quantidade de itens que retorna na consulta. Min 1 - Max 100
          required: false
          in: query
          schema:
            example: 100
            type: number
        - name: situacao
          description: Campo para filtrar unidade de negocio por sua Situação
          required: false
          in: query
          schema:
            type: array
            items:
              enum:
                - ATIVO
                - INATIVO
                - RASCUNHO
              type: string
        - name: regimeTributario
          description: Campo para filtrar unidade de negocio por seu remime tributario
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - LUCRO_PRESUMIDO
                - SIMPLES_NACIONAL
                - LUCRO_REAL
                - IMUNE
                - ISENTO
                - MEI
                - PRODUTOR_RURAL
                - EMPREGADOR_DOMESTICO
                - LUCRO_ARBITRADO
                - OUTROS
        - name: estado
          description: Campo para filtrar unidade de negocio por seu estado
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
        - name: cidade
          description: Campo para filtrar unidade de negocio por sua cidade
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
        - name: minDataCriacao
          description: Campo para filtrar apenas unidade de negocio criadas após a data
          required: false
          in: query
          schema:
            format: date-time
            type: string
        - name: maxDataCriacao
          description: Campo para filtrar apenas unidade de negocio criadas antes da data
          required: false
          in: query
          schema:
            format: date-time
            type: string
      responses:
        '200':
          description: Unidades de Negócio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnidadeNegocioFindAllDto'
        default:
          description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      deprecated: false
      security:
        - bearer: []
components:
  schemas:
    UnidadeNegocioFindAllDto:
      type: object
      properties:
        maxUnidades:
          type: number
          description: Quantidade de unidades permitidas
          example: 0
        pagina:
          type: number
          description: Pagina retornada dos dados
          example: 0
        limite:
          type: number
          description: Quantidade de itens retornados na consulta
          example: 10
        total:
          type: number
          description: Quantidade total de unidades para consultar
          example: 5
        unidades:
          description: Resultado da consulta
          type: array
          items:
            $ref: '#/components/schemas/UnidadeNegocio'
        cards:
          description: Quantidades de unidades agrupado por tipo
          allOf:
            - $ref: '#/components/schemas/Cards'
      required:
        - maxUnidades
        - pagina
        - limite
        - total
        - unidades
        - cards
    ErrorDto:
      type: object
      properties:
        service:
          type: string
          description: Rota solicitada
        method:
          type: string
          description: Método http
        message:
          description: Mensagem do erro
          oneOf:
            - type: string
              example: message erro
            - type: array
              items:
                type: string
                example:
                  - erro 1
                  - erro 2
      required:
        - service
        - method
        - message
    UnidadeNegocio:
      type: object
      properties:
        unidadeNegocioId:
          type: string
          description: ID referente a unidade de negócio
          example: 1b88e4f3-04bf-4185-b782-9211e4b6bca4
        nome:
          type: string
          description: nome da unidade de negócio
          example: Pontua Matriz
        numeroCadastro:
          type: string
          description: Número cadastrado da unidade de negócio
          example: '12345678912'
        logo:
          type: string
          description: Caminho da logo da unidade de negócio
          example: //logo.png
      required:
        - unidadeNegocioId
        - nome
        - numeroCadastro
    Cards:
      type: object
      properties:
        ativo:
          type: number
          description: Quantidade de unidades ativas
          example: 15
        inativo:
          type: number
          description: Quantidade de unidades inativas
          example: 4
        rascunho:
          type: number
          description: Quantidade rascunhos de unidades de negocio
          example: 2
      required:
        - ativo
        - inativo
        - rascunho

````