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

# Consulta de proposta

> Retorna os detalhes completos de uma proposta específica da empresa da chave.



## OpenAPI

````yaml /openapi.json get /integrations/external/proposals/{id}
openapi: 3.0.3
info:
  title: >-
    Integração Externa - Leads, Oportunidades, Tarefas, Arquivos, Propostas,
    Chats, Satisfação e Campos Personalizados
  version: 1.0.0
  description: >
    Documentação oficial da API externa da Wegly para campos personalizados,
    leads, oportunidades, tarefas, arquivos, propostas, chats e satisfação
    (`/integrations/external/custom-fields`, `/integrations/external/files`,
    `/integrations/external/leads`, `/integrations/external/deals`,
    `/integrations/external/tasks`, `/integrations/external/proposals`,
    `/integrations/external/chats` e `/integrations/external/satisfaction`).
    Todas as descrições estão em português e refletem as regras aplicadas pelo
    serviço.
servers:
  - url: https://api.wegly.com.br
    description: Ambiente de produção Wegly
security:
  - bearerAuth: []
tags:
  - name: Campos Personalizados
    description: >-
      Consulta dos campos personalizados disponíveis para uso nas integrações
      externas.
  - name: Arquivos
    description: >-
      Upload de arquivos públicos de integração vinculados diretamente a leads
      ou oportunidades.
  - name: Leads
    description: >-
      Operações de listagem, criação, consulta e atualização de leads via
      integração externa.
  - name: Oportunidades
    description: Operações de criação de oportunidades (deals) via integração externa.
  - name: Tarefas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de tarefas
      vinculadas a leads, oportunidades, entregas, pessoas ou organizações.
  - name: Satisfação
    description: >-
      Geração de links públicos para formulários de satisfação via integração
      externa.
  - name: Propostas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de
      propostas via integração externa.
  - name: Chats
    description: >-
      Operações principais de listagem, criação, consulta e resumo de não lidas
      de chats via integração externa.
paths:
  /integrations/external/proposals/{id}:
    get:
      tags:
        - Propostas
      summary: Consulta de proposta
      description: >-
        Retorna os detalhes completos de uma proposta específica da empresa da
        chave.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da proposta.
      responses:
        '200':
          description: Detalhes completos da proposta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProposalDetails'
        '401':
          description: Token de integração ausente ou inválido.
        '403':
          description: >-
            Permissão `crm/proposal.read` ausente ou domínio de origem não
            autorizado na chave.
        '404':
          description: Proposta não encontrada ou fora do escopo da chave.
components:
  schemas:
    ProposalDetails:
      allOf:
        - $ref: '#/components/schemas/ProposalSummary'
        - type: object
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/ProposalItemResponse'
    ProposalSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        lead:
          type: object
          allOf:
            - $ref: '#/components/schemas/ProposalContextSummary'
          nullable: true
        deal:
          type: object
          allOf:
            - $ref: '#/components/schemas/ProposalContextSummary'
          nullable: true
        code:
          type: integer
        version:
          type: integer
        title:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/ProposalStatusValue'
        notes:
          type: string
          nullable: true
        is_primary:
          type: boolean
        discount_type:
          type: integer
          allOf:
            - $ref: '#/components/schemas/ProposalDiscountType'
          nullable: true
        discount_value:
          type: number
          nullable: true
        subtotal:
          type: number
        total:
          type: number
        items_count:
          type: integer
        valid_until:
          type: string
          format: date-time
          nullable: true
        created_by:
          type: object
          allOf:
            - $ref: '#/components/schemas/ExternalUserSummary'
          nullable: true
        approved_by:
          type: object
          allOf:
            - $ref: '#/components/schemas/ExternalPersonSummary'
          nullable: true
        approved_at:
          type: string
          format: date-time
          nullable: true
        archived_at:
          type: string
          format: date-time
          nullable: true
        rejected_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ProposalItemResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        product_id:
          type: string
          format: uuid
          nullable: true
        product:
          type: object
          allOf:
            - $ref: '#/components/schemas/ProposalProductSummary'
          nullable: true
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        unit:
          type: integer
          nullable: true
        quantity:
          type: number
        unit_price:
          type: number
        discount_type:
          type: integer
          allOf:
            - $ref: '#/components/schemas/ProposalDiscountType'
          nullable: true
        discount_value:
          type: number
          nullable: true
        subtotal:
          type: number
        total:
          type: number
        notes:
          type: string
          nullable: true
        is_recurring_default:
          type: boolean
        billing_interval_default:
          type: integer
          nullable: true
        contract_term_months:
          type: integer
          nullable: true
        start_date:
          type: string
          format: date-time
          nullable: true
        end_date:
          type: string
          format: date-time
          nullable: true
        billing_cycles:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ProposalContextSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
          nullable: true
    ProposalStatusValue:
      type: integer
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
      description: >
        1 = negociação, 2 = aprovada, 3 = rejeitada, 4 = arquivada, 5 =
        dispensada.
    ProposalDiscountType:
      type: integer
      enum:
        - 0
        - 1
      description: 0 = percentual, 1 = valor fixo.
    ExternalUserSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        avatar:
          type: string
          nullable: true
    ExternalPersonSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    ProposalProductSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
          nullable: true
        name:
          type: string
        image:
          type: string
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Utilize o token de integração no header `Authorization: Bearer {token}`.
        O domínio de origem (Origin/Referer) deve respeitar `allowed_domain`,
        quando configurado na chave.

````