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

# Detalhe de uma movimentação

> Retorna os detalhes de uma movimentação específica.



## OpenAPI

````yaml openapi.yaml GET /v1/enrollment/detail/{enrollment-id}
openapi: 3.1.0
info:
  title: Pipo Public API
  version: 0.2.0
  description: >
    API pública da Pipo Saúde para integração de movimentações de benefícios

    (inclusões, exclusões e consultas) por parceiros e sistemas de folha de
    pagamento.
  contact:
    name: Pipo Engineering
    email: felipe.rodopoulos@piposaude.com.br
servers:
  - url: https://api.pipo.health
    description: Homologação (staging)
  - url: https://api.piposaude.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Obtenção do token de acesso.
  - name: Empresas
    description: Consulta de empresas e seus produtos.
  - name: Benefícios
    description: Consulta de produtos/benefícios disponíveis.
  - name: Movimentações
    description: Inclusões, exclusões e histórico de movimentações.
  - name: Membros
    description: Consulta de membros e seus benefícios.
  - name: Solicitações
    description: Consulta do status de requisições assíncronas.
  - name: Health Check
    description: Verificação de disponibilidade.
paths:
  /v1/enrollment/detail/{enrollment-id}:
    get:
      tags:
        - Movimentações
      summary: Detalhe de uma movimentação
      description: Retorna os detalhes de uma movimentação específica.
      parameters:
        - name: enrollment-id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID da movimentação.
      responses:
        '200':
          description: Detalhe da movimentação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/Enrollment'
              example:
                result:
                  id: 789e0123-e89b-12d3-a456-426614174002
                  enrollment-type: inclusion
                  status: completed
                  created-at: '2024-01-15T10:30:00Z'
                  member-type: primary
                  member-tax-id: '12345678900'
                  member-id: 111e2222-e89b-12d3-a456-426614174003
                  company-tax-id: '12345678000190'
                  product-id: 456e7890-e89b-12d3-a456-426614174001
                  product-name: Plano Saúde Premium
                  product-type: health-insurance
                  carrier-name: HealthCorp
                  last-updated-at: '2024-01-15T11:00:00Z'
                  scheduled-action-date: '2024-01-16'
                  scheduled-reason: Awaiting carrier approval
        '403':
          description: Não autorizado a acessar esta movimentação ou os dados da empresa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Not entitled to access this enrollment
components:
  schemas:
    Enrollment:
      type: object
      required:
        - id
        - enrollment-type
        - status
        - created-at
        - member-type
        - member-tax-id
        - company-tax-id
        - product-id
        - product-name
        - product-type
        - carrier-name
        - last-updated-at
      properties:
        id:
          type: string
          format: uuid
        enrollment-type:
          $ref: '#/components/schemas/EnrollmentType'
        status:
          $ref: '#/components/schemas/EnrollmentStatus'
        created-at:
          type: string
          format: date-time
        member-type:
          $ref: '#/components/schemas/MemberType'
        member-tax-id:
          $ref: '#/components/schemas/Cpf'
        member-id:
          type: string
          format: uuid
        company-tax-id:
          $ref: '#/components/schemas/Cnpj'
        product-id:
          type: string
          format: uuid
        product-name:
          type: string
        product-type:
          $ref: '#/components/schemas/ProductType'
        carrier-name:
          type: string
        last-updated-at:
          type: string
          format: date-time
          description: Data e hora da última atualização da movimentação.
        scheduled-action-date:
          type: string
          format: date
        scheduled-reason:
          type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensagem descritiva do erro.
    EnrollmentType:
      type: string
      description: Tipo de movimentação.
      enum:
        - inclusion
        - exclusion
        - alteration
    EnrollmentStatus:
      type: string
      description: Status da movimentação.
      enum:
        - cancelled
        - completed
        - failed
        - not-submitted
        - pending
        - requested
        - requested-cancellation
        - scheduled
        - submission-failed
        - submitted
    MemberType:
      type: string
      description: Tipo de membro. primary=Titular, dependent=Dependente.
      enum:
        - primary
        - dependent
    Cpf:
      type: string
      description: CPF (Cadastro de Pessoas Físicas). Aceita apenas dígitos ou formatado.
      examples:
        - '12345678900'
        - 123.456.789-00
    Cnpj:
      type: string
      description: >-
        CNPJ (Cadastro Nacional da Pessoa Jurídica). Aceita apenas dígitos ou
        formatado.
      examples:
        - '12345678000190'
        - 12.345.678/0001-90
    ProductType:
      type: string
      description: Tipo de produto/benefício.
      enum:
        - health-insurance
        - dental-insurance
        - life-insurance
        - mental-health
        - gym
        - pet-insurance
        - private-pension
        - air-medical-transport
        - health-navigation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token Bearer obtido em `POST /v1/authenticate`.

````