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

# Coleta principais dados da unidade de negócio



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /unidade-negocio/{unidadeNegocioId}
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/{unidadeNegocioId}:
    get:
      tags:
        - Unidade de Negócio
      summary: Coleta principais dados da unidade de negócio
      operationId: UnidadeNegocioController_coletarDadosUnidade
      parameters:
        - name: unidadeNegocioId
          required: true
          in: path
          description: ID da unidade de negócio
          schema:
            type: string
      responses:
        '200':
          description: Dados da unidade de negócio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DadosUnidadeDto'
        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:
    DadosUnidadeDto:
      type: object
      properties:
        unidadeNegocioId:
          type: string
          description: ID da unidade de negócio
          example: '1234567890'
        nome:
          type: string
          description: Nome da unidade de negócio
          example: Transportadora Brasil Ltda
        step:
          type: string
          description: Step de configuração
          enum:
            - DADOS
            - CONTATO
            - PERSONALIZACAO
            - CONCLUIDO
          default: DADOS
        status:
          type: string
          description: Status da unidade de negócio
          default: RASCUNHO
          enum:
            - ATIVO
            - INATIVO
            - RASCUNHO
        tipoIdentificacao:
          type: string
          description: Tipo de identificação
          default: CNPJ
          enum:
            - CNPJ
            - CPF
        numeroCadastro:
          type: string
          description: CPF ou CNPJ
          example: 36.937.877/0001-08
        email:
          type: string
          description: Email da unidade de negócio
          example: unidade.go@tbrasil.com.br
        emailNotificacao:
          type: string
          description: Email de notificações da unidade de negócio
          example: unidade.go@tbrasil.com.br
        endereco:
          type: string
          description: Endereço da unidade de negócio
        logo:
          type: string
          description: Caminho da logo da unidade de negócio
          example: //logo.png
        colaboradores:
          description: Quantidade de colaboradores vinculados
          allOf:
            - $ref: '#/components/schemas/PainelColabUnidadeNegocio'
        createdAt:
          format: date-time
          type: string
          description: Data de criação
          example: '2026-05-11T13:08:52.937Z'
        updatedAt:
          format: date-time
          type: string
          description: Data do ultimo update
          example: '2026-05-11T13:08:52.937Z'
      required:
        - unidadeNegocioId
        - nome
        - step
        - status
        - tipoIdentificacao
        - numeroCadastro
        - email
        - emailNotificacao
        - endereco
        - colaboradores
        - createdAt
        - updatedAt
    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
    PainelColabUnidadeNegocio:
      type: object
      properties:
        ativos:
          type: number
          description: Quantidade de colaboradores ativos
          example: 10
        inativos:
          type: number
          description: Quantidade de colaboradores inativos
          example: 2
      required:
        - ativos
        - inativos

````