{"openapi":"3.0.3","info":{"title":"Miydas — API pública de faturamento","version":"1.0.0","description":"Serviços de ciclo de receita para produtos de saúde: comunicação com\noperadoras (elegibilidade, autorização, faturamento, glosa) e a gestão\ndas conexões que a sustentam.\n\n## Como funciona\n\nElegibilidade e autorização são **recursos**: o POST cria o recurso e\ndevolve `202` com ele; `processamento` diz o andamento com a operadora.\nCom `Prefer: wait=N` (até 30 s) a resposta espera a operadora e vem `200`\nquando ela responde a tempo. Mudanças chegam por evento (`/v1/assinaturas`).\n\nA operadora é endereçada por `registroANS`. Como o Miydas fala com ela\n(webservice, portal, arquivo) é detalhe interno: o contrato é o mesmo em\ntoda operadora.\n\n## Autenticação\n\nChave de API no cabeçalho `Authorization: Bearer myd_live_…`. A chave\ncarrega o tenant: cada clínica emite a sua para o produto.\n\nPara testar, a clínica emite uma chave de teste (`myd_test_…`) na mesma\nURL: ela opera só na homologação da operadora, e o que cria vem com\n`teste: true` e só aparece para chaves de teste.\n\n## Erros\n\n`error` é código estável, seguro para lógica. `message` é texto para\nhumano e pode mudar entre versões.","contact":{"name":"Miydas","url":"https://miydas.com.br/docs"}},"servers":[{"url":"https://api.miydas.com.br","description":"Produção"}],"tags":[{"name":"Descoberta","description":"O que a API oferece e quem é você"},{"name":"Operadoras","description":"Catálogo de quem é atendido"},{"name":"Conexões","description":"Habilitar operadora, credenciais e saúde"},{"name":"Elegibilidade","description":"O beneficiário pode ser atendido?"},{"name":"Autorização","description":"Solicitar, acompanhar e cancelar autorizações"},{"name":"Eventos","description":"Assinar eventos e receber avisos (webhooks)"},{"name":"Operações","description":"Falar com a operadora — todas assíncronas"},{"name":"Execuções","description":"Acompanhar o resultado"}],"paths":{"/v1":{"get":{"tags":["Descoberta"],"operationId":"raiz_listar","summary":"O que esta API oferece","description":"Única rota sem autenticação. Serve para descobrir operações e rotas.","security":[],"responses":{"200":{"description":"Catálogo de rotas"}}}},"/v1/openapi.json":{"get":{"tags":["Descoberta"],"operationId":"openapi_obter","summary":"Esta especificação","description":"Sem autenticação: é o contrato, não dado de ninguém.","security":[],"responses":{"200":{"description":"OpenAPI 3.0"}}}},"/v1/catalogo":{"get":{"tags":["Descoberta"],"operationId":"catalogo_obter","summary":"O catálogo dos recursos, com exemplos e a tabela de erros","description":"Sem autenticação. É o que a página miydas.com.br/docs mostra.","security":[],"responses":{"200":{"description":"Catálogo"}}}},"/v1/sandbox":{"get":{"tags":["Descoberta"],"operationId":"sandbox_listar","summary":"O que dá para experimentar sem chave","description":"Lista as operações que o sandbox responde, com a URL de cada uma. Sem autenticação: o conteúdo já é público em `/v1/catalogo`, e exigir credencial para ver o FORMATO é a barreira que o sandbox existe para tirar.","security":[],"responses":{"200":{"description":"Operações disponíveis no sandbox"}}}},"/v1/sandbox/{operacao}":{"get":{"tags":["Descoberta"],"operationId":"sandbox_responder","summary":"A resposta documentada de uma operação, sem chave e sem dado de ninguém","description":"Troque a URL real pela do sandbox e receba o MESMO corpo que a operação devolve. O exemplo vem do catálogo, que um teste amarra ao mapper de verdade — ele não envelhece em relação à API.\n\nÉ diferente da chave de teste (`myd_test_`): aquela opera na homologação da OPERADORA e serve para ESCREVER. O sandbox serve para LER — responde o formato antes de você ter credencial, convênio e varredura rodada.\n\nA resposta leva o cabeçalho `Miydas-Sandbox: true`.","security":[],"parameters":[{"name":"operacao","in":"path","required":true,"description":"O `id` da operação, como em `/v1/sandbox`. Ex.: `demonstrativos_listar`.","schema":{"type":"string"}}],"responses":{"200":{"description":"A resposta documentada da operação"},"404":{"description":"Operação inexistente, ou que não devolve corpo JSON"}}}},"/v1/eu":{"get":{"tags":["Descoberta"],"operationId":"eu_listar","summary":"Quem sou eu e o que posso","description":"Primeira chamada de qualquer integração: confirma chave, tenant e escopos.","responses":{"200":{"description":"Identidade da chave"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/operadoras":{"get":{"tags":["Operadoras"],"operationId":"operadoras_listar","summary":"Operadoras atendidas e sua maturidade","security":[{"chaveApi":["operadora:ler"]}],"responses":{"200":{"description":"Catálogo de automação"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/operadoras/{registroANS}/capacidades":{"get":{"tags":["Operadoras"],"operationId":"operadorasCapacidades_listar","summary":"O que responde para esta operadora","description":"Consulte antes de operar — é para onde OPERACAO_NAO_COBERTA aponta.","parameters":[{"name":"registroANS","in":"path","required":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string"}}],"security":[{"chaveApi":["operadora:ler"]}],"responses":{"200":{"description":"Operações disponíveis"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/execucoes":{"get":{"tags":["Execuções"],"operationId":"execucoes_listar","summary":"Histórico das execuções deste cliente","description":"Só o que ESTA chave disparou. Para tudo que rodou numa conexão, inclusive o agendador, use /v1/conexoes/{id}/execucoes.","parameters":[{"name":"status","in":"query","description":"Só as execuções neste estado: `PENDENTE`, `EXECUTANDO`, `CONCLUIDA`, `FALHOU`, `CANCELADA` ou `AGUARDANDO_ACAO`.","schema":{"type":"string"}},{"name":"operacao","in":"query","description":"A operação com a operadora, no vocabulário do Miydas (`CHECK_ELIGIBILITY`, `FETCH_RETURNS`, `SUBMIT_BATCH`…). A mesma em qualquer canal.","schema":{"type":"string"}},{"name":"desde","in":"query","description":"Só as execuções criadas a partir deste instante, em ISO 8601 com fuso.","schema":{"type":"string","format":"date-time"}},{"name":"limite","in":"query","description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","maximum":100,"default":20}},{"name":"deslocamento","in":"query","description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","default":0}}],"security":[{"chaveApi":["execucao:ler"]}],"responses":{"200":{"description":"Execuções, mais recentes primeiro","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExecucaoResumo"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/execucoes/{id}/retornos":{"get":{"tags":["Execuções"],"operationId":"execucoesPorIdRetornos_listar","summary":"O que a operadora devolveu, já normalizado","description":"FETCH_RETURNS busca arquivo — PDF numa operadora, JSON noutra, XML numa terceira. Aqui sai o modelo normalizado, igual para qualquer origem, com o arquivo bruto referenciado ao lado. `normalizado` vem nulo quando o arquivo ainda não foi lido ou quando nenhum leiaute o reconheceu.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"security":[{"chaveApi":["retorno:ler"]}],"responses":{"200":{"description":"Retornos da execução","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RetornosExecucao"}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Execução não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"EXECUCAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/execucoes/{id}":{"get":{"tags":["Execuções"],"operationId":"execucoesPorId_listar","summary":"Resultado de uma execução","description":"Segue a cadeia de retentativas: enquanto o sistema ainda vai tentar, o status reflete a tentativa corrente, não a falha intermediária.","parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"security":[{"chaveApi":["execucao:ler"]}],"responses":{"200":{"description":"Estado corrente","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Execucao"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Execução não encontrada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"EXECUCAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/elegibilidades":{"post":{"tags":["Elegibilidade"],"summary":"Pergunta à operadora se o beneficiário pode ser atendido","description":"`procedimentos` é aceito em toda operadora. Onde ela responde só pela carteirinha, `alcance` vem `CARTEIRINHA` e `avisos` diz que os procedimentos não foram verificados.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"elegibilidades_criar","security":[{"chaveApi":["elegibilidade:executar"]}],"parameters":[{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","pattern":"^\\d{6}$","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"carteira":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"procedimentos":{"type":"array","items":{"type":"string","minLength":1,"maxLength":10},"maxItems":20,"description":"Os códigos que você quer verificar. Onde a operadora só responde pela carteirinha, `alcance` vem `CARTEIRINHA` e eles não foram verificados — não são negativa."},"dataAtendimento":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data em que o atendimento aconteceu ou vai acontecer, `AAAA-MM-DD`."}},"required":["registroANS","carteira"],"additionalProperties":false},"example":{"registroANS":"334561","carteira":"00000000000000000","procedimentos":["40304361"]}}}},"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Elegibilidade"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0002ele","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"carteira":"00000000000000000","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:00:01.000Z","concluidoEm":"2026-09-27T13:00:03.000Z"},"elegivel":true,"alcance":"CARTEIRINHA","beneficiario":{"nome":"PACIENTE EXEMPLO","validadeCarteira":"2027-01-31","plano":"PLANO EXEMPLO"},"procedimentosPedidos":["40304361"],"procedimentos":[],"motivos":[],"avisos":["Esta operadora respondeu pela carteirinha: a habilitação de cada procedimento não foi verificada."],"teste":false,"criadaEm":"2026-09-27T13:00:01.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Elegibilidade"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0002ele","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"carteira":"00000000000000000","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:00:01.000Z","concluidoEm":"2026-09-27T13:00:03.000Z"},"elegivel":true,"alcance":"CARTEIRINHA","beneficiario":{"nome":"PACIENTE EXEMPLO","validadeCarteira":"2027-01-31","plano":"PLANO EXEMPLO"},"procedimentosPedidos":["40304361"],"procedimentos":[],"motivos":[],"avisos":["Esta operadora respondeu pela carteirinha: a habilitação de cada procedimento não foi verificada."],"teste":false,"criadaEm":"2026-09-27T13:00:01.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ENCONTRADA","message":"A empresa não tem essa operadora (registro ANS) cadastrada.","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}},"get":{"tags":["Elegibilidade"],"summary":"Elegibilidades já feitas, das mais recentes","operationId":"elegibilidades_listar","security":[{"chaveApi":["elegibilidade:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","pattern":"^\\d{6}$","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"carteira","in":"query","required":false,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string","maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."}},{"name":"de","in":"query","required":false,"description":"Início do período, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Início do período, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."}},{"name":"ate","in":"query","required":false,"description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Elegibilidade"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0002ele","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"carteira":"00000000000000000","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:00:01.000Z","concluidoEm":"2026-09-27T13:00:03.000Z"},"elegivel":true,"alcance":"CARTEIRINHA","beneficiario":{"nome":"PACIENTE EXEMPLO","validadeCarteira":"2027-01-31","plano":"PLANO EXEMPLO"},"procedimentosPedidos":["40304361"],"procedimentos":[],"motivos":[],"avisos":["Esta operadora respondeu pela carteirinha: a habilitação de cada procedimento não foi verificada."],"teste":false,"criadaEm":"2026-09-27T13:00:01.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/elegibilidades/{id}":{"get":{"tags":["Elegibilidade"],"summary":"Uma elegibilidade","operationId":"elegibilidades_obter","security":[{"chaveApi":["elegibilidade:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Elegibilidade"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0002ele","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"carteira":"00000000000000000","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:00:01.000Z","concluidoEm":"2026-09-27T13:00:03.000Z"},"elegivel":true,"alcance":"CARTEIRINHA","beneficiario":{"nome":"PACIENTE EXEMPLO","validadeCarteira":"2027-01-31","plano":"PLANO EXEMPLO"},"procedimentosPedidos":["40304361"],"procedimentos":[],"motivos":[],"avisos":["Esta operadora respondeu pela carteirinha: a habilitação de cada procedimento não foi verificada."],"teste":false,"criadaEm":"2026-09-27T13:00:01.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/autorizacoes":{"post":{"tags":["Autorização"],"summary":"Solicita autorização de procedimentos (guia SP/SADT)","description":"`numeroGuiaPrestador` é o seu número para a guia e não pode repetir na operadora. Enquanto a operadora não decide, o Miydas consulta a situação sozinho e avisa por `autorizacao.atualizada`. Refazendo o que foi negado, mande `refazItem` com o `id` do procedimento anterior: é o que liga a segunda tentativa à primeira.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_criar","security":[{"chaveApi":["autorizacao:executar"]}],"parameters":[{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","pattern":"^\\d{6}$","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"numeroGuiaPrestador":{"type":"string","minLength":1,"maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"carteira":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"recemNascido":{"type":"boolean","description":"O atendimento é de recém-nascido na carteirinha da mãe. A operadora cobra o campo porque o bebê ainda não tem carteira própria."},"etapa":{"type":"string","enum":["PREVIA","EXECUCAO"],"default":"PREVIA","description":"`PREVIA`: pedir antes de executar, que é o caso normal. `EXECUCAO`: o procedimento já foi feito e você está regularizando."},"carater":{"type":"string","enum":["ELETIVO","URGENCIA"],"default":"ELETIVO","description":"`URGENCIA` muda o prazo regulatório de resposta da operadora. Não use para apressar pedido eletivo: a operadora audita."},"indicacaoClinica":{"type":"string","maxLength":500,"description":"A justificativa clínica do pedido, em texto livre. É o que a operadora lê para decidir."},"numeroGuiaPrincipal":{"type":"string","minLength":1,"maxLength":20,"description":"O número da guia que este pedido continua, quando continua alguma."},"coberturaEspecial":{"type":"string","enum":["01","02","03"],"description":"`dm_cobEsp` do TISS: 01 gestante, 02 pré-operatório, 03 pós-operatório. Omita quando não se aplica."},"observacao":{"type":"string","maxLength":500,"description":"Recado para o auditor da operadora. Sai na tag `observacao` da guia — é diferente da indicação clínica, que é o motivo do exame."},"atendimento":{"type":"object","properties":{"tipoAtendimento":{"type":"string","pattern":"^(0[1-4]|08|09|10|13|23)$","description":"`dm_tipoAtendimento` do TISS. Laboratório costuma ser 23 (atendimento a exames)."},"regimeAtendimento":{"type":"string","pattern":"^0[1-5]$","description":"`dm_regimeAtendimento`. Coleta em balcão é 01 (ambulatorial)."},"indicacaoAcidente":{"type":"string","enum":["0","1","2","9"],"description":"`dm_indicadorAcidente`: 0 trabalho, 1 trânsito, 2 outros, 9 não é acidente."},"saudeOcupacional":{"type":"string","pattern":"^0[1-6]$","description":"`dm_saudeOcupacional`, quando o exame é de medicina do trabalho (admissional, periódico…)."},"tipoConsulta":{"type":"string","enum":["1","2","3","4"],"description":"`dm_tipoConsulta`. Raro em laboratório; alguns portais cobram."}},"additionalProperties":false,"description":"Como foi o atendimento. Não sai na guia de solicitação (o XSD não tem estes campos) — é o que os portais cobram."},"portal":{"type":"object","properties":{"cid":{"type":"string","maxLength":10,"description":"CID-10 da hipótese diagnóstica, como o portal pede. Não vai ao webservice: não há campo no XSD."},"tempoDoenca":{"type":"string","maxLength":20,"description":"Há quanto tempo o quadro dura, no formato que o portal aceita (ex.: \"30 dias\"). Só Unimed Blumenau pede."},"grauParticipacao":{"type":"string","maxLength":2,"description":"Grau de participação do executante, quando o portal cobra (Orizon Autorize)."},"dataAcidente":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data do acidente, `AAAA-MM-DD`. Obrigatória quando `atendimento.indicacaoAcidente` não é 9; o portal exige data anterior ou igual à da solicitação."}},"additionalProperties":false,"description":"Campos que só existem nos portais. Guardados no pedido e digitados pelo RPA; no webservice não saem."},"identificacaoBeneficiario":{"anyOf":[{"type":"object","properties":{"metodo":{"type":"string","enum":["QRCODE"],"description":"A leitura foi o QR Code do app do beneficiário (`dm_tipoIdent` 04)."},"carteiraLida":{"type":"string","minLength":1,"maxLength":30,"description":"O número do cartão como veio do QR. Pode diferir do digitado em `carteira` — mande o lido."},"token":{"type":"string","minLength":1,"maxLength":40,"description":"O token que o app do beneficiário exibe."},"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Latitude do celular do beneficiário, quando o app a informou. Omita se não veio — não use a da clínica."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Longitude do celular do beneficiário, quando o app a informou. Omita se não veio."}},"required":["metodo","carteiraLida","token"],"additionalProperties":false},{"type":"object","properties":{"metodo":{"type":"string","enum":["TARJA"],"description":"A leitura foi a tarja magnética do cartão na leitora (`dm_tipoIdent` 01)."},"trilha":{"type":"string","minLength":1,"maxLength":200,"description":"O conteúdo da trilha, como veio da leitora. Não normalize: os separadores fazem parte do dado."}},"required":["metodo","trilha"],"additionalProperties":false},{"type":"object","properties":{"metodo":{"type":"string","enum":["PRONTO"],"description":"Você já montou o identificador e manda o tipo e o conteúdo prontos."},"tipoIdent":{"type":"string","pattern":"^0[1-9]$","description":"Como a carteirinha foi lida, na tabela `dm_tipoIdent` do TISS: 01 tarja, 02 código de barras, 03 cartão físico, 04 QR Code, 05 digital, 06 face, 07 íris, 08 geometria da mão, 09 cartão virtual."},"base64":{"type":"string","minLength":1,"description":"O conteúdo capturado, já em base64 — é o que vai na tag `identificadorBeneficiario`."}},"required":["metodo","tipoIdent","base64"],"additionalProperties":false,"description":"Captura já codificada por quem chama. Use quando seu sistema já monta o identificador."}],"description":"Como a carteirinha foi lida na recepção (QR do app, tarja magnética, ou já pronto). Bradesco e Smile negam sem isto."},"codigoValidacao":{"type":"string","minLength":1,"maxLength":10,"description":"O token que o app do beneficiário mostra, ditado no balcão e digitado pelo atendente. É o `codValidacao` do TISS, e NÃO a mesma coisa que `identificacaoBeneficiario`: aquele é o conteúdo lido do QR ou da tarja, este é o código curto. A operadora aceita qualquer um dos dois como prova de presença."},"ausenciaCodigoValidacao":{"type":"string","pattern":"^0[1-7]$","description":"Por que não houve token, quando não houve. Declarar é melhor que omitir: omitir faz a operadora supor. Ignorado quando `codigoValidacao` vem preenchido."},"dataSolicitacao":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data em que a autorização foi solicitada, `AAAA-MM-DD`."},"profissionalSolicitante":{"type":"object","properties":{"nome":{"type":"string","maxLength":70,"description":"Nome do profissional que pediu o procedimento."},"conselho":{"type":"string","minLength":2,"maxLength":10,"description":"Sigla do conselho profissional (`CRM`, `CRO`, `COREN`…)."},"numero":{"type":"string","minLength":1,"maxLength":15,"description":"Número de inscrição do solicitante no conselho profissional."},"uf":{"type":"string","minLength":2,"maxLength":2,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."},"cbo":{"type":"string","pattern":"^\\d{6}$","description":"Ocupação do profissional na CBO, seis dígitos."},"codigoContratadoNaOperadora":{"type":"string","maxLength":14,"description":"Código do prestador solicitante na operadora, quando quem pediu não é você."},"nomeContratado":{"type":"string","maxLength":70,"description":"Nome do prestador solicitante. Omitido, vale o da sua conexão."}},"required":["conselho","numero","uf"],"additionalProperties":false,"description":"Quem pediu o procedimento. Validado aqui, antes de criar a guia: conselho ou UF inválidos recusados depois queimariam o número da guia, que o TISS não deixa repetir."},"procedimentos":{"type":"array","items":{"type":"object","properties":{"tabela":{"type":"string","maxLength":2,"default":"22","description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","minLength":1,"maxLength":10,"description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","minLength":1,"maxLength":150,"description":"Descrição do procedimento, como ela vai no documento."},"quantidade":{"type":"integer","exclusiveMinimum":true,"minimum":0,"default":1,"description":"Quantas unidades do procedimento está pedindo. Inteiro, a partir de 1."},"refazItem":{"type":"string","minLength":1,"maxLength":64,"description":"`id` do procedimento da autorização anterior que este refaz. Omita na primeira tentativa."}},"required":["codigo","descricao"],"additionalProperties":false},"minItems":1,"maxItems":60,"description":"Os procedimentos que você está pedindo autorização para executar."}},"required":["registroANS","numeroGuiaPrestador","carteira","profissionalSolicitante","procedimentos"],"additionalProperties":false},"example":{"registroANS":"334561","numeroGuiaPrestador":"000123","carteira":"00000000000000000","profissionalSolicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"procedimentos":[{"tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidade":1}]}}}},"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ENCONTRADA","message":"A empresa não tem essa operadora (registro ANS) cadastrada.","details":null}}}},"409":{"description":"`GUIA_JA_SOLICITADA` — O `numeroGuiaPrestador` já foi usado nesta operadora, no mesmo ambiente (teste ou produção) — o padrão TISS proíbe repetir. `details.autorizacaoId` aponta a autorização existente, quando ela é conhecida.\n\n`IDEMPOTENCIA_EM_ANDAMENTO` — Um pedido com esta `Idempotency-Key` ainda está sendo criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"GUIA_JA_SOLICITADA","message":"O `numeroGuiaPrestador` já foi usado nesta operadora, no mesmo ambiente (teste ou produção) — o padrão TISS proíbe repetir. `details.autorizacaoId` aponta a autorização existente, quando ela é conhecida.","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.\n\n`LIMITE_DE_PROCEDIMENTOS` — A operadora aceita menos procedimentos por pedido do que os enviados (o padrão TISS não limita; algumas operadoras sim). `details.maximo` diz quantos.\n\n`CBO_OBRIGATORIO` — O canal que atende esta operadora exige o CBO-S do profissional solicitante e o pedido veio sem `profissionalSolicitante.cbo`. Nem toda operadora exige: `GET /v1/capacidades` diz quais, em `pedidoExige`.\n\n`REFAZ_ITEM_INVALIDO` — Algum `procedimentos[].refazItem` não aponta para um procedimento desta empresa, ou aponta para o outro ambiente — a chave de teste não enxerga o que é de produção, e o contrário.\n\n`IDEMPOTENCIA_CONFLITO` — A mesma `Idempotency-Key` veio com um pedido diferente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}},"get":{"tags":["Autorização"],"summary":"Autorizações — filtre por situação, carteira ou senhas que vencem","operationId":"autorizacoes_listar","security":[{"chaveApi":["autorizacao:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","pattern":"^\\d{6}$","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"carteira","in":"query","required":false,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."}},{"name":"situacao","in":"query","required":false,"description":"O veredito da operadora sobre a guia. `NAO_EXIGE_AUTORIZACAO` não é negativa — é a operadora dizendo que o procedimento passa direto.","schema":{"type":"string","enum":["A_ENVIAR","ENVIANDO","EM_ANALISE","AUTORIZADA","PARCIALMENTE_AUTORIZADA","NEGADA","AGUARDANDO_JUSTIFICATIVA","AGUARDANDO_DOCUMENTACAO","CANCELADA","NAO_EXIGE_AUTORIZACAO","INDETERMINADA"],"description":"O veredito da operadora sobre a guia. `NAO_EXIGE_AUTORIZACAO` não é negativa — é a operadora dizendo que o procedimento passa direto."}},{"name":"numeroGuiaPrestador","in":"query","required":false,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.","schema":{"type":"string","maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."}},{"name":"recorte","in":"query","required":false,"description":"O filtro que produziu estes números, devolvido junto. Total sem recorte ao lado é número solto: é por aqui que você confere que somou o que queria.","schema":{"type":"string","enum":["precisam-de-mim","na-operadora"],"description":"O filtro que produziu estes números, devolvido junto. Total sem recorte ao lado é número solto: é por aqui que você confere que somou o que queria."}},{"name":"validadeSenhaAte","in":"query","required":false,"description":"Só guias cuja senha vence até esta data, `AAAA-MM-DD`. É o filtro de quem precisa executar antes de perder a autorização.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Só guias cuja senha vence até esta data, `AAAA-MM-DD`. É o filtro de quem precisa executar antes de perder a autorização."}},{"name":"de","in":"query","required":false,"description":"Início do período, `AAAA-MM-DD`, pela data de solicitação (fuso de São Paulo).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Início do período, `AAAA-MM-DD`, pela data de solicitação (fuso de São Paulo)."}},{"name":"ate","in":"query","required":false,"description":"Fim do período, `AAAA-MM-DD`, pela data de solicitação (fuso de São Paulo).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Fim do período, `AAAA-MM-DD`, pela data de solicitação (fuso de São Paulo)."}},{"name":"numeroGuiaOperadora","in":"query","required":false,"description":"O número que a OPERADORA deu à guia. É por ele que ela atende ao telefone, e não pelo do prestador.","schema":{"type":"string","maxLength":20,"description":"O número que a OPERADORA deu à guia. É por ele que ela atende ao telefone, e não pelo do prestador."}},{"name":"paciente","in":"query","required":false,"description":"Trecho do nome do beneficiário. Casa em qualquer posição e ignora maiúsculas — é o filtro de quem tem meio nome na mão.","schema":{"type":"string","minLength":2,"maxLength":70,"description":"Trecho do nome do beneficiário. Casa em qualquer posição e ignora maiúsculas — é o filtro de quem tem meio nome na mão."}},{"name":"senha","in":"query","required":false,"description":"A senha exata que a operadora liberou.","schema":{"type":"string","minLength":1,"maxLength":30,"description":"A senha exata que a operadora liberou."}},{"name":"atendimento","in":"query","required":false,"description":"Número da requisição que gerou a guia. Casa em qualquer posição: é por ele que as N guias de um mesmo pedido aparecem juntas.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"Número da requisição que gerou a guia. Casa em qualquer posição: é por ele que as N guias de um mesmo pedido aparecem juntas."}},{"name":"ordenarPor","in":"query","required":false,"description":"Por qual campo ordenar. Só campos gravados: `proximaAcao`, a quantidade de procedimentos e o tempo de processamento são calculados depois de paginar, e ordenar por eles ordenaria a página, não a lista.","schema":{"type":"string","enum":["dataSolicitacao","atualizadaEm","nomeBeneficiario","numeroCarteira","numeroGuiaPrestador","numeroGuiaOperadora","senha","validadeSenha","situacao","operadora","proximaConsultaEm","atendimento"],"description":"Por qual campo ordenar. Só campos gravados: `proximaAcao`, a quantidade de procedimentos e o tempo de processamento são calculados depois de paginar, e ordenar por eles ordenaria a página, não a lista."}},{"name":"ordem","in":"query","required":false,"description":"A direção da ordenação pedida em `ordenarPor`. Padrão `asc`. Sem `ordenarPor`, não tem efeito.","schema":{"type":"string","enum":["asc","desc"],"description":"A direção da ordenação pedida em `ordenarPor`. Padrão `asc`. Sem `ordenarPor`, não tem efeito."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Autorizacao"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/autorizacoes/consultas":{"post":{"tags":["Autorização"],"summary":"Traz uma guia pedida fora do Miydas e consulta a situação","description":"Informe o número de guia do prestador ou o da operadora. A autorização passa a ser acompanhada como as demais.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_importar","security":[{"chaveApi":["autorizacao:ler"]}],"parameters":[{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","pattern":"^\\d{6}$","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"carteira":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"numeroGuiaPrestador":{"type":"string","minLength":1,"maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","minLength":1,"maxLength":20,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."}},"required":["registroANS","carteira"],"additionalProperties":false},"example":{"registroANS":"334561","carteira":"00000000000000000","numeroGuiaOperadora":"18700001"}}}},"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"CONSULTA","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"CONSULTA","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ENCONTRADA","message":"A empresa não tem essa operadora (registro ANS) cadastrada.","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/autorizacoes/{id}":{"get":{"tags":["Autorização"],"summary":"Uma autorização, com o histórico","operationId":"autorizacoes_obter","security":[{"chaveApi":["autorizacao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}},"patch":{"tags":["Autorização"],"summary":"Corrige a guia que ainda não foi autorizada","description":"Ajusta o que será pedido: solicitante, beneficiário, procedimentos, caráter, indicação clínica e os campos de atendimento. Existe porque o motivo de uma falha manda \"corrija e peça de novo\" — e até 20/11/2026 não havia por onde. **Não mexe no número da guia**: o TISS não deixa repetir `numeroGuiaPrestador`, e corrigir o conteúdo para reenviar com o mesmo número é o caminho quando a tentativa anterior não chegou a existir na operadora. Campo omitido não muda; `null` limpa. A lista de procedimentos, quando vem, SUBSTITUI a anterior. Guia com desfecho (autorizada, em parte ou cancelada) é recusada: ali o documento é da operadora. Guia que já saiu continua corrigível, e a resposta traz `soAqui: true` para a tela avisar que a mudança vale só do nosso lado.","operationId":"autorizacoes_corrigir","security":[{"chaveApi":["autorizacao:executar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`GUIA_COM_DESFECHO` — A guia já tem desfecho da operadora — autorizada, autorizada em parte ou cancelada — e por isso não se corrige mais: o documento passou a ser dela, e mudar só o nosso lado faria os dois discordarem sobre a mesma guia.\n\n`IDEMPOTENCIA_EM_ANDAMENTO` — Um pedido com esta `Idempotency-Key` ainda está sendo criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"GUIA_COM_DESFECHO","message":"A guia já tem desfecho da operadora — autorizada, autorizada em parte ou cancelada — e por isso não se corrige mais: o documento passou a ser dela, e mudar só o nosso lado faria os dois discordarem sobre a mesma guia.","details":null}}}},"422":{"description":"`SOLICITANTE_INVALIDO` — A correção deixaria o profissional solicitante num estado que a operadora recusa: conselho fora de `dm_conselhoProfissional`, UF inexistente, CBO fora de seis dígitos ou número em branco. `details.erros` traz cada problema em uma frase.\n\n`IDEMPOTENCIA_CONFLITO` — A mesma `Idempotency-Key` veio com um pedido diferente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"SOLICITANTE_INVALIDO","message":"A correção deixaria o profissional solicitante num estado que a operadora recusa: conselho fora de `dm_conselhoProfissional`, UF inexistente, CBO fora de seis dígitos ou número em branco. `details.erros` traz cada problema em uma frase.","details":null}}}}}}},"/v1/autorizacoes/{id}/consultas":{"post":{"tags":["Autorização"],"summary":"Pergunta à operadora a situação atual","description":"Não é preciso chamar em laço: o Miydas já acompanha as pendentes e avisa por evento.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_consultar","security":[{"chaveApi":["autorizacao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}}],"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/autorizacoes/{id}/envio":{"post":{"tags":["Autorização"],"summary":"Transmite uma guia que já existe e ainda não saiu","description":"Para a guia gerada pelo processamento de uma requisição, que nasce sem ter ido à operadora. `POST /v1/autorizacoes` cria e envia no mesmo ato — o que ele devolve já foi, e reenviar é recusado. A guia tem número próprio desde que nasceu, e é ela que muda de estado: não sai pedido novo.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_enviar","security":[{"chaveApi":["autorizacao:executar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`GUIA_JA_ENVIADA` — A guia já saiu para a operadora. O TISS proíbe repetir o `numeroGuiaPrestador`, inclusive depois de negativa — reenviar a mesma guia é recusado pela própria operadora (glosa 1601).\n\n`ENVIO_EM_ANDAMENTO` — Já existe um envio desta guia em voo. A trava é a troca de situação, feita em condição: dois envios simultâneos mandariam dois pedidos reais da mesma guia à operadora.\n\n`IDEMPOTENCIA_EM_ANDAMENTO` — Um pedido com esta `Idempotency-Key` ainda está sendo criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"GUIA_JA_ENVIADA","message":"A guia já saiu para a operadora. O TISS proíbe repetir o `numeroGuiaPrestador`, inclusive depois de negativa — reenviar a mesma guia é recusado pela própria operadora (glosa 1601).","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.\n\n`IDEMPOTENCIA_CONFLITO` — A mesma `Idempotency-Key` veio com um pedido diferente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/autorizacoes/{id}/cancelamento":{"post":{"tags":["Autorização"],"summary":"Cancela a guia na operadora","description":"Irreversível. Se a operadora recusar, o processamento conclui e `motivos` traz o porquê — a situação não muda.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_cancelar","security":[{"chaveApi":["guia:cancelar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"CANCELADA","descricao":"Cancelada","codigoOperadora":null},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"},{"ocorridoEm":"2026-09-27T15:10:00.000Z","tipo":"CANCELAMENTO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"CANCELADA","descricao":"Cancelada","codigoOperadora":null},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"},{"ocorridoEm":"2026-09-27T15:10:00.000Z","tipo":"CANCELAMENTO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`IDEMPOTENCIA_EM_ANDAMENTO` — Um pedido com esta `Idempotency-Key` ainda está sendo criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"IDEMPOTENCIA_EM_ANDAMENTO","message":"Um pedido com esta `Idempotency-Key` ainda está sendo criado.","details":null}}}},"422":{"description":"`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.\n\n`CANCELAMENTO_IMPOSSIVEL` — A autorização não tem número de guia com que a operadora a identifique.\n\n`IDEMPOTENCIA_CONFLITO` — A mesma `Idempotency-Key` veio com um pedido diferente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/autorizacoes/{id}/guia.pdf":{"get":{"tags":["Autorização"],"summary":"A guia de SP/SADT em PDF, para imprimir","description":"O formulário oficial da ANS (`GUIA DE SERVIÇO PROFISSIONAL / SERVIÇO AUXILIAR DE DIAGNÓSTICO E TERAPIA - SP/SADT`, 68 campos, A4 paisagem) com os campos da autorização preenchidos a partir do que está gravado. Responde os bytes do PDF, FORA do envelope `{ data }`; erro continua no formato padrão.\n\nOs campos 29 a 57 e 59 a 65 saem EM BRANCO de propósito: são da execução e do faturamento, e no instante em que a operadora autoriza eles não existem. O papel é para o atendimento preencher.\n\nA GUIA DA OPERADORA VEM PRIMEIRO, quando ela imprime. A ordem é: o documento dela já arquivado (instantâneo), depois buscá-lo no portal, e só então o desenho próprio. O cabeçalho `X-Miydas-Origem-Guia` diz qual veio — `OPERADORA` ou `MIYDAS` —, para quem precisa do documento dela saber que recebeu o nosso.\n\nE o desenho próprio não é consolo: para a maioria das operadoras ele é a ÚNICA guia que existe — a Unimed Blumenau não imprime, e canal de webservice não tem papel, porque o TISS normatiza a transação e não o documento. Qualquer falha na busca ao portal cai nele, de propósito: quem pediu a guia quer a guia, e trocar um documento por \"o portal da operadora caiu\" não serve a ninguém no balcão.\n\nNão consome cota e não cria execução: imprimir é leitura sob demanda.","operationId":"autorizacoes_guia_pdf","security":[{"chaveApi":["autorizacao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/autorizacoes/{id}/executados":{"put":{"tags":["Autorização"],"summary":"Grava o que foi executado, sem falar com a operadora","description":"O número executado é do PRESTADOR antes de ser da operadora: é ele que entra na guia do lote TISS. A maioria das operadoras não tem transação de execução — a autorização já é a guia —, e depender do portal para guardar esse número seria entregar a ele um dado que é nosso. A lista SUBSTITUI o estado conferido: mande todos os itens. Exame autorizado não pode ser omitido (mande `quantidade: 0`); item sem `id` é exame acrescentado. Nada sai para a operadora aqui — para registrar lá, use `POST /v1/autorizacoes/{id}/execucao`.","operationId":"autorizacoes_executados","security":[{"chaveApi":["autorizacao:executar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":null,"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"422":{"description":"`EXAME_AUTORIZADO_REMOVIDO` — A execução declarada deixou de fora um exame que a operadora autorizou. `details.itens` diz quais.\n\n`ITEM_DE_OUTRA_GUIA` — A execução declarou um `id` de item que não pertence a esta guia.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"EXAME_AUTORIZADO_REMOVIDO","message":"A execução declarada deixou de fora um exame que a operadora autorizou. `details.itens` diz quais.","details":null}}}}}}},"/v1/autorizacoes/{id}/execucao":{"post":{"tags":["Autorização"],"summary":"Registra na operadora que o exame foi feito","description":"O passo depois do sim, onde a operadora o exige: ela registra o atendimento e emite a guia de serviço, que volta em `execucao.guiaGerada` — é esse número que o faturamento cobra. Só vale para guia AUTORIZADA ou PARCIALMENTE_AUTORIZADA. **Sem corpo**, executa o que a operadora liberou (a quantidade AUTORIZADA, nunca a pedida — pedir 2, ela liberar 1 e executar 2 faz o portal recusar). **Com corpo**, vale o que você declarar em `procedimentos`: quantidade diferente, `0` para \"não executei\", ou um exame que não estava autorizado (item sem `id`). Exame autorizado não pode ser OMITIDO da lista — mande-o com `quantidade: 0`, porque é o lastro do que a operadora liberou que defende o faturamento da glosa. Operadora que não tem esta transação responde OPERACAO_NAO_COBERTA.\n\nSe falhar depois de aceita, `processamento.erro.error` traz: `OPERADORA_INDISPONIVEL`, `CREDENCIAL_RECUSADA`, `CONEXAO_INCOMPLETA`, `PEDIDO_RECUSADO`, `PEDIDO_INCOMPLETO`, `OPERADORA_OCUPADA`, `DADOS_RECUSADOS`.","operationId":"autorizacoes_executar","security":[{"chaveApi":["autorizacao:executar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":{"executada":true,"parcial":false,"guiaGerada":"95200001","situacaoOperadora":"Executada","mensagem":"Guia de serviço 95200001 gerada.","em":"2026-09-28T11:40:02.000Z"},"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Autorizacao"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","processamento":{"status":"CONCLUIDO","iniciadoEm":"2026-09-27T13:02:10.000Z","concluidoEm":"2026-09-27T13:02:14.000Z"},"situacao":{"codigo":"AUTORIZADA","descricao":"Autorizada","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","dataAutorizacao":"2026-09-27","dataSolicitacao":"2026-09-27","beneficiario":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO"},"solicitante":{"nome":"Médica Exemplo","conselho":"CRM","numero":"12345","uf":"SC","cbo":"225124"},"evidencias":{"tela":true,"guia":true},"pedido":{"carater":"ELETIVO","indicacaoClinica":"Investigação de anemia","observacao":null,"numeroGuiaPrincipal":null,"coberturaEspecial":null,"recemNascido":false,"atendimento":{"tipoAtendimento":"23","regimeAtendimento":"01","indicacaoAcidente":"9","saudeOcupacional":""},"portal":{"cid":"D509","tempoDoenca":"","dataAcidente":""}},"procedimentos":[{"id":"cm3p0r0c1","tabela":"22","codigo":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidadeSolicitada":1,"quantidadeAutorizada":1,"quantidadeExecutada":1,"motivos":[],"refazItem":null}],"motivos":[],"requisicao":null,"proximaAcao":{"codigo":"IMPRIMIR_GUIA","texto":"Nada — imprimir e atender","precisaDeMim":false},"execucao":{"executada":true,"parcial":false,"guiaGerada":"95200001","situacaoOperadora":"Executada","mensagem":"Guia de serviço 95200001 gerada.","em":"2026-09-28T11:40:02.000Z"},"historico":[{"ocorridoEm":"2026-09-27T13:02:14.000Z","tipo":"SOLICITACAO"}],"origem":"SOLICITACAO","etapa":"PREVIA","teste":false,"proximaConsultaEm":null,"consultasAutomaticas":0,"criadaEm":"2026-09-27T13:02:10.000Z","atualizadaEm":"2026-09-27T13:02:14.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`IDEMPOTENCIA_EM_ANDAMENTO` — Um pedido com esta `Idempotency-Key` ainda está sendo criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"IDEMPOTENCIA_EM_ANDAMENTO","message":"Um pedido com esta `Idempotency-Key` ainda está sendo criado.","details":null}}}},"422":{"description":"`EXAME_AUTORIZADO_REMOVIDO` — A execução declarada deixou de fora um exame que a operadora autorizou. `details.itens` diz quais.\n\n`ITEM_DE_OUTRA_GUIA` — A execução declarou um `id` de item que não pertence a esta guia.\n\n`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.\n\n`EXECUCAO_SEM_AUTORIZACAO` — A guia ainda não foi liberada pela operadora (`EM_ANALISE`, `NEGADA`, `CANCELADA` ou sem desfecho). Nada foi enviado.\n\n`EXECUCAO_SEM_GUIA_DA_OPERADORA` — A autorização não tem `numeroGuiaOperadora`, que é o número pelo qual a operadora identifica o que executar.\n\n`EXECUCAO_SEM_PROCEDIMENTO` — A autorização não tem procedimento com código para executar.\n\n`IDEMPOTENCIA_CONFLITO` — A mesma `Idempotency-Key` veio com um pedido diferente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"EXAME_AUTORIZADO_REMOVIDO","message":"A execução declarada deixou de fora um exame que a operadora autorizou. `details.itens` diz quais.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/lotes":{"post":{"tags":["Faturamento"],"summary":"Monta o lote: gera a mensagem TISS e valida no esquema oficial. NÃO transmite","description":"Você descreve o faturamento — prestador, beneficiário, procedimentos — e o Miydas monta a mensagem TISS na versão que a operadora aceita. Montar é reversível e barato; transmitir é irreversível na operadora, e por isso é outro pedido (`POST /v1/lotes/{id}/envios`). Confira `conformidade.xsdValido` antes de enviar: lote inválido é recusado na transmissão. `referenciaExterna` é a chave de idempotência — repetir o POST devolve o mesmo lote, e um lote já transmitido não pode ser substituído (corrija criando outro, com nova referência).","operationId":"lotes_criar","security":[{"chaveApi":["lote:gerenciar"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"referenciaExterna":{"type":"string","minLength":1,"maxLength":64,"description":"O identificador deste objeto NO SEU sistema. É a chave de idempotência: repetir o pedido com a mesma referência devolve o mesmo recurso em vez de criar outro."},"operadora":{"type":"string","minLength":1,"maxLength":100,"description":"O nome da operadora como VOCÊ a chama. É rótulo, para você reencontrar o lote: quem resolve conector e credencial é o `registroANS`."},"registroANS":{"type":"string","minLength":1,"maxLength":10,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"competencia":{"type":"string","pattern":"^\\d{4}-\\d{2}$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"prestador":{"type":"object","properties":{"nome":{"type":"string","maxLength":100,"description":"Razão social ou nome do prestador."},"cnpj":{"type":"string","maxLength":18,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."},"cnes":{"type":"string","maxLength":10,"description":"Código do estabelecimento no CNES, sete dígitos."},"codigoNaOperadora":{"type":"string","maxLength":20,"description":"O código deste prestador na operadora, como ela o cadastrou."},"uf":{"type":"string","maxLength":2,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."},"profissional":{"type":"object","properties":{"nome":{"type":"string","maxLength":100,"description":"Nome do profissional."},"conselho":{"type":"string","maxLength":10,"description":"Sigla do conselho profissional (`CRM`, `CRO`, `COREN`…)."},"numeroConselho":{"type":"string","maxLength":20,"description":"Número de inscrição do profissional no conselho."},"uf":{"type":"string","maxLength":2,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."},"cbo":{"type":"string","maxLength":10,"description":"Ocupação do profissional na CBO, seis dígitos."}},"additionalProperties":false,"description":"O profissional responsável, como ele vai no documento TISS."}},"additionalProperties":false,"description":"Quem executou e está cobrando — a clínica, laboratório ou centro de imagem."},"guias":{"type":"array","items":{"type":"object","properties":{"numeroGuiaPrestador":{"type":"string","minLength":1,"maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"autorizacao":{"type":"string","maxLength":20,"description":"A senha de autorização concedida pela operadora, quando ela exigiu uma."},"numeroGuiaOperadora":{"type":"string","maxLength":20,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"dataAutorizacao":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data em que a operadora autorizou, `AAAA-MM-DD`."},"dataValidadeSenha":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Último dia em que a senha de autorização pode ser usada, `AAAA-MM-DD`."},"indicacaoClinica":{"type":"string","maxLength":500,"description":"A justificativa clínica do pedido, em texto livre. É o que a operadora lê para decidir."},"beneficiario":{"type":"object","properties":{"nome":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro."},"carteirinha":{"type":"string","maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão."},"nascimento":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `AAAA-MM-DD`."},"cpf":{"type":"string","maxLength":14,"description":"CPF, 11 dígitos. Aceito com ou sem máscara."},"sexo":{"type":"string","maxLength":1,"description":"Sexo como a operadora o codifica: `M`, `F` ou `I` (indeterminado)."},"plano":{"type":"string","maxLength":60,"description":"Nome do plano do beneficiário na operadora."}},"required":["nome"],"additionalProperties":false,"description":"O beneficiário do plano atendido nesta guia."},"procedimentos":{"type":"array","items":{"type":"object","properties":{"tuss":{"type":"string","minLength":1,"maxLength":20,"description":"Código do procedimento na TUSS, a terminologia da ANS."},"descricao":{"type":"string","minLength":1,"maxLength":200,"description":"Descrição do procedimento, como ela vai no documento."},"quantidade":{"type":"integer","minimum":1,"default":1,"description":"Quantas unidades do procedimento. Inteiro, a partir de 1."},"valorUnitario":{"type":"number","minimum":0,"description":"Valor de uma unidade do procedimento, em reais, decimal em string."},"dataExecucao":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data em que o procedimento foi executado, `AAAA-MM-DD`."}},"required":["tuss","descricao","valorUnitario"],"additionalProperties":false},"minItems":1,"description":"Os procedimentos executados nesta guia."},"valorTotal":{"type":"number","minimum":0,"description":"Soma em reais, decimal em string com duas casas."}},"required":["numeroGuiaPrestador","beneficiario","procedimentos","valorTotal"],"additionalProperties":false},"minItems":1,"maxItems":100,"description":"As guias que compõem este lote."}},"required":["referenciaExterna","operadora","registroANS","competencia","prestador","guias"],"additionalProperties":false},"example":{"referenciaExterna":"fatura-2026-09-0042","operadora":"Unimed Blumenau","registroANS":"334561","competencia":"2026-09","prestador":{"nome":"Laboratório Exemplo","cnpj":"00000000000191","cnes":"0000000","codigoNaOperadora":"12345","uf":"42","profissional":{"nome":"Médica Exemplo","conselho":"06","numeroConselho":"12345","uf":"42","cbo":"225124"}},"guias":[{"numeroGuiaPrestador":"000123","autorizacao":"18700001","beneficiario":{"nome":"PACIENTE EXEMPLO","carteirinha":"00000000000000000","nascimento":"1980-01-01"},"procedimentos":[{"tuss":"40304361","descricao":"Hemograma com contagem de plaquetas","quantidade":1,"valorUnitario":12.5}],"valorTotal":12.5}]}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Lote"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"PRONTO","descricao":"Montado e válido no XSD. Pronto para transmitir.","podeEnviar":true},"processamento":null,"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":null,"transmitidoEm":null,"ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ENCONTRADA","message":"A empresa não tem essa operadora (registro ANS) cadastrada.","details":null}}}},"409":{"description":"`LOTE_JA_TRANSMITIDO` — Já existe um lote com esta `referenciaExterna` e ele foi transmitido (ou está indeterminado). Lote transmitido é imutável.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LOTE_JA_TRANSMITIDO","message":"Já existe um lote com esta `referenciaExterna` e ele foi transmitido (ou está indeterminado). Lote transmitido é imutável.","details":null}}}},"422":{"description":"`LOTE_REGRA_DA_OPERADORA` — O lote é válido no esquema oficial, mas viola uma regra MEDIDA desta operadora — ela o recusaria na importação. Recusado aqui, antes de transmitir, porque transmitir é irreversível e gasta um protocolo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LOTE_REGRA_DA_OPERADORA","message":"O lote é válido no esquema oficial, mas viola uma regra MEDIDA desta operadora — ela o recusaria na importação. Recusado aqui, antes de transmitir, porque transmitir é irreversível e gasta um protocolo.","details":null}}}}}},"get":{"tags":["Faturamento"],"summary":"Lotes da clínica, por operadora, período, protocolo e situação","description":"Filtra por operadora (`registroANS`), por período de transmissão (`enviadoDe`/`enviadoAte`) ou de criação (`criadoDe`/`criadoAte`), por protocolo e por competência. As datas são `AAAA-MM-DD` e o intervalo é fechado dos dois lados: `ate` inclui o dia inteiro.\n\n`situacao` e `processamento` respondem perguntas diferentes: a primeira é se o lote CHEGOU, a segunda é o que a operadora fez com o conteúdo. Um lote `ENVIADO` com protocolo pode ter sido `REJEITADO` — nenhuma conta entrou, e nada em `situacao` diz isso.","operationId":"lotes_listar","security":[{"chaveApi":["lote:ler"]}],"parameters":[{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"situacao","in":"query","required":false,"description":"O estado da TRANSMISSÃO do lote. `INDETERMINADO` é o caso que exige gente: a conexão caiu sem resposta e não se sabe se a operadora recebeu — reenviar às cegas duplica.","schema":{"type":"string","enum":["VALIDADO","ERRO_XSD","ENVIADO","ERRO_ENVIO","INDETERMINADO","TRANSMITINDO"],"description":"O estado da TRANSMISSÃO do lote. `INDETERMINADO` é o caso que exige gente: a conexão caiu sem resposta e não se sabe se a operadora recebeu — reenviar às cegas duplica."}},{"name":"processamento","in":"query","required":false,"description":"O julgamento do CONTEÚDO pela operadora, que é outra pergunta: um lote transmitido com sucesso pode estar `REJEITADO` aqui.","schema":{"type":"string","enum":["PROCESSANDO","ACEITO","REJEITADO"],"description":"O julgamento do CONTEÚDO pela operadora, que é outra pergunta: um lote transmitido com sucesso pode estar `REJEITADO` aqui."}},{"name":"referenciaExterna","in":"query","required":false,"description":"O identificador deste objeto NO SEU sistema. É a chave de idempotência: repetir o pedido com a mesma referência devolve o mesmo recurso em vez de criar outro.","schema":{"type":"string","maxLength":64,"description":"O identificador deste objeto NO SEU sistema. É a chave de idempotência: repetir o pedido com a mesma referência devolve o mesmo recurso em vez de criar outro."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"protocolo","in":"query","required":false,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."}},{"name":"enviadoDe","in":"query","required":false,"description":"Transmitidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Transmitidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."}},{"name":"enviadoAte","in":"query","required":false,"description":"Transmitidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Transmitidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra."}},{"name":"criadoDe","in":"query","required":false,"description":"Criados no Miydas a partir deste dia, `AAAA-MM-DD`. Diferente de `enviadoDe`: lote pode nascer hoje e ser transmitido semana que vem.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Criados no Miydas a partir deste dia, `AAAA-MM-DD`. Diferente de `enviadoDe`: lote pode nascer hoje e ser transmitido semana que vem."}},{"name":"criadoAte","in":"query","required":false,"description":"Criados no Miydas até este dia, `AAAA-MM-DD`, inclusive.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Criados no Miydas até este dia, `AAAA-MM-DD`, inclusive."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Lote"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"PRONTO","descricao":"Montado e válido no XSD. Pronto para transmitir.","podeEnviar":true},"processamento":null,"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":null,"transmitidoEm":null,"ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/lotes/{id}":{"get":{"tags":["Faturamento"],"summary":"Um lote: se chegou à operadora, e o que ela fez com ele","operationId":"lotes_obter","security":[{"chaveApi":["lote:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Lote"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"TRANSMITIDO","descricao":"Recebido pela operadora, com protocolo. Veja `processamento` para o que ela fez com o conteudo.","podeEnviar":false},"processamento":{"codigo":"REJEITADO","descricao":"A operadora recebeu o lote e recusou o conteudo. NENHUMA conta entrou.","acao":"Corrija o que o motivo aponta e gere um lote NOVO. Nao retransmita este: ele ja esta protocolado.","motivo":"CM104 - NUMERO DE GUIA INVALIDO","em":"2026-09-27T13:06:00.000Z"},"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":"32568556","transmitidoEm":"2026-09-27T13:05:00.000Z","ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/lotes/{id}/envios":{"post":{"tags":["Faturamento"],"summary":"Transmite o lote à operadora e registra o protocolo","description":"É idempotente por estado: lote já transmitido devolve o que tem, sem falar com a operadora de novo — repetir o pedido é seguro, inclusive depois de um timeout seu. Se a transmissão sair e a resposta não chegar, o lote fica `INDETERMINADO` e o reenvio é BLOQUEADO: a operadora pode ter recebido, e reenviar cobraria a mesma guia duas vezes. Nesse caso, confirme no portal e registre em `POST /v1/lotes/{id}/resolucoes`.","operationId":"lotes_enviar","security":[{"chaveApi":["lote:enviar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"Prefer","in":"header","required":false,"description":"`wait=N` (1–30): espera até N segundos pela operadora. Respondeu a tempo → 200; senão → 202.","schema":{"type":"string","example":"wait=20"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Mesma chave e mesmo corpo em 24 h devolvem o mesmo recurso, sem novo pedido à operadora.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"A operadora respondeu dentro da espera pedida","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Lote"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"TRANSMITIDO","descricao":"Recebido pela operadora, com protocolo. Veja `processamento` para o que ela fez com o conteudo.","podeEnviar":false},"processamento":{"codigo":"PROCESSANDO","descricao":"A operadora recebeu e esta importando o lote.","acao":"Aguarde e consulte o lote. Nao gere lote novo.","motivo":null,"em":"2026-09-27T13:05:10.000Z"},"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":"PROTO-18700001","transmitidoEm":"2026-09-27T13:05:00.000Z","ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}}}}},"202":{"description":"Aceita; acompanhe pelo recurso ou por evento","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Lote"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"TRANSMITIDO","descricao":"Recebido pela operadora, com protocolo. Veja `processamento` para o que ela fez com o conteudo.","podeEnviar":false},"processamento":{"codigo":"PROCESSANDO","descricao":"A operadora recebeu e esta importando o lote.","acao":"Aguarde e consulte o lote. Nao gere lote novo.","motivo":null,"em":"2026-09-27T13:05:10.000Z"},"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":"PROTO-18700001","transmitidoEm":"2026-09-27T13:05:00.000Z","ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`LOTE_INDETERMINADO` — A transmissão deste lote começou e a resposta da operadora não chegou. Ela PODE ter recebido.\n\n`LOTE_XSD_INVALIDO` — A transmissão foi pedida para um lote que não passou no esquema oficial.\n\n`AMBIENTE_SEM_ENVIO` — Uma chave de teste (`myd_test_`) pediu a transmissão de um lote. Chave de teste opera só na homologação da operadora, e a homologação ainda não é alcançável por esta rota.\n\n`LOTE_TRANSMITINDO` — A transmissão deste lote já está em curso no portal da operadora. Envio por portal é assíncrono, diferente do envio por webservice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LOTE_INDETERMINADO","message":"A transmissão deste lote começou e a resposta da operadora não chegou. Ela PODE ter recebido.","details":null}}}},"422":{"description":"`OPERADORA_NAO_CONFIGURADA` — A operadora do lote não tem conexão com credencial configurada.\n\n`LOTE_RECUSADO` — A operadora respondeu recusando o lote, com código e descrição TISS. O lote NÃO entrou.\n\n`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_CONFIGURADA","message":"A operadora do lote não tem conexão com credencial configurada.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/lotes/{id}/retornos":{"post":{"tags":["Faturamento"],"summary":"Busca na operadora o retorno deste lote","description":"O recorte por lote da varredura: em vez de varrer um período e filtrar do lado de fora, pergunta à operadora o que ela respondeu sobre ESTE protocolo. Responde 202 e nunca 200 — a busca leva segundos a minutos no portal da operadora, e o retorno normalizado sai em `GET /v1/execucoes/{id}/retornos`. Traz o demonstrativo de ANÁLISE. O de PAGAMENTO é indexado por data de crédito, não por protocolo: a operadora não sabe responder \"o pagamento do lote X\" — para ele, use `POST /v1/retornos/sincronizacoes`.","operationId":"lotes_retornos","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]},"example":{"data":{"execucaoId":"exec_cmf3k2x9a0001","status":"PENDENTE","operacao":"FETCH_RETURNS","operadora":{"registroANS":"334561"},"lote":{"id":"lote_cmf3k2x9a0001","protocolo":"PROTO-18700001","competencia":"2026-09"},"consultarEm":"/v1/execucoes/exec_cmf3k2x9a0001/retornos","ressalva":"Traz o demonstrativo de ANALISE do protocolo. O de PAGAMENTO e indexado por data de credito: busque-o em POST /v1/retornos/sincronizacoes."}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.\n\n`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`LOTE_SEM_PROTOCOLO` — Pediu-se o retorno de um lote que ainda não tem protocolo — ele foi montado, não transmitido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LOTE_SEM_PROTOCOLO","message":"Pediu-se o retorno de um lote que ainda não tem protocolo — ele foi montado, não transmitido.","details":null}}}},"422":{"description":"`OPERADORA_NAO_CONFIGURADA` — A operadora do lote não tem conexão com credencial configurada.\n\n`OPERACAO_NAO_COBERTA` — A operadora não oferece esta operação. `details.operacoesDisponiveis` lista o que ela oferece.\n\n`CREDENCIAL_AUSENTE` — A empresa não cadastrou a credencial desta operadora.\n\n`AMBIENTE_TESTE_INDISPONIVEL` — A chave é de teste (`myd_test_…`) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_CONFIGURADA","message":"A operadora do lote não tem conexão com credencial configurada.","details":null}}}},"429":{"description":"`LIMITE_EXCEDIDO` — Muitas operações em andamento para esta operadora nesta empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LIMITE_EXCEDIDO","message":"Muitas operações em andamento para esta operadora nesta empresa.","details":null}}}}}}},"/v1/demonstrativos/leituras":{"post":{"tags":["Demonstrativos"],"summary":"Lê um arquivo TISS e devolve o demonstrativo","description":"O Miydas é dono do parser TISS; quem integra é dono do arquivo. Esta rota existe para quem recebeu o demonstrativo por fora do portal (e-mail, download manual) e não quer escrever um segundo parser. NÃO fala com a operadora: é `POST` porque carrega corpo, não porque executa — não gasta cota, não cria execução e não aceita `Prefer: wait`. NÃO persiste: lê e devolve. O acervo é `GET /v1/demonstrativos`, e gravar aqui duplicaria o documento que já veio do portal, com dois ids para o mesmo protocolo. Buscar documento NOVO é `POST /v1/retornos/sincronizacoes`.","operationId":"demonstrativos_leituras","security":[{"chaveApi":["retorno:ler"]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"arquivo":{"type":"string","format":"binary","description":"O arquivo. Aceita .xml e .zip, ate 20 MB."}},"required":["arquivo"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LeituraDeArquivo"}},"required":["data"]},"example":{"data":{"arquivo":{"nome":"demonstrativo-pagamento-202609.xml","formato":"XML","bytes":184320},"demonstrativos":[{"tipo":"PAGAMENTO","numeroDemonstrativo":"000000187","protocolo":"PROTO-18700001","competencia":"2026-09","operadora":"UNIMED REGIONAL","emitidoEm":"2026-10-05","creditoEm":"2026-10-10","valores":{"informado":"1200.00","processado":"1200.00","liberado":"1050.00","glosa":"150.00"},"valorPago":"1050.00","guias":[{"numeroGuiaPrestador":"88120","numeroGuiaOperadora":"2026000188120","senha":null,"beneficiario":"BENEFICIARIO DE EXEMPLO","carteira":"00000000000000000","atendimentoEm":"2026-09-18","valores":{"informado":"1200.00","processado":"1200.00","liberado":"1050.00","glosa":"150.00"},"glosas":[],"itens":[{"tipo":"PROCEDIMENTO","sequencial":"1","codigoProcedimento":"40304361","codigoDespesa":null,"descricao":"Hemograma com contagem de plaquetas","quantidade":"1","valores":{"informado":"150.00","processado":"150.00","liberado":"0.00","glosa":"150.00"},"glosas":[{"codigo":"1308","descricao":"Procedimento nao consta no rol contratado","valor":"150.00"}]}]}],"liquidacao":{"totalDebitos":"48.30","totalCreditos":"0.00","lancamentos":[{"natureza":"DEBITO","tipo":"1","descricao":"IRPJ Prod Medica","valor":"15.75"},{"natureza":"DEBITO","tipo":"3","descricao":"ISS","valor":"32.55"}]}}],"avisos":[]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"413":{"description":"`ARQUIVO_GRANDE` — O arquivo passa do teto de leitura. `details.limiteMb` diz qual é.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"ARQUIVO_GRANDE","message":"O arquivo passa do teto de leitura. `details.limiteMb` diz qual é.","details":null}}}},"415":{"description":"`FORMATO_NAO_LIDO` — A extensão está fora da leitura estruturada (hoje `.xml` e `.zip`). PDF, imagem e planilha não viram dado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"FORMATO_NAO_LIDO","message":"A extensão está fora da leitura estruturada (hoje `.xml` e `.zip`). PDF, imagem e planilha não viram dado.","details":null}}}}}}},"/v1/lotes/{id}/resolucoes":{"post":{"tags":["Faturamento"],"summary":"Registra o que foi apurado na operadora sobre um lote indeterminado","description":"Único caminho que libera o reenvio de um lote cuja transmissão ficou sem resposta. É manual porque não há como confirmar sozinho: sem protocolo não existe consulta de protocolo. `chegou: true` exige o protocolo que a operadora deu — é por ele que status e demonstrativo são consultados depois. `chegou: false` devolve o lote para pronto.","operationId":"lotes_resolver","security":[{"chaveApi":["lote:enviar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chegou":{"type":"boolean","description":"`true`: você confirmou na operadora que o lote entrou — exige o protocolo. `false`: não entrou, e o lote volta a poder ser enviado."},"protocolo":{"type":"string","minLength":1,"maxLength":40,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"nota":{"type":"string","minLength":10,"description":"A nota escrita por quem registrou o fato — fica no histórico do recurso."}},"required":["chegou","nota"],"additionalProperties":false},"example":{"chegou":true,"protocolo":"PROTO-18700001","nota":"protocolo localizado no portal da operadora em 20/10, lote consta como recebido"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Lote"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001lot","referenciaExterna":"fatura-2026-09-0042","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","numeroLote":"202609","situacao":{"codigo":"TRANSMITIDO","descricao":"Recebido pela operadora, com protocolo. Veja `processamento` para o que ela fez com o conteudo.","podeEnviar":false},"processamento":{"codigo":"PROCESSANDO","descricao":"A operadora recebeu e esta importando o lote.","acao":"Aguarde e consulte o lote. Nao gere lote novo.","motivo":null,"em":"2026-09-27T13:05:10.000Z"},"conformidade":{"xsdValido":true,"erros":null},"totais":{"guias":1,"procedimentos":1,"valorTotal":"12.50"},"protocolo":"PROTO-18700001","transmitidoEm":"2026-09-27T13:05:00.000Z","ultimoErro":null,"criadoEm":"2026-09-27T13:00:00.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}},"409":{"description":"`LOTE_NAO_INDETERMINADO` — Pediu-se resolução de um lote que não está indeterminado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"LOTE_NAO_INDETERMINADO","message":"Pediu-se resolução de um lote que não está indeterminado.","details":null}}}}}}},"/v1/eventos":{"get":{"tags":["Eventos"],"summary":"Os eventos que podem ser assinados","description":"- `autorizacao.atualizada` — A autorização mudou: a operadora respondeu o pedido, uma consulta trouxe situação ou senha novas (inclusive as que o Miydas faz sozinho enquanto a guia está pendente — a cada 30 min a 6 h, por até 30 dias, nas operadoras que oferecem consulta de situação), ou a guia foi cancelada. Também sai quando uma operação pedida pela API sobre a autorização falha de vez.\n- `elegibilidade.concluida` — A operadora respondeu a elegibilidade.\n- `elegibilidade.falhou` — A operadora não respondeu a elegibilidade depois das tentativas.\n- `teste.ping` — Enviado sob demanda por POST /v1/assinaturas/{id}/teste, para conferir URL e assinatura.","operationId":"eventos_listar","security":[{"chaveApi":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Evento"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/assinaturas":{"post":{"tags":["Eventos"],"summary":"Assina eventos numa URL. Devolve o segredo de assinatura UMA vez","description":"Padrões aceitos em `eventos`: o nome exato, `recurso.*` ou `*`. Só chegam eventos de recursos que a chave pode ler.\n\nCada entrega é um POST com o corpo `{ evento, ocorridoEm, recurso: { tipo, id, … }, consultarEm, entrega }` e os cabeçalhos `miydas-evento` (Nome do evento), `miydas-entrega` (Id da entrega — o mesmo em cada nova tentativa; use para não processar duas vezes), `miydas-timestamp` (Milissegundos desde 1970, no momento do envio), `miydas-assinatura` (HMAC-SHA256 (hex) de `${timestamp}.${corpo}` com o segredo da assinatura). Responda 2xx em até 15 s. Outra resposta é tentada de novo em 1, 5, 15, 60, 120 min; depois disso, a entrega fica como falha em /v1/assinaturas/{id}/entregas.","operationId":"assinaturas_criar","security":[{"chaveApi":["webhook:gerenciar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":500,"description":"A URL, com esquema."},"eventos":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":20,"description":"Os eventos abrangidos."},"descricao":{"type":"string","maxLength":200,"description":"Para que serve esta assinatura. Aparece na lista — com três assinaturas ativas, é o que distingue uma da outra."}},"required":["url","eventos"],"additionalProperties":false},"example":{"url":"https://produto.exemplo.com.br/webhooks/miydas","eventos":["autorizacao.*"],"descricao":"Avisos de autorização"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssinaturaCriada"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0003ass","url":"https://produto.exemplo.com.br/webhooks/miydas","eventos":["autorizacao.*"],"descricao":"Avisos de autorização","ativa":true,"criadaEm":"2026-09-27T12:00:00.000Z","atualizadaEm":"2026-09-27T12:00:00.000Z","segredo":"whsec_exemplo"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}},"get":{"tags":["Eventos"],"summary":"Assinaturas ativas desta chave","operationId":"assinaturas_listar","security":[{"chaveApi":["webhook:gerenciar"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Assinatura"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0003ass","url":"https://produto.exemplo.com.br/webhooks/miydas","eventos":["autorizacao.*"],"descricao":"Avisos de autorização","ativa":true,"criadaEm":"2026-09-27T12:00:00.000Z","atualizadaEm":"2026-09-27T12:00:00.000Z"}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/assinaturas/{id}":{"get":{"tags":["Eventos"],"summary":"Uma assinatura","operationId":"assinaturas_obter","security":[{"chaveApi":["webhook:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Assinatura"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0003ass","url":"https://produto.exemplo.com.br/webhooks/miydas","eventos":["autorizacao.*"],"descricao":"Avisos de autorização","ativa":true,"criadaEm":"2026-09-27T12:00:00.000Z","atualizadaEm":"2026-09-27T12:00:00.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}},"delete":{"tags":["Eventos"],"summary":"Remove a assinatura (o histórico de entregas fica)","operationId":"assinaturas_remover","security":[{"chaveApi":["webhook:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"204":{"description":"Feito"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/assinaturas/{id}/segredo":{"post":{"tags":["Eventos"],"summary":"Troca o segredo de assinatura","description":"O segredo antigo deixa de valer na hora. Devolvido UMA vez.","operationId":"assinaturas_trocarSegredo","security":[{"chaveApi":["webhook:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SegredoAssinatura"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0003ass","segredo":"whsec_exemplo"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/assinaturas/{id}/entregas":{"get":{"tags":["Eventos"],"summary":"As últimas 50 entregas, com o que o destino respondeu","operationId":"assinaturas_entregas","security":[{"chaveApi":["webhook:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Entrega"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/assinaturas/{id}/teste":{"post":{"tags":["Eventos"],"summary":"Manda um `teste.ping` agora e diz o que o destino respondeu","operationId":"assinaturas_testar","security":[{"chaveApi":["webhook:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ResultadoTeste"}},"required":["data"]},"example":{"data":{"entrega":"cmf3k2x9a0004ent","entregue":true,"httpStatus":200,"erro":null}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/retencoes":{"get":{"tags":["Retenções"],"summary":"Imposto retido na fonte, consolidado por competência e tributo","description":"ISS, PIS, INSS e COFINS que a operadora retém e declara no demonstrativo de pagamento. Medido em produção: R$ 16.557.116,27 em 2.915 demonstrativos, com decomposição em 2.510. Sem `competencia`, consolida tudo e devolve a quebra por mês em `porCompetencia`.\n\n`semDecomposicao` diz quanto do total chegou sem abertura por tributo, e `divergencias` em quantos demonstrativos o total declarado não bate com a soma dos quatro. Os dois existem para que ninguém lance na contabilidade um valor que a operadora não abriu, nem um que não fecha.","operationId":"retencoes_consolidar","security":[{"chaveApi":["retencao:ler"]}],"parameters":[{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RetencaoConsolidada"}},"required":["data"]},"example":{"data":{"competencia":"2026-09","recorte":{"registroANS":null},"demonstrativos":112,"total":"58412.77","porTributo":{"iss":"14284.19","pis":"28487.11","ir":"9823.04","inss":"6152.80","cofins":"9488.67","outros":"176.96","naoMapeados":null},"semDecomposicao":{"demonstrativos":9,"total":"1201.44"},"divergencias":0,"porOperadora":[{"registroANS":"334561","nome":"Unimed Blumenau","demonstrativos":84,"total":"41905.22"}],"porCompetencia":[{"competencia":"2026-09","demonstrativos":112,"total":"58412.77"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/retencoes/demonstrativos":{"get":{"tags":["Retenções"],"summary":"A retenção demonstrativo por demonstrativo","description":"Para conferir o consolidado linha a linha. `competencia` é a da emissão do documento, em UTC.","operationId":"retencoes_listar","security":[{"chaveApi":["retencao:ler"]}],"parameters":[{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Retencao"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"demonstrativoId":"cmf3k2x9a0001dem","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroDemonstrativo":"000123456","competencia":"2026-10","fonteCompetencia":"CREDITO","emitidoEm":"2026-09-30","creditoEm":"2026-10-18","total":"7856.44","decomposicao":{"iss":"1926.94","pis":"4480.13","ir":"1445.20","inss":null,"cofins":null,"outros":"4.17","naoMapeados":null},"conferencia":{"somaDosTributos":"7856.44","confere":true},"valorLiquidoDoDemonstrativo":"4871.03"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/retencoes/{demonstrativoId}":{"get":{"tags":["Retenções"],"summary":"A retenção de um demonstrativo","description":"Responde 404 também quando o demonstrativo existe e não declara imposto retido.","operationId":"retencoes_obter","security":[{"chaveApi":["retencao:ler"]}],"parameters":[{"name":"demonstrativoId","in":"path","required":true,"description":"O demonstrativo a que este registro pertence, pelo identificador do Miydas.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Retencao"}},"required":["data"]},"example":{"data":{"demonstrativoId":"cmf3k2x9a0001dem","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroDemonstrativo":"000123456","competencia":"2026-10","fonteCompetencia":"CREDITO","emitidoEm":"2026-09-30","creditoEm":"2026-10-18","total":"7856.44","decomposicao":{"iss":"1926.94","pis":"4480.13","ir":"1445.20","inss":null,"cofins":null,"outros":"4.17","naoMapeados":null},"conferencia":{"somaDosTributos":"7856.44","confere":true},"valorLiquidoDoDemonstrativo":"4871.03"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/glosas":{"get":{"tags":["Glosas"],"summary":"Glosas com o significado oficial da Tabela 38 da ANS","description":"Cada glosa devolve `motivo.significado` — a diferença entre \"1705\" e o que 1705 quer dizer. Medido em produção: 56.267 glosas, 54.138 ligadas à Tabela 38.\n\n`competencia` é o mês do PROTOCOLO, não o da emissão do demonstrativo: o portal renderiza o documento no download, e o mês da emissão difere do do protocolo em 96,1% dos documentos medidos.\n\n`semCodigo=true` traz só as que a operadora cortou sem dizer por quê, que é material de recurso. `motivo.tipo` é derivado do que está presente, e não lido da coluna `tipoMotivo` — ela está nula em 93 % das linhas, e confiar nela classificaria quase tudo como desconhecido.","operationId":"glosas_listar","security":[{"chaveApi":["glosa:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"codigo","in":"query","required":false,"description":"O código do motivo da glosa, como a operadora o emitiu. Quando ela usa o oficial, é o código da Tabela 38 da ANS.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"O código do motivo da glosa, como a operadora o emitiu. Quando ela usa o oficial, é o código da Tabela 38 da ANS."}},{"name":"nivel","in":"query","required":false,"description":"Em que nível a glosa pende: `ITEM`, `GUIA` ou `PROTOCOLO`. Medido na base: 56.709 em item, 262 em guia, nenhuma em protocolo — o recurso TISS é item a item, e é no item que a glosa quase sempre mora.","schema":{"type":"string","enum":["PROTOCOLO","GUIA","ITEM"],"description":"Em que nível a glosa pende: `ITEM`, `GUIA` ou `PROTOCOLO`. Medido na base: 56.709 em item, 262 em guia, nenhuma em protocolo — o recurso TISS é item a item, e é no item que a glosa quase sempre mora."}},{"name":"semCodigo","in":"query","required":false,"description":"Só as glosas sem motivo codificado: a operadora cortou e não disse por quê. É material de recurso, e sem este filtro você teria de saber que \"sem código\" são três campos nulos ao mesmo tempo.","schema":{"type":"string","enum":["true","false"],"description":"Só as glosas sem motivo codificado: a operadora cortou e não disse por quê. É material de recurso, e sem este filtro você teria de saber que \"sem código\" são três campos nulos ao mesmo tempo."}},{"name":"valorMinimo","in":"query","required":false,"description":"Traz só registros com valor igual ou acima deste, em reais.","schema":{"type":"number","minimum":0,"description":"Traz só registros com valor igual ou acima deste, em reais."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Glosa"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001glo","nivel":"ITEM","motivo":{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","tipo":"TABELA_ANS","tipoDeclarado":null,"codigoOperadora":null,"categoria":null,"notaAuditor":null},"descricao":"Item não liberado na análise","valor":"8.94","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","protocolo":"PROTO-18700001","guia":{"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","carteira":"00000000000000000","beneficiario":"PACIENTE EXEMPLO"},"item":{"codigoTabela":"22","codigoProcedimento":"40301591","descricao":"Colesterol (LDL)"},"evidencia":{"demonstrativoId":"cmf3k2x9a0002dem","emitidoEm":"2026-09-30","protocoloEm":"2026-09-12","fonteOrdem":0,"completude":"FULL","profundidade":"A"},"registradaEm":"2026-10-01T09:14:22.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/glosas/resumo":{"get":{"tags":["Glosas"],"summary":"O retrato agregado: quanto, em que nível, e quanto sem motivo","operationId":"glosas_resumo","security":[{"chaveApi":["glosa:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ResumoDeGlosas"}},"required":["data"]},"example":{"data":{"recorte":{"registroANS":"334561","competencia":"2026-09"},"glosas":4118,"valorTotal":"197344.56","comSignificadoOficial":{"glosas":3964,"proporcao":0.9626},"semCodigo":{"glosas":154,"valorTotal":"21877.90"},"porNivel":[{"nivel":"ITEM","glosas":4092,"valorTotal":"197344.56"},{"nivel":"GUIA","glosas":26,"valorTotal":"0.00"}],"maioresPorValor":[{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","glosas":2841,"valorTotal":"128904.11"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/glosas/motivos":{"get":{"tags":["Glosas"],"summary":"O catálogo do que esta clínica recebeu, traduzido e ordenado por valor","description":"Reúne os motivos dos quatro tipos que a base conhece — código da ANS, código próprio da operadora, categoria em texto e sem motivo — numa lista só. A ordem é por valor, porque a pergunta de quem abre isto é o que custa mais.","operationId":"glosas_motivos","security":[{"chaveApi":["glosa:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotivoDeGlosa"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","tipo":"TABELA_ANS","glosas":2841,"valorTotal":"128904.11"}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/glosas/silenciosas":{"get":{"tags":["Glosas"],"summary":"Pago a menor sem glosa declarada","description":"A operadora pagou menos e não chamou de glosa — então não aparece em nenhum relatório de glosa, e some. Medido em produção: 82 guias, R$ 52.198,49.","operationId":"glosas_silenciosas","security":[{"chaveApi":["glosa:ler"]}],"parameters":[{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GlosaSilenciosa"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"guiaId":"cmf3k2x9a0001gcc","operadora":{"registroANS":"334561"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","protocolo":"PROTO-18700001","carteira":"00000000000000000","executadoEm":"2026-09-12","pagoEm":"2026-10-18","cobrado":"240.00","liberado":"180.00","diferenca":"60.00","percentual":25,"situacaoConciliacao":3}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/glosas/{id}":{"get":{"tags":["Glosas"],"summary":"Uma glosa, com significado e evidência","operationId":"glosas_obter","security":[{"chaveApi":["glosa:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Glosa"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001glo","nivel":"ITEM","motivo":{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","tipo":"TABELA_ANS","tipoDeclarado":null,"codigoOperadora":null,"categoria":null,"notaAuditor":null},"descricao":"Item não liberado na análise","valor":"8.94","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"competencia":"2026-09","protocolo":"PROTO-18700001","guia":{"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","carteira":"00000000000000000","beneficiario":"PACIENTE EXEMPLO"},"item":{"codigoTabela":"22","codigoProcedimento":"40301591","descricao":"Colesterol (LDL)"},"evidencia":{"demonstrativoId":"cmf3k2x9a0002dem","emitidoEm":"2026-09-30","protocoloEm":"2026-09-12","fonteOrdem":0,"completude":"FULL","profundidade":"A"},"registradaEm":"2026-10-01T09:14:22.000Z"}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios":{"get":{"tags":["Beneficiário"],"summary":"Busca por carteirinha ou nome","description":"`q` exige ao menos 3 caracteres. Não é ergonomia: sem mínimo, uma chamada devolveria a base de carteirinhas da clínica inteira. Dado de paciente sai por pergunta específica, não por varredura.","operationId":"beneficiarios_buscar","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":3,"maxLength":60,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiarioEncontrado"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO","operadora":{"registroANS":"334561"},"ultimaGuia":"2026-09-30"}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/beneficiarios/{carteira}":{"get":{"tags":["Beneficiário"],"summary":"O histórico de uma carteirinha","description":"A pergunta que nenhum sistema respondia: o que já aconteceu com esta carteirinha. Medido em produção: 17.464 carteirinhas distintas.\n\n`glosado` traz dois números e os dois são verdade: `declarado` é o que a operadora chamou de glosa; `derivado` é cobrado menos liberado. Quando divergem, a diferença é corte não declarado.","operationId":"beneficiarios_obter","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Beneficiario"}},"required":["data"]},"example":{"data":{"carteira":"00000000000000000","nome":"PACIENTE EXEMPLO","operadoras":[{"registroANS":"334561"}],"resumo":{"guias":11,"cobrado":"1888.73","liberado":"1079.82","glosado":{"declarado":"742.18","derivado":"808.91"},"taxaGlosa":0.4283,"guiasComGlosaDeclarada":7,"guiasPagas":9,"primeiraGuia":"2026-02-11","ultimaGuia":"2026-09-30"},"glosas":{"total":19,"valorTotal":"742.18"},"alertas":[{"tipo":"GLOSA_RECORRENTE","detalhe":"4 glosas com o código 1705 nesta carteirinha"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios/{carteira}/guias":{"get":{"tags":["Beneficiário"],"summary":"Toda guia da carteirinha, em toda competência","description":"`valores.cobrado` vem de uma coluna gerada no banco — o maior entre informado, processado e liberado. Não é o informado cru: há operadora que declara informado em escala nominal, e usar o informado inverteria o sinal da glosa.","operationId":"beneficiarios_guias","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GuiaDoBeneficiario"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"guiaId":"cmf3k2x9a0001gcc","operadora":{"registroANS":"334561"},"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","lote":"202609","protocolo":"PROTO-18700001","executadoEm":"2026-09-12","pagoEm":"2026-10-18","valores":{"cobrado":"240.00","liberado":"180.00","glosado":"60.00","diferenca":"60.00"},"conciliacao":{"situacao":{"codigo":4,"descricao":"Glosa parcial"},"glosaDeclarada":true,"direcaoDiferenca":"A_MENOR","percentualGlosa":25,"scoreConfianca":0.92,"prioridadeRevisao":"ALTA"}}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios/{carteira}/glosas":{"get":{"tags":["Beneficiário"],"summary":"O que foi cortado desta carteirinha, e por quê","operationId":"beneficiarios_glosas","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GlosaDoBeneficiario"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"glosaId":"cmf3k2x9a0001glo","nivel":"ITEM","motivo":{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","codigoOperadora":null,"categoria":null},"descricao":"Item não liberado na análise","valor":"8.94","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","procedimento":{"codigo":"40301591","descricao":"Colesterol (LDL)"},"registradaEm":"2026-10-01T09:14:22.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios/{carteira}/elegibilidades":{"get":{"tags":["Beneficiário"],"summary":"O histórico de consultas de elegibilidade","description":"Leitura: não fala com a operadora. Chave de teste vê só o que nasceu em homologação.","operationId":"beneficiarios_elegibilidades","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ElegibilidadeResumida"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"elegibilidadeId":"cmf3k2x9a0002ele","operadora":{"registroANS":"334561"},"elegivel":true,"alcance":"CARTEIRINHA","motivoNaoElegivel":null,"plano":"PLANO EXEMPLO","validadeCarteira":"2027-01-31","consultadaEm":"2026-09-27T13:00:01.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios/{carteira}/autorizacoes":{"get":{"tags":["Beneficiário"],"summary":"Senhas, validades e situações desta carteirinha","operationId":"beneficiarios_autorizacoes","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AutorizacaoResumida"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"autorizacaoId":"cmf3k2x9a0001aut","operadora":{"registroANS":"334561"},"situacao":{"codigo":"AUTORIZADA","codigoOperadora":"1"},"senha":"18700001","validadeSenha":"2026-10-27","autorizadaEm":"2026-09-27","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","solicitadaEm":"2026-09-27T13:02:10.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/beneficiarios/{carteira}/linha-do-tempo":{"get":{"tags":["Beneficiário"],"summary":"Tudo da carteirinha em ordem, de trás para frente","description":"Cada elo tem o instante em que o fato ACONTECEU, não em que foi registrado: a guia entra pela data de execução, o pagamento pela data do crédito. Ordenar por registro poria a importação do demonstrativo depois do atendimento que ela descreve. Elo sem data é omitido.","operationId":"beneficiarios_linhaDoTempo","security":[{"chaveApi":["beneficiario:ler"]}],"parameters":[{"name":"carteira","in":"path","required":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string"}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":100,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EloDaLinhaDoTempo"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"em":"2026-09-12T00:00:00.000Z","tipo":"GUIA_EXECUTADA","titulo":"Atendimento executado","valor":"240.00","referencia":"000123"}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/operadoras/{registroANS}/codigos":{"get":{"tags":["Referências"],"summary":"De-para do código próprio da operadora para a TUSS","description":"Há operadora que devolve o retorno com o código dela, não com o TUSS. Sem a tradução, o item não casa com nada do seu lado.\n\n`origem: DERIVADO` significa que a tradução foi OBSERVADA nos retornos — o mesmo código apareceu N vezes ao lado do mesmo TUSS —, não declarada pela operadora. `ocorrencias` é esse N: com 1 é palpite, com 40 é fato, e o número sai para você decidir em qual confiar.","operationId":"operadoras_codigos","security":[{"chaveApi":["operadora:ler"]}],"parameters":[{"name":"registroANS","in":"path","required":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CodigoDaOperadora"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"codigoOperadora":"LAB0391","codigoTuss":"40301591","descricao":"COLESTEROL LDL","origem":"DERIVADO","ocorrencias":42}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/operadoras/{registroANS}/documentos":{"get":{"tags":["Referências"],"summary":"O que a operadora publica, e se conseguimos ler","description":"A resposta para \"o que posso esperar receber desta operadora\": que documento ela publica, em que formato e com que periodicidade.\n\n`leitura: NAO_IMPLEMENTADO` é informação útil e desconfortável: a operadora publica e nós ainda não traduzimos, então o documento chega e para na caixa de entrada como PENDENTE.","operationId":"operadoras_documentos","security":[{"chaveApi":["operadora:ler"]}],"parameters":[{"name":"registroANS","in":"path","required":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DocumentosDaOperadora"}},"required":["data"]},"example":{"data":{"operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"documentos":[{"nome":"Demonstrativo de pagamento (XML TISS)","tipoDocumento":"DEMONSTRATIVO_PAGAMENTO","formato":"XML_TISS_FORMAT","periodicidade":"MENSAL","leitura":"PRODUCAO"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`OPERADORA_NAO_ENCONTRADA` — A empresa não tem essa operadora (registro ANS) cadastrada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ENCONTRADA","message":"A empresa não tem essa operadora (registro ANS) cadastrada.","details":null}}}}}}},"/v1/itens-faturaveis":{"post":{"tags":["Faturamento"],"summary":"Manda os exames realizados, para conferir antes de faturar","description":"A porta de entrada do pré-faturamento. Até aqui o caminho vivo era o lote TISS pronto: nenhum procedimento individual entrava, e a conferência antes do envio não tinha sobre o que rodar.\n\nIDEMPOTENTE PELO `idNaOrigem`, que tem de ser estável no seu sistema: é por ele que a segunda remessa reconhece o mesmo exame em vez de cobrá-lo duas vezes. Reenviar o arquivo do dia atualiza as linhas e `resumo` diz quantas nasceram e quantas já existiam.\n\nO reenvio NÃO volta atrás no que já andou: situação de faturamento, resultado de auditoria e responsável são do Miydas. Um exame já posto em guia não retorna para `A_FATURAR`.\n\nValor é opcional. Quando você manda unitário e total, os dois são gravados como vieram — o total pode trazer desconto ou pacote do seu contrato, e recalcular seria decidir por você quanto cobrar.","operationId":"itens_faturaveis_registrar","security":[{"chaveApi":["faturavel:registrar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itens":{"type":"array","items":{"type":"object","properties":{"idNaOrigem":{"type":"string","minLength":1,"maxLength":120,"description":"O identificador do exame NO SEU SISTEMA. Tem de ser estável: é por ele que a remessa seguinte reconhece o mesmo exame em vez de cobrá-lo duas vezes."},"descricao":{"type":"string","minLength":1,"maxLength":200,"description":"Descrição do item, como a fonte a informou."},"codigoTuss":{"type":"string","maxLength":10,"nullable":true,"description":"Código do procedimento na TUSS, a terminologia da ANS."},"codigoTabela":{"type":"string","maxLength":2,"nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `18`/`19`/`20` = materiais, taxas e medicamentos, `00` = tabela própria da operadora)."},"quantidade":{"type":"number","exclusiveMinimum":true,"minimum":0,"maximum":99999,"nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"tipoItem":{"type":"string","enum":["PROCEDIMENTO","MATERIAL","MEDICAMENTO","TAXA","DIARIA","GAS","OPME"],"nullable":true,"description":"O que a linha é: `PROCEDIMENTO` (o padrão), `MATERIAL`, `MEDICAMENTO`, `TAXA`, `DIARIA`, `GAS` ou `OPME`. Procedimento e despesa dividem a mesma numeração dentro da guia, e é por ela que a operadora devolve o julgamento de cada um."},"unidadeMedida":{"type":"string","maxLength":20,"nullable":true,"description":"Unidade em que a quantidade é contada, no código de TRÊS dígitos da tabela 60 do TUSS (`001` a `061`). Obrigatória em despesa — o padrão TISS recusa despesa sem ela, e texto livre como \"ampola\" não serve."},"itemVinculado":{"type":"string","maxLength":120,"nullable":true,"description":"Em despesa: o `idNaOrigem` do procedimento que a consumiu. É o que permite à operadora julgar o material contra o exame que o usou."},"codigoDespesa":{"type":"string","maxLength":10,"nullable":true,"description":"O tipo da despesa para a operadora (`dm_outrasDespesas`). Quando ausente, é deduzido de `tipoItem`."},"registroAnvisa":{"type":"string","maxLength":15,"nullable":true,"description":"Registro ANVISA do material ou medicamento, quando a operadora o exige."},"refFabricante":{"type":"string","maxLength":60,"nullable":true,"description":"Referência do fabricante do material, quando a operadora a exige."},"solicitanteNome":{"type":"string","maxLength":70,"nullable":true,"description":"Nome do médico solicitante. Em branco, a emissão usa o solicitante padrão cadastrado para o convênio."},"solicitanteConselho":{"type":"string","maxLength":10,"nullable":true,"description":"O conselho do solicitante (`06` = CRM), como em `dm_conselhoProfissional`."},"solicitanteNumero":{"type":"string","maxLength":15,"nullable":true,"description":"O número do solicitante no conselho."},"solicitanteUf":{"type":"string","maxLength":2,"nullable":true,"description":"A UF do conselho do solicitante — sigla ou código IBGE; a emissão converte."},"solicitanteCbo":{"type":"string","maxLength":10,"nullable":true,"description":"O CBO do solicitante."},"senhaInformada":{"type":"string","maxLength":20,"nullable":true,"description":"A senha de autorização que VOCÊ já recebeu da operadora por outro canal. Diferente da autorização solicitada por nós no portal: esta é declarada, não conquistada aqui."},"guiaOperadoraInformada":{"type":"string","maxLength":20,"nullable":true,"description":"O número da guia na operadora, quando você já o tem."},"validadeSenhaInformada":{"type":"string","format":"date","nullable":true,"description":"Até quando a senha informada vale, `AAAA-MM-DD`."},"guiaPrestadorInformada":{"type":"string","maxLength":20,"nullable":true,"description":"Número que a origem já atribuiu à guia. Mantém a mesma identidade do lote do cliente até a autorização e o lote daqui."},"valorUnitario":{"anyOf":[{"type":"string","maxLength":20},{"type":"number"}],"nullable":true,"description":"Valor de uma unidade do procedimento, em reais, decimal em string."},"valorTotal":{"anyOf":[{"type":"string","maxLength":20},{"type":"number"}],"nullable":true,"description":"Soma em reais, decimal em string com duas casas."},"dataExecucao":{"type":"string","format":"date","nullable":true,"description":"Data em que o procedimento foi executado, `AAAA-MM-DD`."},"competencia":{"type":"string","pattern":"^\\d{4}-\\d{2}$","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"pacienteNome":{"type":"string","maxLength":120,"nullable":true,"description":"Nome do paciente como consta no seu sistema."},"pacienteCpf":{"type":"string","maxLength":14,"nullable":true,"description":"CPF do paciente, com ou sem máscara."},"pacienteCarteira":{"type":"string","maxLength":30,"nullable":true,"description":"Número da carteirinha do paciente na operadora."},"pacienteNascimento":{"type":"string","format":"date","nullable":true,"description":"Data de nascimento do paciente, `AAAA-MM-DD`."},"registroAns":{"type":"string","minLength":5,"maxLength":6,"nullable":true,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público."},"fatorReducaoAcrescimo":{"anyOf":[{"type":"string","maxLength":10},{"type":"number"}],"nullable":true,"description":"`st_decimal3-2` do XSD: 1,00 é o valor cheio. Reduz ou acresce o item por regra do contrato."},"horaInicial":{"type":"string","maxLength":8,"nullable":true,"description":"Hora de início do procedimento (`hh:mm`), exigida pelo XSD em alguns tipos de item."},"horaFinal":{"type":"string","maxLength":8,"nullable":true,"description":"Hora de término do procedimento (`hh:mm`), par de `horaInicial`."},"atendimentoRN":{"type":"string","enum":["S","N"],"nullable":true,"description":"Atendimento a recém-nascido: `S` quando o exame é do RN e corre na carteira da mãe."},"dataAutorizacao":{"type":"string","format":"date","nullable":true,"description":"Data em que a operadora autorizou, `AAAA-MM-DD`."},"guiaPrincipal":{"type":"string","maxLength":20,"nullable":true,"description":"Número da guia à qual esta se vincula, quando a autorização foi dividida em várias guias."},"solicitanteDocumento":{"type":"string","maxLength":14,"nullable":true,"description":"Documento do contratado solicitante (CNPJ ou CPF), quando o solicitante é pessoa jurídica."},"solicitanteContratadoNome":{"type":"string","maxLength":70,"nullable":true,"description":"Nome do contratado solicitante, como a operadora o cadastrou."},"dataSolicitacao":{"type":"string","format":"date","nullable":true,"description":"Data em que a autorização foi solicitada, `AAAA-MM-DD`."},"executanteNome":{"type":"string","maxLength":70,"nullable":true,"description":"Nome do profissional que executou o procedimento."},"executanteConselho":{"type":"string","maxLength":10,"nullable":true,"description":"Sigla do conselho do executante (CRM, CRO, CRF…)."},"executanteNumero":{"type":"string","maxLength":15,"nullable":true,"description":"Número do conselho do executante."},"executanteUf":{"type":"string","maxLength":2,"nullable":true,"description":"UF do conselho do executante."},"executanteCbo":{"type":"string","maxLength":10,"nullable":true,"description":"CBO do executante — a ocupação, não a especialidade."},"executanteCpf":{"type":"string","maxLength":11,"nullable":true,"description":"CPF do executante, exigido por algumas operadoras no lugar do conselho."},"grauParticipacao":{"type":"string","maxLength":2,"nullable":true,"description":"O papel do profissional no procedimento, no código TISS (ex. `00` = cirurgião)."},"cid10":{"type":"string","maxLength":10,"nullable":true,"description":"Código CID-10 relacionado ao procedimento."},"indicacaoClinica":{"type":"string","maxLength":500,"nullable":true,"description":"A justificativa clínica do pedido, em texto livre. É o que a operadora lê para decidir."},"viaAcesso":{"type":"string","maxLength":1,"nullable":true,"description":"Via de acesso do procedimento, pela tabela 35 do TISS."},"tecnicaUtilizada":{"type":"string","maxLength":1,"nullable":true,"description":"Técnica utilizada (convencional ou videolaparoscopia), pela tabela 36 do TISS."},"saudeOcupacional":{"type":"string","maxLength":1,"nullable":true,"description":"Tipo de atendimento em saúde ocupacional, pela tabela 61 do TISS."},"caraterAtendimento":{"type":"string","maxLength":1,"nullable":true,"description":"Caráter do atendimento: 1 eletivo, 2 urgência/emergência. Campo de cabeçalho da guia."},"tipoAtendimento":{"type":"string","maxLength":2,"nullable":true,"description":"Tipo de atendimento, pela tabela 50 do TISS. Campo de cabeçalho da guia."},"regimeAtendimento":{"type":"string","maxLength":2,"nullable":true,"description":"Regime de atendimento, pela tabela 51 do TISS. Campo de cabeçalho da guia."},"indicacaoAcidente":{"type":"string","maxLength":1,"nullable":true,"description":"Indicação de acidente, pela tabela 36 do TISS: trabalho, trânsito, outros, ou não é acidente."},"observacao":{"type":"string","maxLength":500,"nullable":true,"description":"Observação registrada, em texto livre."},"dadosOrigem":{"type":"object","additionalProperties":{},"nullable":true,"description":"O registro como ele existe no seu sistema, inteiro. Guardado para auditoria e para reprocessar sem precisar pedir de novo."}},"required":["idNaOrigem","descricao"],"additionalProperties":false},"minItems":1,"maxItems":500,"description":"Os exames realizados desta remessa. Até 500 por pedido."}},"required":["itens"],"additionalProperties":false},"example":{"itens":[{"idNaOrigem":"LIS-2026-1042","descricao":"Hemograma completo","codigoTuss":"40304361","quantidade":1,"valorUnitario":"28.50","dataExecucao":"2026-10-28","pacienteNome":"MARIA DA SILVA SANTOS","pacienteCarteira":"00000000000000","registroAns":"343889"}]}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RemessaDeItensFaturaveis"}},"required":["data"]},"example":{"data":{"itens":[{"id":"itf_01HQ8X","fonte":"LIS_API","idNaOrigem":"LIS-2026-1042","paciente":{"nome":"MARIA DA SILVA SANTOS","carteira":"00000000000000","cpf":null},"operadora":{"registroAns":"343889","nome":"Unimed Blumenau","convenioId":"hp_01HQ"},"procedimento":{"tabela":"22","codigo":"40304361","descricao":"Hemograma completo","quantidade":1},"valorUnitario":"28.50","valorTotal":"28.50","dataExecucao":"2026-10-28T00:00:00.000Z","competencia":"2026-10","situacao":"A_FATURAR","auditoria":"NAO_AUDITADO","auditadoEm":null,"responsavelUserId":null,"requisicao":null,"autorizacao":null,"achados":[]}],"resumo":{"criados":1,"atualizados":0}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}},"get":{"tags":["Faturamento"],"summary":"O que foi realizado e ainda não foi cobrado","description":"DUAS DIMENSÕES, DOIS FILTROS. `situacao` é onde o item está no ciclo do dinheiro; `auditoria` é o que a conferência concluiu. São independentes: `situacao=A_FATURAR&auditoria=BLOQUEADO` é a fila de quem conserta, e `situacao=A_FATURAR&auditoria=APTO` é o que pode virar guia agora.\n\n`totais` vem do recorte inteiro, não da página: é o número que se usa para decidir o que fecha no mês.","operationId":"itens_faturaveis_listar","security":[{"chaveApi":["faturavel:ler"]}],"parameters":[{"name":"page","in":"query","required":false,"description":"A página a trazer, começando em 1.","schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"default":1,"description":"A página a trazer, começando em 1."}},{"name":"pageSize","in":"query","required":false,"description":"Quantos registros por página. Máximo 200.","schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200,"default":50,"description":"Quantos registros por página. Máximo 200."}},{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"registroAns","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público.","schema":{"type":"string","minLength":5,"maxLength":6,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"de","in":"query","required":false,"description":"Início do período, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra.","schema":{"type":"string","format":"date","description":"Início do período, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."}},{"name":"ate","in":"query","required":false,"description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra.","schema":{"type":"string","format":"date","description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra."}},{"name":"situacao","in":"query","required":false,"description":"Onde o item está no ciclo do dinheiro: `A_FATURAR`, `EM_GUIA`, `EM_LOTE`, `ENVIADO` ou `EXCLUIDO`.","schema":{"type":"string","enum":["A_FATURAR","EM_GUIA","EM_LOTE","ENVIADO","EXCLUIDO"],"description":"Onde o item está no ciclo do dinheiro: `A_FATURAR`, `EM_GUIA`, `EM_LOTE`, `ENVIADO` ou `EXCLUIDO`."}},{"name":"incluirFaturados","in":"query","required":false,"description":"Se `false`, esconde os exames que já viraram guia, lote ou foram transmitidos — a fila de quem ainda falta faturar. Ausente, a listagem traz todos.","schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false","1","0",""]}],"description":"Se `false`, esconde os exames que já viraram guia, lote ou foram transmitidos — a fila de quem ainda falta faturar. Ausente, a listagem traz todos."}},{"name":"auditoria","in":"query","required":false,"description":"O que a conferência concluiu: `NAO_AUDITADO`, `APTO`, `ALERTA`, `BLOQUEADO` ou `DESATUALIZADO`. É independente da situação — um item pode estar a faturar e bloqueado ao mesmo tempo.","schema":{"type":"string","enum":["NAO_AUDITADO","APTO","ALERTA","BLOQUEADO","DESATUALIZADO"],"description":"O que a conferência concluiu: `NAO_AUDITADO`, `APTO`, `ALERTA`, `BLOQUEADO` ou `DESATUALIZADO`. É independente da situação — um item pode estar a faturar e bloqueado ao mesmo tempo."}},{"name":"comAchado","in":"query","required":false,"description":"Só os itens com alguma pendência de conferência ainda aberta — a fila de quem conserta.","schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false","1","0",""]}],"description":"Só os itens com alguma pendência de conferência ainda aberta — a fila de quem conserta."}},{"name":"familia","in":"query","required":false,"description":"Família do problema de faturamento: `AUTORIZACAO`, `VALOR`, `PROCEDIMENTO`, `EXECUCAO`, `DUPLICIDADE`, `BENEFICIARIO`, `GUIA`, `PRAZO`, `DOCUMENTO` ou `REGRA`. Filtra os exames que têm pendência aberta daquela família.","schema":{"type":"string","enum":["BENEFICIARIO","AUTORIZACAO","PROCEDIMENTO","EXECUCAO","VALOR","DUPLICIDADE","DOCUMENTO","GUIA","PRAZO","REGRA"],"description":"Família do problema de faturamento: `AUTORIZACAO`, `VALOR`, `PROCEDIMENTO`, `EXECUCAO`, `DUPLICIDADE`, `BENEFICIARIO`, `GUIA`, `PRAZO`, `DOCUMENTO` ou `REGRA`. Filtra os exames que têm pendência aberta daquela família."}},{"name":"codigoProblema","in":"query","required":false,"description":"Um problema específico do catálogo, como `AUT-001`. Filtra os exames com esse problema em aberto.","schema":{"type":"string","maxLength":10,"description":"Um problema específico do catálogo, como `AUT-001`. Filtra os exames com esse problema em aberto."}},{"name":"severidade","in":"query","required":false,"description":"`BLOQUEIA` impede faturar; `ALERTA` deixa seguir com ressalva; `INFO` é observação.","schema":{"type":"string","enum":["BLOQUEIA","ALERTA","INFO"],"description":"`BLOQUEIA` impede faturar; `ALERTA` deixa seguir com ressalva; `INFO` é observação."}},{"name":"responsavelUserId","in":"query","required":false,"description":"Quem está com o item na mão, pelo identificador do usuário no Miydas.","schema":{"type":"string","maxLength":64,"description":"Quem está com o item na mão, pelo identificador do usuário no Miydas."}},{"name":"semResponsavel","in":"query","required":false,"description":"Só os exames que ainda não têm dono — a fila de quem vai pegar trabalho.","schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false","1","0",""]}],"description":"Só os exames que ainda não têm dono — a fila de quem vai pegar trabalho."}},{"name":"agrupamento","in":"query","required":false,"description":"Como agrupar a resposta: `requisicao`, `paciente`, `operadora` ou `competencia`. Ausente, vem a lista de exames; presente, vêm os grupos com os totais de cada um.","schema":{"type":"string","enum":["requisicao","paciente","operadora","competencia"],"description":"Como agrupar a resposta: `requisicao`, `paciente`, `operadora` ou `competencia`. Ausente, vem a lista de exames; presente, vêm os grupos com os totais de cada um."}},{"name":"ordenarPor","in":"query","required":false,"description":"Por qual coluna ordenar: `dataExecucao`, `competencia`, `pacienteNome`, `descricao`, `codigoTuss`, `quantidade`, `valorTotal`, `valorUnitario`, `auditoria`, `situacao`, `createdAt` ou `updatedAt`. Sem ele, os mais antigos vêm primeiro — a fila é por espera.","schema":{"type":"string","enum":["dataExecucao","competencia","pacienteNome","descricao","codigoTuss","quantidade","valorTotal","valorUnitario","auditoria","situacao","createdAt","updatedAt"],"description":"Por qual coluna ordenar: `dataExecucao`, `competencia`, `pacienteNome`, `descricao`, `codigoTuss`, `quantidade`, `valorTotal`, `valorUnitario`, `auditoria`, `situacao`, `createdAt` ou `updatedAt`. Sem ele, os mais antigos vêm primeiro — a fila é por espera."}},{"name":"direcao","in":"query","required":false,"description":"O sentido da ordenação: `asc` ou `desc`. Padrão `desc`.","schema":{"type":"string","enum":["asc","desc"],"description":"O sentido da ordenação: `asc` ou `desc`. Padrão `desc`."}},{"name":"paciente","in":"query","required":false,"description":"O paciente: na listagem, filtra pelo nome, por trecho.","schema":{"type":"string","maxLength":120,"description":"O paciente: na listagem, filtra pelo nome, por trecho."}},{"name":"carteira","in":"query","required":false,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.","schema":{"type":"string","maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."}},{"name":"solicitante","in":"query","required":false,"description":"Quem pediu o procedimento.","schema":{"type":"string","maxLength":70,"description":"Quem pediu o procedimento."}},{"name":"guia","in":"query","required":false,"description":"A guia a que este registro pertence.","schema":{"type":"string","maxLength":20,"description":"A guia a que este registro pertence."}},{"name":"senha","in":"query","required":false,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução.","schema":{"type":"string","maxLength":20,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."}},{"name":"codigoTuss","in":"query","required":false,"description":"Código do procedimento na TUSS, a terminologia da ANS.","schema":{"type":"string","maxLength":10,"description":"Código do procedimento na TUSS, a terminologia da ANS."}},{"name":"tipoItem","in":"query","required":false,"description":"O que a linha é: `PROCEDIMENTO` (o padrão), `MATERIAL`, `MEDICAMENTO`, `TAXA`, `DIARIA`, `GAS` ou `OPME`. Procedimento e despesa dividem a mesma numeração dentro da guia, e é por ela que a operadora devolve o julgamento de cada um.","schema":{"type":"string","enum":["PROCEDIMENTO","MATERIAL","MEDICAMENTO","TAXA","DIARIA","GAS","OPME"],"description":"O que a linha é: `PROCEDIMENTO` (o padrão), `MATERIAL`, `MEDICAMENTO`, `TAXA`, `DIARIA`, `GAS` ou `OPME`. Procedimento e despesa dividem a mesma numeração dentro da guia, e é por ela que a operadora devolve o julgamento de cada um."}},{"name":"fonte","in":"query","required":false,"description":"De onde o exame veio: `LIS_API`, `REQUISICAO`, `PLANILHA`, `CONECTOR` ou `MANUAL`.","schema":{"type":"string","enum":["LIS_API","REQUISICAO","PLANILHA","CONECTOR","MANUAL","ARQUIVO_TISS"],"description":"De onde o exame veio: `LIS_API`, `REQUISICAO`, `PLANILHA`, `CONECTOR` ou `MANUAL`."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemFaturavel"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"itf_01HQ8X","fonte":"LIS_API","idNaOrigem":"LIS-2026-1042","paciente":{"nome":"MARIA DA SILVA SANTOS","carteira":"00000000000000","cpf":null},"operadora":{"registroAns":"343889","nome":"Unimed Blumenau","convenioId":"hp_01HQ"},"procedimento":{"tabela":"22","codigo":"40304361","descricao":"Hemograma completo","quantidade":1},"valorUnitario":"28.50","valorTotal":"28.50","dataExecucao":"2026-10-28T00:00:00.000Z","competencia":"2026-10","situacao":"A_FATURAR","auditoria":"NAO_AUDITADO","auditadoEm":null,"responsavelUserId":null,"requisicao":null,"autorizacao":null,"achados":[]}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/lotes-importados":{"get":{"tags":["Faturamento"],"summary":"Os lotes que o prestador importou — a camada de envio","description":"NÃO É O MESMO QUE `/v1/lotes`. Aquele é o lote que esta API montou e transmitiu, e dele guardamos a mensagem TISS e os totais. Este é o lote que o prestador IMPORTOU: o XML que ele mandou à operadora pela própria conta. Medido, os dois não se cruzam por número de lote.\n\nImporta porque `/v1/guias` diz que a camada de envio está ausente em 40.746 das 40.760 guias — o portal devolve julgamento e não guarda o que o prestador mandou. As que TÊM envio vieram daqui.","operationId":"lotes_importados_listar","security":[{"chaveApi":["lote:ler"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LoteImportado"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001lti","numeroLote":"2026070112","competencia":"2026-07","tipoGuia":"SP_SADT","versaoTiss":"4.01.00","origem":"IMPORTADO","situacao":"IMPORTADO","protocolo":"4530775","emitidoEm":"2026-07-01","transmitidoEm":null,"valorTotal":"12840.55","conformidade":{"xsdValido":true},"guias":42,"importadoEm":"2026-07-03T09:11:00.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/lotes-importados/{id}/guias":{"get":{"tags":["Faturamento"],"summary":"As guias do lote, com os itens de cada uma","description":"SP/SADT e Consulta na mesma lista, distinguidas por `tipo`: quem pergunta \"o que eu mandei neste lote\" não quer duas respostas para juntar. Consulta vem com `itens: []` — a consulta É o procedimento.","operationId":"lotes_importados_guias","security":[{"chaveApi":["lote:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GuiasDoLote"}},"required":["data"]},"example":{"data":{"loteId":"cmf3k2x9a0001lti","numeroLote":"2026070112","guias":[{"tipo":"SP_SADT","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","senha":"18700001","autorizadaEm":"2026-06-28","carteira":"00000000000000000","beneficiario":"PACIENTE EXEMPLO","cobrado":"226.29","itens":[{"sequencial":1,"tipo":"PROCEDIMENTO","tabela":"22","codigo":"40301591","descricao":"COLESTEROL LDL","quantidade":"1","valorUnitario":"8.94","cobrado":"8.94","executadoEm":"2026-07-02"}],"atendidaEm":null}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/documentos-recebidos":{"get":{"tags":["Recebimento"],"summary":"Tudo que chegou — e o que não virou dado","description":"O documento antes de virar demonstrativo: o que o portal baixou e o que alguém subiu pela tela.\n\nO VALOR DESTA ROTA É O QUE FALHOU. Medido: de 14.838 arquivos recebidos, 12.591 viraram demonstrativo e 1.413 pararam — 946 sem identificação da operadora, 455 com erro de processamento, 12 rejeitados. Esse é o buraco invisível: o dado chegou, ninguém leu, e até agora não existia pergunta que o encontrasse.\n\n`situacao` tem quatro valores públicos sobre quinze estados internos. `PENDENTE` é o que parou esperando uma decisão; `FALHOU` é leitura que quebrou. `situacao=PENDENTE` é a fila de trabalho.","operationId":"documentos_listar","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"situacao","in":"query","required":false,"description":"Onde o arquivo parou. `PROCESSADO` virou dado consultável; `PENDENTE` parou esperando alguém (não identificado, ou rejeitado); `FALHOU` quebrou no processamento. Os dois últimos são o valor desta rota.","schema":{"type":"string","enum":["EM_ANDAMENTO","PROCESSADO","PENDENTE","FALHOU"],"description":"Onde o arquivo parou. `PROCESSADO` virou dado consultável; `PENDENTE` parou esperando alguém (não identificado, ou rejeitado); `FALHOU` quebrou no processamento. Os dois últimos são o valor desta rota."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"tipoDocumento","in":"query","required":false,"description":"O tipo que o Miydas reconheceu no arquivo (ex. `DEMONSTRATIVO_ANALISE`, `DEMONSTRATIVO_PAGAMENTO`). Arquivo não identificado não tem tipo.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"O tipo que o Miydas reconheceu no arquivo (ex. `DEMONSTRATIVO_ANALISE`, `DEMONSTRATIVO_PAGAMENTO`). Arquivo não identificado não tem tipo."}},{"name":"formato","in":"query","required":false,"description":"Em que formato o dado chegou.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"Em que formato o dado chegou."}},{"name":"recebidoDe","in":"query","required":false,"description":"Recebidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Recebidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."}},{"name":"recebidoAte","in":"query","required":false,"description":"Recebidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Recebidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra."}},{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":2,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoRecebido"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001inb","nomeArquivo":"demonstrativo_202607.xml","extensao":"xml","formato":"XML_TISS_FORMAT","tipoDocumento":"DEMONSTRATIVO_PAGAMENTO","tamanhoBytes":274732,"situacao":{"codigo":"PROCESSADO","descricao":"O documento virou dado: demonstrativo, guia e glosa já estão consultáveis.","estadoInterno":"INBOX_DISTRIBUIDO"},"operadora":{"registroANS":"334561"},"competencia":"2026-07","recebidoEm":"2026-08-02T11:04:19.000Z","processadoEm":"2026-08-02T11:05:02.000Z","totais":{"guias":42,"itens":318,"faturado":"12840.55","pago":"12104.31","glosa":"736.24"},"confianca":0.98,"erro":null,"avisos":null}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/documentos-recebidos/resumo":{"get":{"tags":["Recebimento"],"summary":"De tudo que chegou, quanto virou dado","operationId":"documentos_resumo","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"situacao","in":"query","required":false,"description":"Onde o arquivo parou. `PROCESSADO` virou dado consultável; `PENDENTE` parou esperando alguém (não identificado, ou rejeitado); `FALHOU` quebrou no processamento. Os dois últimos são o valor desta rota.","schema":{"type":"string","enum":["EM_ANDAMENTO","PROCESSADO","PENDENTE","FALHOU"],"description":"Onde o arquivo parou. `PROCESSADO` virou dado consultável; `PENDENTE` parou esperando alguém (não identificado, ou rejeitado); `FALHOU` quebrou no processamento. Os dois últimos são o valor desta rota."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"tipoDocumento","in":"query","required":false,"description":"O tipo que o Miydas reconheceu no arquivo (ex. `DEMONSTRATIVO_ANALISE`, `DEMONSTRATIVO_PAGAMENTO`). Arquivo não identificado não tem tipo.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"O tipo que o Miydas reconheceu no arquivo (ex. `DEMONSTRATIVO_ANALISE`, `DEMONSTRATIVO_PAGAMENTO`). Arquivo não identificado não tem tipo."}},{"name":"formato","in":"query","required":false,"description":"Em que formato o dado chegou.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"Em que formato o dado chegou."}},{"name":"recebidoDe","in":"query","required":false,"description":"Recebidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Recebidos a partir deste dia, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."}},{"name":"recebidoAte","in":"query","required":false,"description":"Recebidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Recebidos até este dia, `AAAA-MM-DD`, inclusive — o dia inteiro entra."}},{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":2,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ResumoDeDocumentos"}},"required":["data"]},"example":{"data":{"total":14838,"parados":1413,"porSituacao":[{"situacao":"EM_ANDAMENTO","documentos":1},{"situacao":"PROCESSADO","documentos":13424},{"situacao":"PENDENTE","documentos":946},{"situacao":"FALHOU","documentos":467}],"porEstadoInterno":[{"estadoInterno":"INBOX_DISTRIBUIDO","documentos":12591},{"estadoInterno":"INBOX_PENDENTE_IDENTIFICACAO","documentos":946}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/documentos-recebidos/{id}":{"get":{"tags":["Recebimento"],"summary":"Um documento recebido, com o motivo de ter parado","operationId":"documentos_obter","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DocumentoRecebido"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001inb","nomeArquivo":"demonstrativo_202607.xml","extensao":"xml","formato":"XML_TISS_FORMAT","tipoDocumento":"DEMONSTRATIVO_PAGAMENTO","tamanhoBytes":274732,"situacao":{"codigo":"PROCESSADO","descricao":"O documento virou dado: demonstrativo, guia e glosa já estão consultáveis.","estadoInterno":"INBOX_DISTRIBUIDO"},"operadora":{"registroANS":"334561"},"competencia":"2026-07","recebidoEm":"2026-08-02T11:04:19.000Z","processadoEm":"2026-08-02T11:05:02.000Z","totais":{"guias":42,"itens":318,"faturado":"12840.55","pago":"12104.31","glosa":"736.24"},"confianca":0.98,"erro":null,"avisos":null}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/execucoes/{id}/passos":{"get":{"tags":["Recebimento"],"summary":"Onde o robô esteve e onde parou","description":"`GET /v1/execucoes/{id}` devolve o desfecho; esta rota devolve o caminho. Quando uma execução falha, é aqui que se vê se nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu.\n\nExecução retentada traz os passos das duas tentativas, e cada passo diz de qual tentativa é.\n\n`details` e `screenshotUrl` NÃO saem: o primeiro é despejo do conector e mudaria a cada ajuste de leiaute; o segundo aponta para uma imagem que pode conter dado de paciente na tela do portal.","operationId":"execucoes_passos","security":[{"chaveApi":["execucao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PassosDaExecucao"}},"required":["data"]},"example":{"data":{"execucaoId":"cmf3k2x9a0001exe","tentativas":1,"passos":[{"tentativa":1,"numero":1,"nome":"login","tipo":"AUTH","situacao":"SUCCESS","iniciadoEm":"2026-10-24T20:57:01.000Z","concluidoEm":"2026-10-24T20:57:09.000Z","duracaoMs":8140,"erro":null},{"tentativa":1,"numero":2,"nome":"buscar demonstrativos","tipo":"FETCH","situacao":"FAILED","iniciadoEm":"2026-10-24T20:57:09.000Z","concluidoEm":"2026-10-24T20:57:24.000Z","duracaoMs":15002,"erro":"Nenhum relatório consolidado emitido nesta conta"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/referencias/tuss":{"get":{"tags":["Referências"],"summary":"Terminologia TUSS — 54.497 termos, o vigente por padrão","description":"A tabela que a guia TISS exige. `tabela=22` são os procedimentos, `tabela=38` os motivos de glosa, `19`/`20` materiais e medicamentos.\n\nPor padrão devolve só o que está VIGENTE: código revogado numa guia é recusa certa. `incluirRevogados=true` traz o histórico, de propósito.\n\nNão tem recorte de empresa — é tabela pública, igual para todo mundo.","operationId":"referencias_tuss","security":[{"chaveApi":["operadora:ler"]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":2,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"codigo","in":"query","required":false,"description":"O código exato do termo na tabela. Use com `tabela` — o mesmo código existe em tabelas diferentes com significados diferentes.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"O código exato do termo na tabela. Use com `tabela` — o mesmo código existe em tabelas diferentes com significados diferentes."}},{"name":"tabela","in":"query","required":false,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`.","schema":{"type":"integer","minimum":1,"maximum":99,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."}},{"name":"incluirRevogados","in":"query","required":false,"description":"Traz também código já revogado. Por padrão `false`: código revogado atrapalha quem monta guia, mas é necessário para ler documento antigo.","schema":{"type":"string","enum":["true","false"],"description":"Traz também código já revogado. Por padrão `false`: código revogado atrapalha quem monta guia, mas é necessário para ler documento antigo."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TermoTuss"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"codigo":"40301591","termo":"Colesterol LDL, dosagem","descricaoDetalhada":null,"tabela":22,"tipoDaTabela":"PROCEDIMENTOS","vigenteDe":"2012-01-01","vigenteAte":null,"apresentacao":null,"fabricante":null,"registroANVISA":null,"porte":"1A","capitulo":"Procedimentos diagnósticos e terapêuticos","grupo":"Análises clínicas"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/referencias/operadoras-ans":{"get":{"tags":["Referências"],"summary":"Operadoras registradas na ANS — ache o registroANS pelo CNPJ","description":"Toda operação desta API pede `registroANS`, e quem integra costuma ter o CNPJ. Esta rota faz a ponte: busca por CNPJ (com ou sem máscara), por nome ou pelo próprio registro.\n\nSão 1.110 operadoras ativas. Estar aqui não significa que o Miydas a atende — isso é `GET /v1/operadoras`.","operationId":"referencias_operadoras_ans","security":[{"chaveApi":["operadora:ler"]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":2,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"registroAns","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público."}},{"name":"cnpj","in":"query","required":false,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.","schema":{"type":"string","minLength":11,"maxLength":18,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."}},{"name":"uf","in":"query","required":false,"description":"Sigla da unidade federativa, duas letras (ex. `SC`).","schema":{"type":"string","minLength":2,"maxLength":2,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OperadoraAns"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"registroANS":"334561","cnpj":"82098153000173","razaoSocial":"UNIMED BLUMENAU COOPERATIVA DE TRABALHO MEDICO","nomeFantasia":"UNIMED BLUMENAU","modalidade":"COOPERATIVA_MEDICA","cidade":"Blumenau","uf":"SC","registradaEm":"1999-05-13"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/referencias/cnes":{"get":{"tags":["Referências"],"summary":"Estabelecimentos de saúde no CNES — 140.937 unidades","description":"O código CNES que a guia TISS exige do prestador. Busca por CNPJ, por nome, por município (código IBGE) ou pelo próprio código.","operationId":"referencias_cnes","security":[{"chaveApi":["operadora:ler"]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":2,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"codigoCnes","in":"query","required":false,"description":"Código do estabelecimento no CNES, sete dígitos.","schema":{"type":"string","minLength":1,"maxLength":10,"description":"Código do estabelecimento no CNES, sete dígitos."}},{"name":"cnpj","in":"query","required":false,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.","schema":{"type":"string","minLength":11,"maxLength":18,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."}},{"name":"municipio","in":"query","required":false,"description":"Código do município no IBGE, 6 ou 7 dígitos (ex. `420240` = Blumenau).","schema":{"type":"string","minLength":6,"maxLength":7,"description":"Código do município no IBGE, 6 ou 7 dígitos (ex. `420240` = Blumenau)."}},{"name":"uf","in":"query","required":false,"description":"Sigla da unidade federativa, duas letras (ex. `SC`).","schema":{"type":"string","minLength":2,"maxLength":2,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EstabelecimentoCnes"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"codigoCNES":"2583251","cnpj":"81007866000126","razaoSocial":"LABORATORIO DE ANALISES CLINICAS EXEMPLO LTDA","nomeFantasia":"LABORATORIO EXEMPLO","tipoUnidade":{"codigo":39,"descricao":"Unidade de Serviço de Apoio de Diagnose e Terapia"},"cidade":"Blumenau","codigoMunicipioIBGE":"420240","uf":"SC"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/demonstrativos":{"get":{"tags":["Demonstrativos"],"summary":"O retorno da operadora como acervo — análise de conta e pagamento","description":"O que `GET /execucoes/{id}/retornos` não responde: ele é indexado pela execução que buscou o arquivo, e documento que entrou por importação manual não tem execução nenhuma. Aqui o recorte é o do negócio.\n\n`competencia` é a data de NEGÓCIO — data do protocolo na análise, data do crédito no pagamento. Não é `dataEmissao`: o portal renderiza o documento no download, e medido na base inteira o mês da emissão difere do mês do protocolo em 96,1% dos documentos de análise e do mês do crédito em 89,5% dos de pagamento.\n\nA lista traz o cabeçalho; protocolos, guias e glosas vêm no detalhe.","operationId":"demonstrativos_listar","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"tipo","in":"query","required":false,"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. São duas respostas diferentes, em meses geralmente diferentes.","schema":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. São duas respostas diferentes, em meses geralmente diferentes."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"string","enum":["sem-data"]}],"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"numeroProtocolo","in":"query","required":false,"description":"O número do protocolo na operadora.","schema":{"type":"string","minLength":1,"maxLength":60,"description":"O número do protocolo na operadora."}},{"name":"completude","in":"query","required":false,"description":"O quanto do documento a operadora mandou: `FULL` (a conta toda), `ACCEPTED_ONLY` (só o aceito) ou `GLOSA_ONLY` (só o recusado). Somar valores de documentos de completudes diferentes dá número errado.","schema":{"type":"string","enum":["FULL","ACCEPTED_ONLY","GLOSA_ONLY"],"description":"O quanto do documento a operadora mandou: `FULL` (a conta toda), `ACCEPTED_ONLY` (só o aceito) ou `GLOSA_ONLY` (só o recusado). Somar valores de documentos de completudes diferentes dá número errado."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Demonstrativo"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001dem","tipo":"PAGAMENTO","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroDemonstrativo":"202607150001","competencia":"2026-07","creditoEm":"2026-07-15","emitidoEm":"2026-08-02","completude":"FULL","profundidade":"C","versaoTiss":"4.01.00","valores":{"informado":"3.65","processado":"3.65","liberado":"3.56","glosa":"0.09"},"protocolos":1,"guias":42,"importadoEm":"2026-08-02T11:04:19.000Z"}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/demonstrativos/{id}":{"get":{"tags":["Demonstrativos"],"summary":"O documento inteiro: protocolos, guias, glosas e liquidação","description":"A glosa devolvida aqui é a mesma de `GET /v1/glosas/{id}` — mesmo mapper, não uma segunda leitura.\n\nNão existe campo `liquido` no topo: `valorLiquido` do documento é o liberado dele menos o imposto do DIA inteiro, e a operadora repete o bloco em cada demonstrativo daquela data (medido: liberado 587,97, débitos do dia 6.313,66, campo = −5.725,69). O líquido sai em `liquidacao[]`, por data de crédito.","operationId":"demonstrativos_detalhe","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DemonstrativoDetalhado"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001dem","tipo":"PAGAMENTO","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"numeroDemonstrativo":"202607150001","competencia":"2026-07","creditoEm":"2026-07-15","emitidoEm":"2026-08-02","completude":"FULL","profundidade":"C","versaoTiss":"4.01.00","valores":{"informado":"3.65","processado":"3.65","liberado":"3.56","glosa":"0.09"},"protocolos":[{"numeroProtocolo":"4530775","numeroLotePrestador":"2026070112","dataProtocolo":"2026-07-10","situacao":null,"valores":{"informado":"3.65","processado":"3.65","liberado":"3.56","glosa":"0.09"},"glosas":[],"guias":[{"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","carteira":null,"beneficiario":null,"senha":"18700001","situacao":null,"atendimentoDe":null,"atendimentoAte":null,"fonteOrdem":null,"valores":{"informado":null,"processado":"3.65","liberado":"3.56","glosa":"0.09"},"glosas":[]}],"totalDeGuias":42,"temMaisGuias":false}],"guias":42,"importadoEm":"2026-08-02T11:04:19.000Z","liquidacao":[{"creditoEm":"2026-07-15","forma":"CREDITO_EM_CONTA","banco":"756","agencia":"0101","conta":"000000-0","valores":{"informado":"3.65","processado":"3.65","liberado":"3.56","glosa":"0.09"},"debitos":[{"tipo":"IMPOSTO","subtipo":"ISS","valor":"0.11"}],"creditos":[],"totalDebitos":"0.11","totalCreditos":"0.00","liquido":"3.45"}],"avisos":[],"fontes":[{"origem":"MENSAGEM_TISS","papel":"FULL","ordem":0,"arquivo":{"id":"cmf3k2x9a0001tis","nome":"demonstrativoRetorno-202607150001.xml","extensao":"xml","formato":"TISS_XML","tamanhoBytes":null,"importadoEm":"2026-08-02T11:04:19.000Z"}}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/demonstrativos/{id}/arquivos/{arquivoId}":{"get":{"tags":["Demonstrativos"],"summary":"O documento original, em bytes","description":"Prova: é o que se anexa ao recurso, o que o contador arquiva e o que resolve a discussão quando o parser e a operadora discordam. Responde o arquivo com o `Content-Type` dele, FORA do envelope `{ data }`; erro continua no formato padrão.\n\n`arquivoId` vem de `fontes[].arquivo.id` do detalhe, e serve as duas origens: o arquivo do inbox e a mensagem TISS. Não consome cota — o documento está guardado, não se busca na operadora.","operationId":"demonstrativos_arquivo","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"arquivoId","in":"path","required":true,"description":"O arquivo, pelo identificador do Miydas.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/guias":{"get":{"tags":["Guias"],"summary":"A guia pelas três camadas: envio, análise e pagamento","description":"Cinco valores por linha — cobrado, processado, liberado, glosa e pago. `liberado` é o julgamento da análise; `pago` é o que o demonstrativo de pagamento declara. São duas respostas da operadora, com meses de distância, e é o pago que faz o relógio do prazo de recurso andar.\n\nAusência é `null`, nunca \"0.00\". A presença de cada camada é MEDIDA nas tabelas de retorno, não inferida da coluna: o motor grava zero e não nulo, então a coluna não distingue \"não mandou\" de \"mandou zero\".\n\n`camada=SEM_ENVIO` e `camada=SEM_RETORNO` listam os buracos. Sem filtro por situação de conciliação, de propósito: isto é arquivo consultável, não fila de trabalho.","operationId":"guias_listar","security":[{"chaveApi":["guia:ler"]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.","schema":{"type":"string","minLength":1,"maxLength":120,"description":"Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"string","enum":["sem-data"]}],"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"numeroLote","in":"query","required":false,"description":"O número do lote, como ele foi transmitido à operadora.","schema":{"type":"string","minLength":1,"maxLength":60,"description":"O número do lote, como ele foi transmitido à operadora."}},{"name":"camada","in":"query","required":false,"description":"O BURACO, não o estado. `SEM_ENVIO`: voltou retorno de guia que nunca saiu daqui. `SEM_RETORNO`: a guia saiu e a operadora nunca respondeu — é faturamento parado sem ninguém ter sido avisado.","schema":{"type":"string","enum":["SEM_ENVIO","SEM_RETORNO"],"description":"O BURACO, não o estado. `SEM_ENVIO`: voltou retorno de guia que nunca saiu daqui. `SEM_RETORNO`: a guia saiu e a operadora nunca respondeu — é faturamento parado sem ninguém ter sido avisado."}},{"name":"comGlosa","in":"query","required":false,"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas.","schema":{"type":"string","enum":["true","false"],"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Guia"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001gui","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","numeroLote":"2026070112","numeroProtocolo":"4530775","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"beneficiario":"PACIENTE EXEMPLO","carteira":"00000000000000000","dataExecucao":"2026-07-02","creditoEm":"2026-07-15","camadas":{"envio":false,"analise":true,"pagamento":true,"completudeAnalise":"FULL"},"cobrado":"3.65","cobradoDaOperadora":true,"processado":"3.65","liberado":"3.56","glosa":"0.09","pago":"3.56","diferenca":"0.09","divergenciaPagamento":"0.00","situacaoPagamento":{"codigo":"PAGO_INTEGRAL","descricao":"Pago integralmente"},"pagamentos":1,"temGlosaDeclarada":true,"motivos":[{"codigo":"1705","descricao":"VALOR APRESENTADO A MAIOR","origem":"ITEM"}],"itens":{"envio":null,"retorno":19}}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/guias/{id}":{"get":{"tags":["Guias"],"summary":"Uma guia, com as três camadas e os cinco valores","operationId":"guias_detalhe","security":[{"chaveApi":["guia:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Guia"}},"required":["data"]},"example":{"data":{"id":"cmf3k2x9a0001gui","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","numeroLote":"2026070112","numeroProtocolo":"4530775","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"beneficiario":"PACIENTE EXEMPLO","carteira":"00000000000000000","dataExecucao":"2026-07-02","creditoEm":"2026-07-15","camadas":{"envio":false,"analise":true,"pagamento":true,"completudeAnalise":"FULL"},"cobrado":"3.65","cobradoDaOperadora":true,"processado":"3.65","liberado":"3.56","glosa":"0.09","pago":"3.56","diferenca":"0.09","divergenciaPagamento":"0.00","situacaoPagamento":{"codigo":"PAGO_INTEGRAL","descricao":"Pago integralmente"},"pagamentos":1,"temGlosaDeclarada":true,"motivos":[{"codigo":"1705","descricao":"VALOR APRESENTADO A MAIOR","origem":"ITEM"}],"itens":{"envio":null,"retorno":19}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/guias/{id}/procedencia":{"get":{"tags":["Guias"],"summary":"De onde veio cada número desta guia","description":"O arquivo de envio e os documentos de retorno, com o que cada um sabia (completude e profundidade). É o que separa \"a operadora não glosou\" de \"o arquivo que declara glosa não chegou\".\n\n`envio` é nulo em quase toda guia, e não é defeito: o portal devolve o JULGAMENTO da operadora, ele não guarda o arquivo que o prestador mandou. Medido, 14 das 40.760 guias têm camada de envio.","operationId":"guias_procedencia","security":[{"chaveApi":["guia:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProcedenciaDaGuia"}},"required":["data"]},"example":{"data":{"guia":{"id":"cmf3k2x9a0001gui","numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","numeroLote":"2026070112","numeroProtocolo":"4530775","operadora":"Unimed Blumenau","registroANS":"334561","beneficiario":"PACIENTE EXEMPLO","carteirinha":"00000000000000000","dataExecucao":"2026-07-02T00:00:00.000Z","statusConciliacao":1,"conciliadaEm":"2026-08-02T11:05:00.000Z","justificativa":null,"observacao":null},"envio":null,"analise":[{"protocolo":"4530775","demonstrativo":"202607100001","emitidoEm":"2026-07-10T00:00:00.000Z","informado":"3.65","processado":"3.65","liberado":"3.56","glosa":"0.09","completude":"FULL","profundidade":"A","fontes":[{"papel":"FULL","arquivo":{"id":"cmf3k2x9a0001inb","nome":"dem_4530775.xml","extensao":"xml","formato":"TISS_XML","importadoEm":"2026-07-11T08:12:44.000Z"}}]}],"pagamento":[]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/demonstrativos/{id}/itens":{"get":{"tags":["Demonstrativos"],"summary":"O que a operadora declarou item a item, com o motivo da recusa junto","description":"O nível mais fundo do retorno, e o maior volume do sistema: 310.760 linhas. A glosa pende de ITEM em 56.709 das 56.971 medidas — recorrer da guia inteira quando um procedimento foi recusado é pedir de volta o que já foi pago, e o recurso TISS é item a item.\n\n`motivos[]` vem na própria linha, incluindo a nota do auditor quando a operadora a mandou. Buscar em `/v1/glosas` depois, item a item, seria N+1 do lado de quem integra.\n\nSó documento de ANÁLISE tem itens: o de pagamento desce até a guia em 2.929 de 2.929 documentos, e pedir itens dele responde 404 dizendo isso.","operationId":"demonstrativos_itens","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"codigo","in":"query","required":false,"description":"O código do procedimento ou da despesa na linha, na tabela que o documento declara.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"O código do procedimento ou da despesa na linha, na tabela que o documento declara."}},{"name":"tipo","in":"query","required":false,"description":"`PROCEDIMENTO` ou `DESPESA` (material, medicamento, taxa). A despesa costuma ser onde a glosa se esconde.","schema":{"type":"string","enum":["PROCEDIMENTO","DESPESA"],"description":"`PROCEDIMENTO` ou `DESPESA` (material, medicamento, taxa). A despesa costuma ser onde a glosa se esconde."}},{"name":"comGlosa","in":"query","required":false,"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas.","schema":{"type":"string","enum":["true","false"],"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":100,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}},{"name":"numeroGuiaPrestador","in":"query","required":false,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemDoDemonstrativo"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001ite","guia":{"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","beneficiario":"PACIENTE EXEMPLO","carteira":"00000000000000000","protocolo":"PROTO-18700001"},"sequencial":3,"tipo":"PROCEDIMENTO","procedimento":{"tabela":"22","codigo":"40301591","descricao":"COLESTEROL LDL","termoOficial":"Colesterol LDL, dosagem"},"despesa":null,"grauParticipacao":null,"unidadeMedida":null,"realizadoEm":"2026-07-02","quantidade":"1","valorUnitario":"8.94","valores":{"informado":"8.94","total":"8.94","processado":"8.94","liberado":"0.00","glosa":"8.94"},"fonteOrdem":0,"motivos":[{"codigo":"1705","significado":"VALOR APRESENTADO A MAIOR","tipo":"TABELA_ANS","codigoOperadora":null,"categoria":null,"notaAuditor":null,"descricao":"Item não liberado na análise","valor":"8.94"}]}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/guias/{id}/itens":{"get":{"tags":["Guias"],"summary":"O item pelas três camadas, com o veredito da conciliação","description":"O que saiu daqui contra o que voltou, item a item: a chave que casou, a diferença, o split (a operadora liberou parte da quantidade) e a decisão do faturista.\n\n`semPar=ENVIO` acha o item que a operadora julgou e que não saiu daqui; `semPar=RETORNO`, o que saiu e ela não mencionou. `comDivergencia=true` traz só o que não bate — e diferença ausente é diferente de zero: item nunca comparado não entra nesse filtro.","operationId":"guias_itens","security":[{"chaveApi":["guia:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}},{"name":"codigo","in":"query","required":false,"description":"O código do procedimento ou da despesa na linha, na tabela que o documento declara.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"O código do procedimento ou da despesa na linha, na tabela que o documento declara."}},{"name":"tipo","in":"query","required":false,"description":"`PROCEDIMENTO` ou `DESPESA` (material, medicamento, taxa). A despesa costuma ser onde a glosa se esconde.","schema":{"type":"string","enum":["PROCEDIMENTO","DESPESA"],"description":"`PROCEDIMENTO` ou `DESPESA` (material, medicamento, taxa). A despesa costuma ser onde a glosa se esconde."}},{"name":"comGlosa","in":"query","required":false,"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas.","schema":{"type":"string","enum":["true","false"],"description":"Só as linhas com glosa (`true`) ou só as sem (`false`). Omitido, traz as duas."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":200,"default":100,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}},{"name":"comDivergencia","in":"query","required":false,"description":"Só os itens em que o liberado não bate com o cobrado. É o recorte de quem trabalha a fila de conferência.","schema":{"type":"string","enum":["true","false"],"description":"Só os itens em que o liberado não bate com o cobrado. É o recorte de quem trabalha a fila de conferência."}},{"name":"semPar","in":"query","required":false,"description":"O que não casou dos dois lados. `ENVIO`: a operadora respondeu sobre um item que não saiu daqui. `RETORNO`: o item saiu e não voltou resposta nenhuma sobre ele.","schema":{"type":"string","enum":["ENVIO","RETORNO"],"description":"O que não casou dos dois lados. `ENVIO`: a operadora respondeu sobre um item que não saiu daqui. `RETORNO`: o item saiu e não voltou resposta nenhuma sobre ele."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemConciliado"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"id":"cmf3k2x9a0001icl","chave":"334561|000123|40301591","tipoDeMatch":"EXATO","envio":null,"analise":{"sequencial":3,"tabela":"22","codigo":"40301591","descricao":"COLESTEROL LDL","quantidade":"1","informado":"8.94","processado":"8.94","liberado":"0.00","realizadoEm":"2026-07-02"},"pagamento":{"processado":"226.29","liberado":"214.80","glosa":"11.26"},"diferenca":"8.94","split":{"detectado":false,"detalhe":null},"decisao":{"valor":"EM_RECURSO","em":"2026-08-05T13:20:00.000Z","nota":"Valor conforme tabela vigente"}}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/retornos-sem-vinculo":{"get":{"tags":["Demonstrativos"],"summary":"O julgamento da operadora que não casou com guia nenhuma","description":"Medido: 1.809 linhas de análise e 2.857 de pagamento, R$ 65.244,35 em disputa. Não é o mesmo que guia sem envio — essa o motor criou a partir do retorno e ela aparece normalmente em `/v1/guias`. Aqui está a linha que não virou guia nenhuma.\n\nÉ o achado mais caro de descobrir tarde: um pagamento que não casa pode ser dinheiro recebido e não reconhecido; uma glosa que não casa é prazo de recurso correndo sobre uma guia que ninguém está olhando.","operationId":"retornos_sem_vinculo_listar","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"tipo","in":"query","required":false,"description":"De que tipo de documento veio o retorno órfão: `ANALISE` ou `PAGAMENTO`.","schema":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"De que tipo de documento veio o retorno órfão: `ANALISE` ou `PAGAMENTO`."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"string","enum":["sem-data"]}],"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},{"name":"motivo","in":"query","required":false,"description":"Por que o retorno não achou guia. `GUIA_DESCONHECIDA`: o número não existe aqui. `OPERADORA_DIVERGENTE`: existe, mas em outra operadora. `SEM_NUMERO_DE_GUIA`: o documento veio sem número para casar.","schema":{"type":"string","enum":["GUIA_DESCONHECIDA","OPERADORA_DIVERGENTE","SEM_NUMERO_DE_GUIA"],"description":"Por que o retorno não achou guia. `GUIA_DESCONHECIDA`: o número não existe aqui. `OPERADORA_DIVERGENTE`: existe, mas em outra operadora. `SEM_NUMERO_DE_GUIA`: o documento veio sem número para casar."}},{"name":"valorMinimo","in":"query","required":false,"description":"Traz só registros com valor igual ou acima deste, em reais.","schema":{"type":"number","minimum":0,"description":"Traz só registros com valor igual ou acima deste, em reais."}},{"name":"limite","in":"query","required":false,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo."}},{"name":"deslocamento","in":"query","required":false,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais.","schema":{"type":"integer","minimum":0,"default":0,"description":"Quantos registros pular, para a página seguinte. Use com `paginacao.total` da resposta; `paginacao.temMais` diz se vale pedir mais."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RetornoSemVinculo"}},"paginacao":{"type":"object","properties":{"total":{"type":"integer"},"limite":{"type":"integer"},"deslocamento":{"type":"integer"},"temMais":{"type":"boolean"}}}},"required":["data"]},"example":{"data":[{"tipo":"PAGAMENTO","motivo":"GUIA_DESCONHECIDA","operadora":{"registroANS":"334561","nome":"Unimed Blumenau"},"demonstrativoId":"cmf3k2x9a0001dem","protocolo":"4530775","competencia":"2026-07","numeroGuiaPrestador":"000987","numeroGuiaOperadora":null,"beneficiario":null,"carteira":null,"valores":{"informado":null,"processado":"12.40","liberado":"12.40","glosa":null}}],"paginacao":{"total":1,"limite":20,"deslocamento":0,"temMais":false}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/retornos-sem-vinculo/resumo":{"get":{"tags":["Demonstrativos"],"summary":"Quanto está solto, e onde","operationId":"retornos_sem_vinculo_resumo","security":[{"chaveApi":["retorno:ler"]}],"parameters":[{"name":"tipo","in":"query","required":false,"description":"De que tipo de documento veio o retorno órfão: `ANALISE` ou `PAGAMENTO`.","schema":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"De que tipo de documento veio o retorno órfão: `ANALISE` ou `PAGAMENTO`."}},{"name":"registroANS","in":"query","required":false,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.","schema":{"type":"string","minLength":1,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},{"name":"competencia","in":"query","required":false,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"string","enum":["sem-data"]}],"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ResumoDeRetornosSemVinculo"}},"required":["data"]},"example":{"data":{"total":4666,"montante":"65244.35","porMotivo":[{"motivo":"GUIA_DESCONHECIDA","linhas":4666,"montante":"65244.35"}],"porOperadora":[{"registroANS":"334561","nome":"Unimed Blumenau","linhas":2757,"montante":"32168.87"}],"porCompetencia":[{"competencia":"2026-07","linhas":612,"montante":"21880.33"}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"}}}},"/v1/lotes/{id}/mensagem":{"get":{"tags":["Faturamento"],"summary":"A mensagem TISS que foi transmitida, em bytes","description":"O recurso `Lote` não carrega o XML de propósito: o que se precisa dele é em que pé está, qual o protocolo e o que fazer. Mas a mensagem é prova — é o que se confere quando a operadora diz ter recebido outra coisa.\n\nSai em ISO-8859-1, que é como foi gerada e como a operadora a recebeu: reconverter entregaria bytes diferentes dos transmitidos. Lote em formação, que nunca gerou mensagem, responde 404 — e não um XML vazio, que pareceria lote transmitido sem conteúdo.","operationId":"lotes_mensagem","security":[{"chaveApi":["lote:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"`RECURSO_NAO_ENCONTRADO` — O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"RECURSO_NAO_ENCONTRADO","message":"O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.","details":null}}}}}}},"/v1/utilizacoes":{"post":{"tags":["Operações"],"summary":"Consulta o histórico de atendimentos do beneficiário na operadora","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"utilizacoes_criar","x-operacao":"FETCH_UTILIZATION","security":[{"chaveApi":["utilizacao:ler"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"carteira":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário."},"de":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Início do período. Sem ele o portal assume os últimos 30 dias."},"ate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra."},"codigoProcedimento":{"type":"string","maxLength":20,"description":"Restringe a um procedimento (código TUSS)."},"tipoGuia":{"type":"string","maxLength":2,"description":"dm_tipoGuia — restringe a um tipo de guia."}},"required":["registroANS","carteira"],"additionalProperties":false},"example":{"registroANS":"334561","carteira":"00000000000000000","de":"2026-07-01","ate":"2026-09-30"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/guias/cancelamentos":{"post":{"tags":["Operações"],"summary":"Cancela guia autorizada ou lote enviado","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"guiasCancelamentos_criar","x-operacao":"CANCEL_GUIDE","security":[{"chaveApi":["guia:cancelar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"numeroGuia":{"type":"string","maxLength":20,"description":"Número da guia a cancelar, como a OPERADORA o atribuiu. Para cancelar lote, use `numeroLote`."},"numeroLote":{"type":"string","maxLength":20,"description":"O número do lote, como ele foi transmitido à operadora."},"tipoGuia":{"type":"string","maxLength":2,"description":"dm_tipoGuia — 1 = consulta/SP-SADT · 2 = internação · 3 = recurso"}},"required":["registroANS"],"additionalProperties":false},"example":{"registroANS":"334561","numeroGuia":"000123","tipoGuia":"1"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/lotes/consultas":{"post":{"tags":["Operações"],"summary":"Consulta a situação de um protocolo de lote","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"lotesConsultas_criar","x-operacao":"CHECK_STATUS","security":[{"chaveApi":["lote:ler"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"protocolo":{"type":"string","minLength":1,"maxLength":20,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."}},"required":["registroANS","protocolo"],"additionalProperties":false},"example":{"registroANS":"334561","protocolo":"PROTO-18700001"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/retornos/sincronizacoes":{"post":{"tags":["Operações"],"summary":"Busca demonstrativos e retornos de um período","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"retornosSincronizacoes_criar","x-operacao":"FETCH_RETURNS","security":[{"chaveApi":["retorno:ler"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"de":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Início do período, `AAAA-MM-DD`. O intervalo é fechado: o dia informado entra."},"ate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Fim do período, `AAAA-MM-DD`. O intervalo é fechado: o dia inteiro entra."},"categorias":{"type":"array","items":{"type":"string","maxLength":40},"maxItems":20,"description":"Restringe as categorias de documento buscadas no portal."}},"required":["registroANS","de","ate"],"additionalProperties":false},"example":{"registroANS":"334561","de":"2026-09-01","ate":"2026-09-30"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/recursos-glosa":{"post":{"tags":["Operações"],"summary":"Envia recurso contra glosas","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"recursosGlosa_criar","x-operacao":"SUBMIT_APPEAL","security":[{"chaveApi":["recurso:enviar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"numeroGuiaRecurso":{"type":"string","minLength":1,"maxLength":20,"description":"Número que identifica ESTE recurso no seu sistema; vai no XML e é por ele que a operadora o referencia."},"nomeOperadora":{"type":"string","minLength":1,"maxLength":70,"description":"Razão social da operadora como ela aparece no demonstrativo — o XSD do recurso a exige por extenso."},"numeroLote":{"type":"string","minLength":1,"maxLength":20,"description":"O número do lote, como ele foi transmitido à operadora."},"numeroProtocolo":{"type":"string","minLength":1,"maxLength":20,"description":"O número do protocolo na operadora."},"valorTotal":{"type":"string","minLength":1,"maxLength":20,"description":"Soma em reais, decimal em string com duas casas."},"tipo":{"type":"string","enum":["protocolo","guia"],"description":"Recurso do protocolo inteiro, com uma justificativa só, ou guia por guia e item a item."},"recursoProtocolo":{"type":"object","properties":{"codigoGlosa":{"type":"string","maxLength":10,"description":"Código da glosa recebida, da Tabela 38 da ANS — o que está sendo contestado."},"justificativa":{"type":"string","minLength":1,"maxLength":2000,"description":"A justificativa registrada, em texto livre."}},"required":["codigoGlosa","justificativa"],"additionalProperties":false,"description":"Recurso do protocolo inteiro, com uma justificativa só. Use com `tipo: protocolo`."},"recursoGuias":{"type":"array","items":{"type":"object","properties":{"numeroGuiaPrestador":{"type":"string","maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","maxLength":20,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"senha":{"type":"string","maxLength":20,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"itens":{"type":"array","items":{"type":"object","properties":{"sequencial":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"codigoGlosa":{"type":"string","maxLength":10,"description":"Código da glosa deste item, da Tabela 38 da ANS."},"justificativa":{"type":"string","minLength":1,"maxLength":2000,"description":"A justificativa registrada, em texto livre."},"valorRecursado":{"type":"string","maxLength":20,"description":"Quanto se recorre neste item, em reais. Omitido, recorre-se do valor glosado inteiro."}},"required":["codigoGlosa","justificativa"],"additionalProperties":false},"minItems":1,"description":"Os exames realizados desta remessa. Até 500 por pedido."}},"required":["numeroGuiaPrestador","itens"],"additionalProperties":false},"description":"Recurso guia por guia, item a item. Use com `tipo: guia`; `numeroGuiaPrestador` é o número do PRESTADOR."}},"required":["registroANS","numeroGuiaRecurso","nomeOperadora","numeroLote","numeroProtocolo","valorTotal","tipo"],"additionalProperties":false},"example":{"registroANS":"334561","numeroGuiaRecurso":"REC-000123","nomeOperadora":"Unimed Blumenau","numeroLote":"202609","numeroProtocolo":"PROTO-18700001","valorTotal":"200.00","tipo":"guia","recursoGuias":[{"numeroGuiaPrestador":"000123","numeroGuiaOperadora":"18700001","itens":[{"sequencial":1,"codigoGlosa":"1707","justificativa":"Procedimento autorizado sob a senha 18700001, válida na data de execução. Anexo o comprovante de autorização.","valorRecursado":"200.00"}]}]}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/recursos-glosa/consultas":{"post":{"tags":["Operações"],"summary":"Consulta a situação de um recurso","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"recursosGlosaConsultas_criar","x-operacao":"CHECK_APPEAL_STATUS","security":[{"chaveApi":["recurso:ler"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"protocolo":{"type":"string","minLength":1,"maxLength":20,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."}},"required":["registroANS","protocolo"],"additionalProperties":false},"example":{"registroANS":"334561","protocolo":"REC-20260930-001"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/anexos":{"post":{"tags":["Operações"],"summary":"Envia lote de anexos (situação inicial, radio, quimio, OPME)","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"anexos_criar","x-operacao":"SUBMIT_ATTACHMENT","security":[{"chaveApi":["anexo:enviar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"numeroLote":{"type":"string","minLength":1,"maxLength":12,"description":"O número do lote, como ele foi transmitido à operadora."},"tipoAnexo":{"type":"string","enum":["situacaoInicial","radio","quimio","opme"],"description":"Qual anexo TISS está sendo enviado: o bloco de `anexo` muda de formato conforme este valor."},"anexo":{"type":"object","additionalProperties":{},"description":"Bloco TISS já montado, correspondente ao tipoAnexo."}},"required":["registroANS","numeroLote","tipoAnexo","anexo"],"additionalProperties":false},"example":{"registroANS":"334561","numeroLote":"202609","tipoAnexo":"situacaoInicial","anexo":{"observacao":"Bloco TISS do anexo, no formato do tipoAnexo escolhido."}}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/documentos":{"post":{"tags":["Operações"],"summary":"Envia laudo, pedido ou comprovante","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"documentos_criar","x-operacao":"SUBMIT_DOCUMENT","security":[{"chaveApi":["documento:enviar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"documentoBase64":{"type":"string","minLength":1,"maxLength":6000000,"description":"Conteúdo do arquivo em base64. Teto de 6 MB."},"numeroDocumento":{"type":"string","minLength":1,"maxLength":20,"description":"Número que identifica o documento no seu sistema — laudo, pedido ou comprovante."},"tipoDocumento":{"type":"string","minLength":1,"maxLength":2,"description":"dm_tipoDocumento (Tabela 81) — 1 = comprovante elegibilidade · 2 = laudo…"},"formato":{"type":"string","minLength":1,"maxLength":10,"description":"dm_formatoDocumento — pdf, jpg…"},"naturezaGuia":{"type":"string","minLength":1,"maxLength":2,"description":"dm_tipoGuia da guia a que o documento se refere"},"numeroLote":{"type":"string","maxLength":12,"description":"O número do lote, como ele foi transmitido à operadora."},"numeroProtocolo":{"type":"string","maxLength":12,"description":"O número do protocolo na operadora."},"numeroGuiaPrestador":{"type":"string","maxLength":20,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","maxLength":20,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"sequencialItem":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Item da guia a que o documento se refere, quando ele não é da guia inteira."},"observacao":{"type":"string","maxLength":500,"description":"Observação registrada, em texto livre."}},"required":["registroANS","documentoBase64","numeroDocumento","tipoDocumento","formato","naturezaGuia"],"additionalProperties":false},"example":{"registroANS":"334561","documentoBase64":"JVBERi0xLjQKJeLjz9MK…","numeroDocumento":"DOC-000123","tipoDocumento":"2","formato":"pdf","naturezaGuia":"1","numeroGuiaPrestador":"000123","observacao":"Laudo do exame referente à guia 000123."}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/comunicacoes-beneficiario":{"post":{"tags":["Operações"],"summary":"Comunica internação ou alta de beneficiário","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"comunicacoesBeneficiario_criar","x-operacao":"COMMUNICATE_BENEFICIARY","security":[{"chaveApi":["comunicacao:enviar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"carteira":{"type":"string","minLength":1,"maxLength":30,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"tipoEvento":{"type":"string","enum":["1","2"],"description":"dm_tipoEvento — 1 = internação · 2 = alta"},"dataEvento":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data da internação ou da alta que está sendo comunicada. Omitida, vale hoje."},"tipoInternacao":{"type":"string","maxLength":2,"description":"dm_tipoInternacao — obrigatório quando tipoEvento = 1"},"motivoEncerramento":{"type":"string","maxLength":2,"description":"dm_motivoSaida — obrigatório quando tipoEvento = 2"},"recemNascido":{"type":"boolean","description":"O atendimento é do recém-nascido na carteirinha da mãe."}},"required":["registroANS","carteira","tipoEvento"],"additionalProperties":false},"example":{"registroANS":"334561","carteira":"00000000000000000","tipoEvento":"1","dataEvento":"2026-09-27","tipoInternacao":"1"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/credenciais/verificacoes":{"post":{"tags":["Operações"],"summary":"Testa as credenciais de uma conexão","description":"Assíncrona: devolve 202 e o resultado sai depois.","operationId":"credenciaisVerificacoes_criar","x-operacao":"VALIDATE_CREDS","security":[{"chaveApi":["credencial:verificar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial."},"callbackUrl":{"not":{},"description":"NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável."},"conexaoId":{"type":"string","minLength":1,"description":"Qual conexão testar. Sem ele, cai na preferência de canal — o que dá resposta errada quando a operadora tem RPA e webservice configurados."}},"required":["registroANS"],"additionalProperties":false},"example":{"registroANS":"334561"}}}},"responses":{"202":{"description":"Aceita e enfileirada","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Aceita"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Operadora não cadastrada para esta empresa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERADORA_NAO_ATENDIDA","message":"Operadora 334561 não cadastrada para esta empresa"}}}},"409":{"description":"Sem integração configurada, ou operação não coberta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"OPERACAO_NAO_COBERTA","message":"Operação CHECK_ELIGIBILITY não disponível para a operadora 334561","details":{"disponiveis":["FETCH_RETURNS","SUBMIT_BATCH"]}}}}},"429":{"description":"Fila cheia para esta operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"QUEUE_FULL","message":"Fila cheia para esta operadora (50 execuções pendentes)"}}}}}}},"/v1/operadoras/disponiveis":{"get":{"tags":["Conexões"],"operationId":"operadorasDisponiveis_listar","summary":"Operadoras que a clínica pode habilitar","security":[{"chaveApi":["convenio:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OperadoraDisponivel"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/convenios":{"get":{"tags":["Conexões"],"operationId":"convenios_listar","summary":"Convênios já habilitados","security":[{"chaveApi":["convenio:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Convenio"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}},"post":{"tags":["Conexões"],"operationId":"convenios_criar","summary":"Habilita uma operadora (não com chave de teste: é cadastro de produção)","security":[{"chaveApi":["convenio:gerenciar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ansOperatorId":{"type":"string","minLength":1,"description":"A operadora no cadastro público da ANS, pelo identificador do Miydas."},"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"numeroContrato":{"type":"string","maxLength":50},"codigoPrestador":{"type":"string","maxLength":50,"description":"O código desta clínica na operadora, como ela o cadastrou. Sem ele, boa parte dos portais recusa a consulta."},"cnesPrestador":{"type":"string","pattern":"^\\d{7}$"}},"additionalProperties":false},"example":{"registroANS":"334561"}}}},"responses":{"201":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConvenioHabilitado"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conectores":{"get":{"tags":["Conexões"],"operationId":"conectores_listar","summary":"Conectores e o que cada um exige","security":[{"chaveApi":["operadora:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conector"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conectores/matriz":{"get":{"tags":["Conexões"],"operationId":"conectoresMatriz_listar","summary":"Matriz operadora × operação: o que cada um faz, não faz e por quê","security":[{"chaveApi":["operadora:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatrizConectores"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conectores/solicitacoes":{"post":{"tags":["Conexões"],"operationId":"conectoresSolicitacoes_criar","summary":"Pede conector para uma operadora ainda não automatizada (não com chave de teste: entra na fila de produção)","security":[{"chaveApi":["conexao:gerenciar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"registroANS":{"type":"string","minLength":4,"maxLength":20,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"motivo":{"type":"string","maxLength":1000},"pedidoPor":{"type":"string","maxLength":120},"guiasEstimadasMes":{"type":"integer","minimum":0,"maximum":1000000}},"required":["registroANS"],"additionalProperties":false},"example":{"registroANS":"368253","motivo":"Terceira operadora em volume do laboratório; hoje o faturamento dela é digitado à mão no portal.","guiasEstimadasMes":400}}}},"responses":{"201":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SolicitacaoDeConector"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conexoes":{"get":{"tags":["Conexões"],"operationId":"conexoes_listar","summary":"Conexões configuradas pela clínica, do ambiente da chave (teste: homologação; live: produção)","security":[{"chaveApi":["conexao:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conexao"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}},"post":{"tags":["Conexões"],"operationId":"conexoes_criar","summary":"Cria conexão com uma operadora. Com chave de teste, nasce em homologação — só webservice, conector e endereço do catálogo","security":[{"chaveApi":["conexao:gerenciar"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"healthPlanId":{"type":"string","minLength":1},"integrationMethod":{"type":"string","enum":["WEBSERVICE","RPA","EMAIL","MANUAL"]},"connectorId":{"type":"string","maxLength":100},"portalUrl":{"type":"string","format":"uri","description":"O endereço do portal da operadora usado por esta conexão."},"webserviceUrl":{"type":"string","format":"uri","description":"O endereço do webservice da operadora usado por esta conexão."},"credentialNotes":{"type":"string","maxLength":500},"autoSyncEnabled":{"type":"boolean","default":false},"fetchReturnsCron":{"type":"string","maxLength":100},"checkStatusCron":{"type":"string","maxLength":100},"connectorConfig":{"type":"object","additionalProperties":{}}},"required":["healthPlanId","integrationMethod"],"additionalProperties":false},"example":{"healthPlanId":"hp_cmf3k2x9a0001","integrationMethod":"WEBSERVICE","connectorId":"unimed-blumenau-soap"}}}},"responses":{"201":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Conexao"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conexoes/{id}":{"get":{"tags":["Conexões"],"operationId":"conexoesPorId_listar","summary":"Uma conexão e sua saúde","security":[{"chaveApi":["conexao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Conexao"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}},"patch":{"tags":["Conexões"],"operationId":"conexoesPorId_atualizar","summary":"Liga, desliga, troca endereço, conector e agenda","security":[{"chaveApi":["conexao:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ativa":{"type":"boolean","description":"A assinatura está recebendo eventos."},"sincronizacaoAutomatica":{"type":"boolean","description":"O Miydas busca sozinho nesta conexão, na agenda abaixo. `false` = só roda quando alguém pede."},"portalUrl":{"type":"string","format":"uri","description":"O endereço do portal da operadora usado por esta conexão."},"webserviceUrl":{"type":"string","format":"uri","description":"O endereço do webservice da operadora usado por esta conexão."},"conectorId":{"type":"string","minLength":1,"maxLength":100,"description":"Qual conector atende esta conexão (ex. `unimed-blumenau-soap`). Nulo quando ainda não há automação."},"agendaRetornos":{"type":"string","pattern":"^(\\S+\\s+){4}\\S+$"},"agendaSituacao":{"type":"string","pattern":"^(\\S+\\s+){4}\\S+$"}},"additionalProperties":false},"example":{"ativa":true,"agendaRetornos":"0 */6 * * *"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Conexao"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}},"delete":{"tags":["Conexões"],"operationId":"conexoesPorId_remover","summary":"Remove a conexão","security":[{"chaveApi":["conexao:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conexoes/{id}/execucoes":{"get":{"tags":["Conexões"],"operationId":"conexoesPorIdExecucoes_listar","summary":"Histórico da conexão, inclusive o que o agendador rodou","security":[{"chaveApi":["conexao:ler"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExecucaoResumo"}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conexoes/{id}/credenciais":{"put":{"tags":["Conexões"],"operationId":"conexoesPorIdCredenciais_gravar","summary":"Grava credenciais","security":[{"chaveApi":["conexao:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["RPA"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"mfaSecret":{"type":"string"},"extraFields":{"type":"object","additionalProperties":{}}},"required":["username","password"],"additionalProperties":false}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["WEBSERVICE"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"certificateBase64":{"type":"string"},"certificatePassword":{"type":"string"},"certificateExpiry":{"type":"string","format":"date-time"},"extraFields":{"type":"object","additionalProperties":{}}},"required":["username","password"],"additionalProperties":false}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["EMAIL"]},"credentials":{"type":"object","properties":{"smtpHost":{"type":"string","minLength":1},"smtpPort":{"type":"integer","exclusiveMinimum":true,"minimum":0},"imapHost":{"type":"string","minLength":1},"imapPort":{"type":"integer","exclusiveMinimum":true,"minimum":0},"emailUser":{"type":"string","format":"email"},"emailPassword":{"type":"string","minLength":1},"recipientEmail":{"type":"string","format":"email"}},"required":["smtpHost","smtpPort","imapHost","imapPort","emailUser","emailPassword"],"additionalProperties":false}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["MANUAL"]},"credentials":{"type":"object","additionalProperties":{}}},"required":["method","credentials"],"additionalProperties":false}]},"example":{"usuario":"login-do-prestador","senha":"senha-do-portal"}}}},"responses":{"200":{"description":"Sucesso"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}},"delete":{"tags":["Conexões"],"operationId":"conexoesPorIdCredenciais_remover","summary":"Apaga credenciais","security":[{"chaveApi":["conexao:gerenciar"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso"},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}},"/v1/conexoes-saude":{"get":{"tags":["Conexões"],"operationId":"conexoesSaude_listar","summary":"Panorama do que precisa de atenção","security":[{"chaveApi":["conexao:ler"]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PanoramaSaude"}}},"required":["data"]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"403":{"$ref":"#/components/responses/EscopoInsuficiente"},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CONEXAO_NAO_ENCONTRADA","message":"..."}}}}}}}},"components":{"securitySchemes":{"chaveApi":{"type":"http","scheme":"bearer","description":"Chave emitida pela clínica. `myd_live_…`: produção. `myd_test_…`: chave de teste — opera só na homologação da operadora e só vê o que é de teste. Alternativa: cabeçalho `X-API-Key`."}},"schemas":{"Erro":{"type":"object","properties":{"error":{"type":"string","description":"Código estável, seguro para lógica"},"message":{"type":"string","description":"Texto para humano; pode mudar"},"details":{"type":"object","additionalProperties":true,"nullable":true,"description":"O que mais se sabe sobre o erro. Em erro de validação, traz `campos` com o campo e o motivo de cada recusa."}},"required":["error","message","details"]},"Aceita":{"type":"object","description":"Toda operação com a operadora é assíncrona.","properties":{"execucaoId":{"type":"string","description":"A execução que produziu este registro, pelo identificador do Miydas."},"status":{"type":"string","example":"PENDENTE","description":"Em que ponto o processamento está."},"operacao":{"type":"string","example":"CHECK_ELIGIBILITY","description":"A operação com a operadora, no vocabulário do Miydas (`CHECK_ELIGIBILITY`, `FETCH_RETURNS`, `SUBMIT_BATCH`…). A mesma em qualquer canal."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"consultarEm":{"type":"string","example":"/v1/execucoes/exec_123","description":"O caminho onde o resultado vai aparecer. Use este valor em vez de montar a URL — ele muda sozinho se a rota mudar."},"lote":{"type":"object","description":"Presente quando a operação nasceu de um lote — o recorte que ela pediu à operadora.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}}},"ressalva":{"type":"string","description":"Presente quando a rota é PARCIAL, ou quando o recorte tem limite declarado"}},"required":["execucaoId","status","consultarEm"]},"Execucao":{"type":"object","properties":{"execucaoId":{"type":"string","description":"A execução que produziu este registro, pelo identificador do Miydas."},"operacao":{"type":"string","description":"A operação com a operadora, no vocabulário do Miydas (`CHECK_ELIGIBILITY`, `FETCH_RETURNS`, `SUBMIT_BATCH`…). A mesma em qualquer canal."},"status":{"type":"string","enum":["PENDENTE","EXECUTANDO","CONCLUIDA","FALHOU","CANCELADA","AGUARDANDO_ACAO"],"description":"Em que ponto o processamento está."},"resultado":{"type":"object","nullable":true,"additionalProperties":true,"description":"O que a operação produziu. O formato depende da operação — veja o recurso que ela alimenta."},"erro":{"type":"object","nullable":true,"properties":{"codigo":{"type":"string","description":"Código estável do erro, feito para lógica."},"mensagem":{"type":"string","nullable":true,"description":"O erro em português, para humano. Pode mudar sem aviso."}},"description":"O que falhou. `null` quando não falhou nada."},"tentativa":{"type":"integer","description":"Cresce a cada retentativa do sistema"},"aguardandoAte":{"type":"string","format":"date-time","nullable":true,"description":"Só em AGUARDANDO_ACAO: prazo da ação manual"},"iniciadaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando começou, em ISO 8601 com fuso."},"concluidaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando terminou, em ISO 8601 com fuso. Nulo = ainda corre."}}},"ExecucaoResumo":{"type":"object","properties":{"execucaoId":{"type":"string","description":"A execução que produziu este registro, pelo identificador do Miydas."},"operacao":{"type":"string","description":"A operação com a operadora, no vocabulário do Miydas (`CHECK_ELIGIBILITY`, `FETCH_RETURNS`, `SUBMIT_BATCH`…). A mesma em qualquer canal."},"status":{"type":"string","description":"Em que ponto o processamento está."},"erro":{"type":"object","nullable":true,"description":"O que falhou. `null` quando não falhou nada."},"tentativa":{"type":"integer","description":"Qual tentativa é esta na cadeia. Cresce a cada retentativa do sistema."},"origem":{"type":"string","enum":["AGENDADA","INTEGRACAO","MANUAL"],"description":"Quem disparou: a agenda da conexão, uma chamada de API, ou alguém pela tela."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."},"concluidaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando terminou, em ISO 8601 com fuso. Nulo = ainda corre."},"duracaoMs":{"type":"integer","nullable":true,"description":"Quanto durou, em milissegundos."}}},"RetornosExecucao":{"type":"object","properties":{"execucaoId":{"type":"string","description":"A execução que produziu este registro, pelo identificador do Miydas."},"arquivos":{"type":"integer","description":"Quantos arquivos a execução trouxe."},"normalizados":{"type":"integer","description":"Quantos já foram lidos"},"totais":{"type":"object","description":"Somatório do que foi lido, em todos os arquivos.","properties":{"guias":{"type":"integer","description":"As guias do documento."},"itens":{"type":"integer","description":"Quantas linhas de item foram lidas."},"apresentado":{"type":"number","description":"O total cobrado nos documentos lidos."},"glosado":{"type":"number","description":"O total glosado nos documentos lidos."},"pago":{"type":"number","description":"O total pago nos documentos lidos."}}},"retornos":{"type":"array","items":{"type":"object","properties":{"arquivoId":{"type":"string","description":"O arquivo, pelo identificador do Miydas."},"nomeArquivo":{"type":"string","description":"O nome do arquivo como a fonte o nomeou."},"competencia":{"type":"string","nullable":true,"example":"2026-07","description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"situacao":{"type":"string","enum":["PENDING","PROCESSING","PROCESSED","ERROR"],"description":"Onde a leitura deste arquivo parou: `PENDING`, `PROCESSING`, `PROCESSED` ou `ERROR`."},"erro":{"type":"string","description":"O que falhou. `null` quando não falhou nada."},"normalizado":{"type":"object","nullable":true,"description":"Nulo quando o arquivo ainda não foi lido ou não foi reconhecido.","properties":{"tipoDocumento":{"type":"string","nullable":true,"description":"O que o leitor reconheceu no arquivo. Nulo quando não reconheceu."},"confianca":{"type":"number","nullable":true,"description":"Quanto o identificador confiou no palpite, de 0 a 1."},"totais":{"type":"object","nullable":true,"description":"Os totais do documento, já somados."},"guias":{"type":"array","items":{"type":"object"},"description":"As guias do documento."},"liquidacao":{"type":"object","description":"Do liberado ao que cai na conta. Presente só em documento que fecha pagamento. O padrão TISS descreve o que foi liberado por guia e para aí; entre o liberado e o extrato bancário há imposto retido e desconto.","properties":{"grossAmount":{"type":"number","description":"Produção liberada, antes de retenções"},"netAmount":{"type":"number","description":"O que cai na conta — concilia com o extrato"},"deferredAmount":{"type":"number","description":"Apartado para competência futura"},"creditDate":{"type":"string","format":"date","description":"Data do crédito em conta."},"bankName":{"type":"string","description":"Banco do crédito, como o documento o informa."},"bankBranch":{"type":"string","description":"Agência do crédito, como o documento a informa."},"bankAccount":{"type":"string","description":"Conta do crédito, como o documento a informa."},"withholdings":{"type":"array","description":"Tributos retidos na fonte pela operadora","items":{"type":"object","properties":{"description":{"type":"string","description":"O tributo, como a operadora o nomeia no documento."},"baseAmount":{"type":"number","description":"A base de cálculo sobre a qual o tributo incidiu."},"taxAmount":{"type":"number","description":"O valor retido."},"paymentDate":{"type":"string","format":"date","description":"Data a que a retenção se refere."}}}},"deductions":{"type":"array","description":"Descontos que não são imposto: taxa associativa, acerto, adiantamento","items":{"type":"object","properties":{"description":{"type":"string","description":"O desconto, como a operadora o nomeia."},"amount":{"type":"number","description":"O valor do desconto."},"kind":{"type":"string","enum":["debit","credit"],"description":"`debit` reduz o crédito; `credit` o aumenta."}}}}}},"avisos":{"type":"array","items":{"type":"object"},"description":"O que o leitor notou e que muda como este documento deve ser lido."}}},"bruto":{"type":"object","description":"O arquivo original permanece guardado — é prova e permite reprocessar.","properties":{"bytes":{"type":"integer","description":"Tamanho do arquivo original, em bytes."},"tipo":{"type":"string","nullable":true,"description":"O tipo MIME do arquivo original."},"disponivel":{"type":"boolean","description":"O arquivo original ainda pode ser baixado. Ele é prova e permite reprocessar."}}},"recebidoEm":{"type":"string","format":"date-time","description":"Quando o arquivo chegou ao Miydas, em ISO 8601 com fuso."}}},"description":"Os documentos que a execução trouxe, um por arquivo."}}},"CampoCredencial":{"type":"object","description":"O que perguntar na tela de configuração.","properties":{"nome":{"type":"string","example":"username","description":"A chave do campo, como enviá-lo ao configurar a conexão."},"rotulo":{"type":"string","example":"Usuário do portal","description":"Como perguntar este campo ao usuário, na tela de configuração."},"tipo":{"type":"string","enum":["texto","senha","cnpj","certificado"],"description":"Como o campo deve ser pedido na tela. `senha` e `certificado` nunca voltam nesta API."},"obrigatorio":{"type":"boolean","description":"Sem este campo a conexão não funciona."},"ajuda":{"type":"string","description":"O texto de apoio a mostrar junto do campo."},"ondeObter":{"type":"string","description":"Onde o usuário acha este dado — a tela do portal, o contrato, o e-mail de credenciamento."}},"required":["nome","rotulo","tipo","obrigatorio"]},"Conector":{"type":"object","properties":{"id":{"type":"string","example":"unimed-blumenau-soap","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nome":{"type":"string","description":"O conector por extenso, como ele aparece na matriz pública."},"grupo":{"type":"string","description":"A que grupo de operadoras ele pertence (ex. `Unimed`, `Porto Seguro`) — um grupo costuma ter vários conectores."},"canal":{"type":"string","enum":["WEBSERVICE","RPA","EMAIL","MANUAL"],"description":"Por onde o Miydas fala com esta operadora: `WEBSERVICE`, `RPA` (robô no portal), `EMAIL` ou `MANUAL`. Aparece aqui porque é a clínica que configura — nos recursos de negócio o canal não existe."},"operacoes":{"type":"array","items":{"type":"string"},"description":"As operações abrangidas, pelo nome que a matriz de conectores usa."},"maturidade":{"type":"string","enum":["stable","beta","experimental","deprecated"],"description":"O quanto esta automação está provada: `stable`, `beta`, `experimental` ou `deprecated`."},"credenciais":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CampoCredencial"},"description":"Nulo quando o conector ainda não declarou o que exige"},"enderecoPadrao":{"type":"object","nullable":true,"properties":{"portalUrl":{"type":"string","nullable":true,"description":"Endereço padrão do portal, para quando a conexão não traz um."},"webserviceUrl":{"type":"string","nullable":true,"description":"Endereço padrão do webservice, para quando a conexão não traz um."}},"description":"Os endereços que este conector usa quando a clínica não informa os dela."}}},"SaudeConexao":{"type":"object","properties":{"situacao":{"type":"string","enum":["OPERANDO","ATENCAO","PARADA"],"description":"`OPERANDO` · `ATENCAO` (falhou, mas ainda tenta) · `PARADA` (não busca mais nada até alguém agir)."},"problemas":{"type":"array","items":{"type":"string"},"description":"O que está errado nesta conexão, um por linha, em português."},"proximoPasso":{"type":"string","nullable":true,"description":"O que fazer para resolver"},"ultimaSincronizacao":{"type":"string","format":"date-time","nullable":true,"description":"Quando esta conexão buscou dado pela última vez, em ISO 8601 com fuso."},"ultimoResultado":{"type":"string","nullable":true,"description":"Como terminou a última execução desta conexão."},"falhasConsecutivas":{"type":"integer","description":"Quantas falhas seguidas. Chegando a cinco, a conexão é desativada sozinha para não queimar credencial."}}},"Conexao":{"type":"object","properties":{"conexaoId":{"type":"string","description":"A conexão desta clínica com esta operadora, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."},"convenioId":{"type":"string","nullable":true,"description":"O convênio da clínica a que esta operadora corresponde."}},"description":"A operadora do documento, identificada pelo registro ANS."},"canal":{"type":"string","description":"Por onde o Miydas fala com esta operadora: `WEBSERVICE`, `RPA` (robô no portal), `EMAIL` ou `MANUAL`. Aparece aqui porque é a clínica que configura — nos recursos de negócio o canal não existe."},"conectorId":{"type":"string","nullable":true,"description":"Qual conector atende esta conexão (ex. `unimed-blumenau-soap`). Nulo quando ainda não há automação."},"portalUrl":{"type":"string","nullable":true,"description":"O endereço do portal da operadora usado por esta conexão."},"webserviceUrl":{"type":"string","nullable":true,"description":"O endereço do webservice da operadora usado por esta conexão."},"ativa":{"type":"boolean","description":"A assinatura está recebendo eventos."},"sincronizacaoAutomatica":{"type":"boolean","description":"O Miydas busca sozinho nesta conexão, na agenda abaixo. `false` = só roda quando alguém pede."},"agenda":{"type":"object","properties":{"retornos":{"type":"string","nullable":true,"example":"0 3 * * *","description":"Quando buscar demonstrativos, em cron (ex. `0 3 * * *` = todo dia às 3h)."},"situacao":{"type":"string","nullable":true,"example":"0 */6 * * *","description":"Quando conferir a situação dos lotes enviados, em cron."}},"description":"Quando cada rotina roda nesta conexão, em expressão cron."},"credenciais":{"type":"object","description":"Nunca devolve o valor — só se está preenchida e a situação.","properties":{"configuradas":{"type":"boolean","description":"A clínica já preencheu as credenciais. O valor nunca sai desta API."},"situacao":{"type":"string","enum":["NOT_CONFIGURED","TESTING","VALID","INVALID","EXPIRED"],"description":"`VALID` testada e funcionando · `TESTING` ainda não testada · `INVALID` recusada pela operadora · `EXPIRED` venceu · `NOT_CONFIGURED` vazia."}}},"saude":{"$ref":"#/components/schemas/SaudeConexao","description":"Se esta conexão está operando, e o que fazer quando não está."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."}}},"PanoramaSaude":{"type":"object","properties":{"total":{"type":"integer","description":"O total do recorte pedido."},"porSituacao":{"type":"object","additionalProperties":{"type":"integer"},"description":"Os mesmos números, abertos por situação."},"precisamAtencao":{"type":"array","items":{"type":"object"},"description":"As conexões que não estão operando — a fila de trabalho desta tela."}}},"OperadoraDisponivel":{"type":"object","properties":{"ansOperatorId":{"type":"string","description":"A operadora no cadastro público da ANS, pelo identificador do Miydas."},"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"razaoSocial":{"type":"string","description":"Razão social, como consta no cadastro público."},"nomeFantasia":{"type":"string","nullable":true,"description":"Nome fantasia, quando o cadastro informa."},"cnpj":{"type":"string","nullable":true,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."},"jaHabilitada":{"type":"boolean","description":"Esta clínica já tem convênio criado para esta operadora."},"automacao":{"type":"object","nullable":true,"description":"Nulo quando o Revenue ainda não automatiza esta operadora","properties":{"maturidade":{"type":"string","description":"O quanto a automação desta operadora está provada."},"observacao":{"type":"string","nullable":true,"description":"Observação registrada, em texto livre."},"canais":{"type":"array","items":{"type":"object"},"description":"Por quais canais ela é automatizada."}}}}},"MatrizConectores":{"type":"object","description":"O que cada conector faz, o que não faz e por quê.","properties":{"operacoes":{"type":"array","items":{"type":"object","properties":{"operacao":{"type":"string","description":"A operação, pelo nome do Miydas."},"descricao":{"type":"string","description":"O que esta operação faz, em uma linha."},"retorno":{"type":"string","description":"Mesmo tipo em qualquer canal"},"minimoEm":{"type":"array","items":{"type":"string","enum":["WEBSERVICE","RPA"]},"description":"Em que canais esta operação é exigida para o conector ser considerado completo."}}},"description":"As operações abrangidas, pelo nome que a matriz de conectores usa."},"conectores":{"type":"array","description":"Uma linha por conector, com o estado de cada operação nele.","items":{"type":"object","properties":{"conectorId":{"type":"string","description":"O conector a que esta linha da matriz se refere."},"canal":{"type":"string","description":"Por onde este conector fala: `WEBSERVICE` ou `RPA`."},"cobertura":{"type":"string","example":"13/13","description":"Quantas operações do mínimo ele cobre, como `13/13`."},"operacoes":{"type":"object","additionalProperties":{"type":"object","properties":{"estado":{"type":"string","enum":["IMPLEMENTADA","NAO_SUPORTADA","LACUNA","FORA_DO_MINIMO"]},"motivo":{"type":"string"}}},"description":"O estado de cada operação neste conector, com o motivo quando não é suportada."}}}}}},"Convenio":{"type":"object","properties":{"convenioId":{"type":"string","description":"O convênio cadastrado na clínica, pelo identificador do Miydas. Um convênio pode ter mais de uma conexão."},"nome":{"type":"string","description":"O convênio como a clínica o chama no cadastro dela."},"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"situacao":{"type":"string","description":"O estado do convênio no cadastro da clínica."},"codigoPrestador":{"type":"string","nullable":true,"description":"O código desta clínica na operadora, como ela o cadastrou. Sem ele, boa parte dos portais recusa a consulta."},"conexoes":{"type":"array","items":{"type":"object"},"description":"As conexões deste convênio — uma por canal configurado."}}},"SolicitacaoDeConector":{"type":"object","description":"Um pedido de conector. Idempotente por (empresa, operadora): pedir de novo devolve o mesmo pedido, com o motivo e o volume atualizados.","properties":{"solicitacaoId":{"type":"string","description":"O id do pedido. O mesmo em cada repetição, porque o pedido é único por operadora."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Como o catálogo ANS a nomeia."}},"description":"A operadora do documento, identificada pelo registro ANS."},"situacao":{"type":"string","enum":["PENDENTE","EM_DESENVOLVIMENTO","CONCLUIDO","DESCARTADO"],"description":"CONCLUIDO quer dizer que o conector existe — veja `GET /v1/conectores`."},"resposta":{"type":"string","nullable":true,"description":"O que a equipe respondeu, quando já respondeu."},"estimativaEntrega":{"type":"string","format":"date-time","nullable":true,"description":"Quando a equipe estima entregar o conector, se já estimou."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."}}},"ConvenioHabilitado":{"type":"object","properties":{"convenioId":{"type":"string","description":"O convênio cadastrado na clínica, pelo identificador do Miydas. Um convênio pode ter mais de uma conexão."},"nome":{"type":"string","description":"O convênio como a clínica o chama no cadastro dela."},"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"automacaoDisponivel":{"type":"boolean","description":"Existe conector para esta operadora. `false` = o convênio funciona, mas tudo nele é manual."},"conexoes":{"type":"array","items":{"$ref":"#/components/schemas/Conexao"},"description":"Já vêm criadas a partir do catálogo, com conector e URL"}}},"Paginacao":{"type":"object","description":"Onde esta página está dentro do total. Vem ao lado de `data`, fora dele.","properties":{"total":{"type":"integer","description":"Quantos registros existem no filtro pedido — não quantos vieram nesta página."},"limite":{"type":"integer","description":"O teto aplicado nesta resposta, seja o que você pediu ou o padrão da rota."},"deslocamento":{"type":"integer","description":"Quantos registros foram pulados para chegar nesta página."},"temMais":{"type":"boolean","description":"Há página seguinte. Equivale a `deslocamento + itens < total`, já calculado."}}},"ExecucaoEnfileirada":{"type":"object","properties":{"execucaoId":{"type":"string","description":"Identificador da execução enfileirada."},"status":{"type":"string","description":"Estado do processamento no momento da resposta."},"operacao":{"type":"string","description":"A operação que foi enfileirada, no vocabulário do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro ANS da operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"consultarEm":{"type":"string","description":"Caminho para acompanhar o desfecho desta execução."},"ressalva":{"type":"string","nullable":true,"description":"Limite conhecido desta operação, ou `null` quando não há. Vem SEMPRE, para o integrador não ter de distinguir chave ausente de ausência de ressalva."}}},"LeituraDeArquivo":{"type":"object","description":"O resultado de ler um arquivo. Nada foi gravado: o acervo e `GET /v1/demonstrativos`.","properties":{"arquivo":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do arquivo de onde o dado veio, como a operadora o nomeou."},"formato":{"type":"string","enum":["XML","ZIP"],"description":"O involucro. Num ZIP, cada XML interno foi lido."},"bytes":{"type":"integer","description":"Tamanho do arquivo recebido."}},"description":"O arquivo de onde o dado veio."},"demonstrativos":{"type":"array","description":"Um por documento encontrado no arquivo. Um ZIP com varios XML devolve varios; um XML, normalmente um.","items":{"type":"object","properties":{"tipo":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. Duas respostas distintas, quase sempre em meses distintos."},"numeroDemonstrativo":{"type":"string","nullable":true,"description":"O número que a operadora deu ao demonstrativo. NÃO identifica o documento: ele se repete entre operadoras e entre competências. A identidade de um retorno é o protocolo mais a data."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM, como o documento a declara."},"operadora":{"type":"string","nullable":true,"description":"O nome da operadora como o documento o escreve — nao e o catalogo ANS."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Data que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download."},"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data do credito. So em documento de pagamento."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"valorPago":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"guias":{"type":"array","items":{"type":"object","properties":{"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"atendimentoEm":{"type":"string","format":"date","nullable":true,"description":"Data de realizacao do atendimento, como o documento a declara."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"glosas":{"type":"array","description":"Glosas de nivel GUIA — as de item estao em `itens[].glosas`.","items":{"type":"object","properties":{"codigo":{"type":"string","nullable":true,"description":"Codigo da glosa na tabela 38 do TISS, como o documento o trouxe."},"descricao":{"type":"string","nullable":true,"description":"O significado do codigo. Preenchido da tabela 38 quando o documento manda so o codigo."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}},"itens":{"type":"array","description":"Procedimentos e despesas da guia, como o documento os lista.","items":{"type":"object","properties":{"tipo":{"type":"string","enum":["PROCEDIMENTO","DESPESA"],"description":"PROCEDIMENTO: a tabela de procedimentos. DESPESA: material, medicamento, taxa, diaria, OPME."},"sequencial":{"type":"string","nullable":true,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"codigoProcedimento":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada em `codigoTabela`."},"codigoDespesa":{"type":"string","nullable":true,"description":"So em item de despesa."},"descricao":{"type":"string","nullable":true,"description":"Descrição do item, como a fonte a informou."},"quantidade":{"type":"string","nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"glosas":{"type":"array","description":"As glosas deste item — o nivel em que o recurso e montado, porque no TISS ele e item a item.","items":{"type":"object","properties":{"codigo":{"type":"string","nullable":true,"description":"Codigo da glosa na tabela 38 do TISS, como o documento o trouxe."},"descricao":{"type":"string","nullable":true,"description":"O significado do codigo. Preenchido da tabela 38 quando o documento manda so o codigo."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}}}}}}},"description":"As guias do documento."},"liquidacao":{"type":"object","description":"O acerto financeiro do documento. AUSENTE em documento de analise: analise nao fecha pagamento, e um bloco vazio ali diria \"sem imposto\" onde o certo e \"este documento nao trata disso\".","properties":{"totalDebitos":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"totalCreditos":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"lancamentos":{"type":"array","description":"Linha a linha do que foi descontado e somado ao credito.","items":{"type":"object","properties":{"natureza":{"type":"string","enum":["DEBITO","CREDITO"],"nullable":true,"description":"Nulo quando o documento manda um indicador fora de 1 (debito) e 2 (credito): chamar credito o que e debito inverteria o sinal do dinheiro."},"tipo":{"type":"string","nullable":true,"description":"O codigo do tipo de debito ou credito, como a operadora o declara."},"descricao":{"type":"string","nullable":true,"description":"O texto do lancamento (ex. \"IRPJ Prod Medica\")."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}}}}}}},"avisos":{"type":"array","items":{"type":"string"},"description":"Vazio quando a leitura saiu limpa. Arquivo que nao produziu demonstrativo nenhum devolve `demonstrativos: []` COM aviso — nunca 204, que o integrador leria como sucesso silencioso."}}},"Processamento":{"type":"object","description":"Andamento com a operadora. CONCLUIDO = a operadora respondeu; o desfecho está no recurso.","properties":{"status":{"type":"string","enum":["PENDENTE","PROCESSANDO","CONCLUIDO","FALHOU"],"description":"Em que ponto o processamento está."},"iniciadoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o processamento começou, em ISO 8601 com fuso."},"concluidoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o processamento terminou, em ISO 8601 com fuso. `null` = ainda corre."},"erro":{"type":"object","properties":{"error":{"type":"string","description":"Código estável do erro, feito para lógica. É o contrato — a mensagem não é."},"message":{"type":"string","description":"O erro em português, para humano. Pode mudar sem aviso."},"podeRepetir":{"type":"boolean","description":"Repetir o mesmo pedido pode dar outro resultado. `false` = o erro é definitivo, corrija antes."}},"description":"O que falhou. `null` quando não falhou nada."}}},"Lote":{"type":"object","description":"Um lote de faturamento. A mensagem TISS em si não aparece aqui de propósito: formato é implementação, e o integrador precisa do veredito, não do XML.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"referenciaExterna":{"type":"string","description":"O id do lote no seu sistema. Chave de idempotência."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"competencia":{"type":"string","description":"YYYY-MM"},"numeroLote":{"type":"string","description":"O número do lote, como ele foi transmitido à operadora."},"situacao":{"type":"object","description":"A TRANSMISSÃO: o lote chegou à operadora e ganhou protocolo? Não diz o que a operadora achou do conteúdo — isso é `processamento`.","properties":{"codigo":{"type":"string","enum":["PRONTO","INVALIDO","TRANSMITIDO","TRANSMITINDO","RECUSADO","INDETERMINADO"],"description":"O estado da transmissão. `INDETERMINADO` é o que exige gente: a conexão caiu sem resposta e não se sabe se a operadora recebeu — reenviar às cegas duplica o faturamento."},"descricao":{"type":"string","description":"O mesmo estado de `situacao.codigo`, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar."},"podeEnviar":{"type":"boolean","description":"Este lote pode ser transmitido agora. `false` em lote já transmitido, inválido ou indeterminado."}}},"processamento":{"type":"object","nullable":true,"description":"O JULGAMENTO DO CONTEÚDO pela operadora. Outra pergunta, outra resposta: um lote TRANSMITIDO pode estar REJEITADO aqui — recebido e protocolado, com nenhuma conta aceita. `null` é \"ainda não se sabe\", nunca \"aceito\": a importação da operadora é assíncrona.","properties":{"codigo":{"type":"string","enum":["PROCESSANDO","ACEITO","REJEITADO"],"description":"O veredito sobre o conteúdo. `REJEITADO` com `situacao` TRANSMITIDO é caso real: chegou, foi protocolado, e nenhuma conta passou."},"descricao":{"type":"string","description":"O mesmo estado de `processamento.codigo`, em português, para mostrar a gente. O contrato é o código."},"acao":{"type":"string","description":"O que fazer agora. Em REJEITADO: corrigir e gerar lote NOVO, nunca retransmitir este."},"motivo":{"type":"string","nullable":true,"description":"O motivo na língua da operadora (ex. \"CM104 - NUMERO DE GUIA INVALIDO\")."},"em":{"type":"string","nullable":true,"description":"Quando soubemos do julgamento."}}},"conformidade":{"type":"object","description":"Veredito do esquema oficial da ANS. Lote inválido é recusado na transmissão.","properties":{"xsdValido":{"type":"boolean","description":"O documento passou no esquema oficial da ANS (XSD). Lote inválido é recusado antes de ir à operadora."},"erros":{"nullable":true,"description":"O que falhou, item por item."}}},"totais":{"type":"object","properties":{"guias":{"type":"integer","description":"Quantas guias o lote leva."},"procedimentos":{"type":"integer","description":"Quantas linhas de procedimento o lote leva, somando todas as guias."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}},"description":"Os totais do documento, já somados."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"transmitidoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o lote foi transmitido à operadora, em ISO 8601 com fuso."},"ultimoErro":{"type":"string","nullable":true,"description":"Texto para humano. O contrato é o código do erro, não esta frase."},"criadoEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."}}},"Retencao":{"type":"object","description":"Imposto retido na fonte pela operadora, declarado no demonstrativo de pagamento. Recurso próprio porque quem pergunta é a contabilidade, e a pergunta dela é por competência.","properties":{"demonstrativoId":{"type":"string","description":"O demonstrativo a que este registro pertence, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroDemonstrativo":{"type":"string","nullable":true,"description":"O número que a operadora deu ao demonstrativo. NÃO identifica o documento: ele se repete entre operadoras e entre competências. A identidade de um retorno é o protocolo mais a data."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão."},"fonteCompetencia":{"type":"string","enum":["CREDITO","AUSENTE"],"description":"De onde saiu a competência: a data do CRÉDITO (a primeira, quando há mais de uma), ou AUSENTE quando a operadora não declarou crédito. Era a emissão até 24/10/2026, e estava errado — o portal renderiza o documento no download, e o mês da emissão difere do mês do crédito em 89,5% dos documentos."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Data que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download."},"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data do primeiro crédito do demonstrativo. Vários créditos é caso real."},"total":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"decomposicao":{"type":"object","description":"Nulo quando a operadora mandou só o total (405 de 2.915 medidos).","properties":{"iss":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"pis":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"ir":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"inss":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"cofins":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"outros":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"naoMapeados":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Tributo que a operadora declarou e que não está nos seis conhecidos, com a própria chave do documento. Ele soma na conferência — tributo novo aparece aqui em vez de virar divergência falsa."}},"nullable":true},"conferencia":{"type":"object","nullable":true,"description":"Confere o total declarado contra a soma dos quatro tributos. Nulo quando falta um dos lados.","properties":{"somaDosTributos":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"confere":{"type":"boolean","description":"`false` = o total declarado não bate com a soma dos tributos. Não é erro nosso: é o documento que não fecha, e vale conferir antes de lançar."}}},"valorLiquidoDoDemonstrativo":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"RetencaoConsolidada":{"type":"object","description":"O consolidado fiscal do recorte pedido, com o que NÃO fecha declarado em `semDecomposicao` e `divergencias`.","properties":{"competencia":{"type":"string","nullable":true,"description":"O recorte pedido. Nulo = todas as competências."},"recorte":{"type":"object","properties":{"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"O filtro que produziu estes números, devolvido junto. Total sem recorte ao lado é número solto: é por aqui que você confere que somou o que queria."},"demonstrativos":{"type":"integer","description":"Quantos demonstrativos entraram neste consolidado."},"total":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"porTributo":{"type":"object","description":"Tributos retidos na fonte. Campo nulo = a operadora não abriu aquele tributo. Medido em produção: ISS em 2.341 demonstrativos, PIS 2.038, IR 2.032, Outros 1.772, INSS 309, COFINS 6. `naoMapeados` carrega qualquer tributo novo com a própria chave do documento — ele soma na conferência, para que um tributo desconhecido apareça em vez de virar divergência falsa.","properties":{"iss":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"pis":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"ir":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"inss":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"cofins":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"outros":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"naoMapeados":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Tributo que a operadora declarou e que não está nos seis conhecidos, com a própria chave do documento. Ele soma na conferência — tributo novo aparece aqui em vez de virar divergência falsa."}}},"semDecomposicao":{"type":"object","description":"Quanto do total chegou sem abertura por tributo. Não lance isto como ISS.","properties":{"demonstrativos":{"type":"integer","description":"Quantos vieram só com o total, sem abertura por tributo."},"total":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"divergencias":{"type":"integer","description":"Demonstrativos em que o total declarado não bate com a soma dos tributos."},"porOperadora":{"type":"array","items":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora, para exibição."},"demonstrativos":{"type":"integer","description":"Quantos demonstrativos desta operadora entram no total."},"total":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"description":"Os mesmos números, abertos por operadora."},"porCompetencia":{"type":"array","items":{"type":"object","properties":{"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"demonstrativos":{"type":"integer","description":"Quantos demonstrativos deste mês entram no total."},"total":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"description":"Os mesmos números, abertos por mês de competência."}}},"Glosa":{"type":"object","description":"Uma glosa, no nível em que a operadora a declarou, com o significado oficial do motivo.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nivel":{"type":"string","enum":["PROTOCOLO","GUIA","ITEM"],"description":"Em que nível a glosa pende: `ITEM`, `GUIA` ou `PROTOCOLO`. Medido na base: 56.709 em item, 262 em guia, nenhuma em protocolo — o recurso TISS é item a item, e é no item que a glosa quase sempre mora."},"motivo":{"type":"object","description":"O motivo como a operadora o deu. `significado` vem da Tabela 38 da ANS quando o código existe lá.","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo, como a operadora o emitiu."},"significado":{"type":"string","nullable":true,"description":"Termo oficial da Tabela 38. Nulo quando o código não existe na tabela."},"tipo":{"type":"string","enum":["TABELA_ANS","CODIGO_OPERADORA","CATEGORIA","TEXTO_LIVRE","NENHUM"],"description":"Derivado do que está presente, não do campo `tipoMotivo` do banco — que está nulo em 93 % das linhas."},"tipoDeclarado":{"type":"string","nullable":true,"description":"O que o parser gravou em `tipoMotivo`. Para auditar o parser, não para decidir."},"codigoOperadora":{"type":"string","nullable":true,"description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."},"categoria":{"type":"string","nullable":true,"description":"O agrupamento que a operadora deu ao motivo, quando ela agrupa. Mais grosso que o código e, em operadora que não usa a Tabela 38, às vezes a única pista."},"notaAuditor":{"type":"string","nullable":true,"description":"Argumento do auditor da operadora. Insumo direto de recurso."}}},"descricao":{"type":"string","nullable":true,"description":"O texto livre que a operadora escreveu sobre esta glosa, além do motivo codificado."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"nullable":true,"description":"A operadora do documento, identificada pelo registro ANS."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"guia":{"type":"object","nullable":true,"properties":{"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."}},"description":"A guia a que este registro pertence."},"item":{"type":"object","nullable":true,"description":"O item glosado. Nulo em glosa de nível GUIA ou PROTOCOLO — e é por ele que se monta o recurso, que no TISS é item a item.","properties":{"codigoTabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `18`/`19`/`20` = materiais, taxas e medicamentos, `00` = tabela própria da operadora)."},"codigoProcedimento":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada em `codigoTabela`."},"descricao":{"type":"string","nullable":true,"description":"A descrição do procedimento glosado, como o documento a trouxe."}}},"evidencia":{"type":"object","nullable":true,"description":"O documento de onde a glosa saiu, com até onde ele veio.","properties":{"demonstrativoId":{"type":"string","description":"O demonstrativo a que este registro pertence, pelo identificador do Miydas."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Quando NÓS recebemos o documento — o portal o renderiza no download."},"protocoloEm":{"type":"string","format":"date","nullable":true,"description":"A data de negócio do protocolo, de onde sai a competência."},"fonteOrdem":{"type":"integer","nullable":true,"description":"Qual arquivo do demonstrativo composto trouxe esta glosa."},"completude":{"type":"string","description":"FULL | ACCEPTED_ONLY | GLOSA_ONLY — o que o conjunto de arquivos permite afirmar."},"profundidade":{"type":"string","nullable":true,"description":"Até onde o documento desce: `PROTOCOLO`, `GUIA` ou `ITEM`. Documento que para na guia não permite recurso item a item."}}},"registradaEm":{"type":"string","format":"date-time","description":"Quando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora."}}},"ResumoDeGlosas":{"type":"object","description":"O retrato agregado do recorte: quanto, em que nível, e quanto veio sem motivo.","properties":{"recorte":{"type":"object","properties":{"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."}},"description":"O filtro que produziu estes números, devolvido junto. Total sem recorte ao lado é número solto: é por aqui que você confere que somou o que queria."},"glosas":{"type":"integer","description":"Quantas glosas no recorte."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"comSignificadoOficial":{"type":"object","description":"Quantas têm código que existe na Tabela 38. `proporcao` é 0–1, não percentual.","properties":{"glosas":{"type":"integer","description":"Quantas trazem código que existe na Tabela 38 da ANS."},"proporcao":{"type":"number","description":"A fração delas sobre o total, de 0 a 1. `0.62` é 62% — não é percentual."}}},"semCodigo":{"type":"object","description":"A operadora cortou e não disse por quê. Material de recurso.","properties":{"glosas":{"type":"integer","description":"Quantas vieram sem motivo codificado."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"porNivel":{"type":"array","items":{"type":"object","properties":{"nivel":{"type":"string","description":"O nível em que a glosa pende: `ITEM`, `GUIA` ou `PROTOCOLO`."},"glosas":{"type":"integer","description":"Quantas glosas pendem deste nível."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"description":"Os mesmos números, abertos pelo nível em que a glosa pende."},"maioresPorValor":{"type":"array","description":"Os motivos que mais custaram, do mais caro para o mais barato. É por onde se começa a recorrer.","items":{"type":"object","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo. Nulo agrupa tudo que veio sem código."},"significado":{"type":"string","nullable":true,"description":"O termo da Tabela 38, quando o código existe nela."},"glosas":{"type":"integer","description":"Quantas glosas têm este motivo."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}}}}},"Demonstrativo":{"type":"object","description":"O retorno da operadora como acervo: um documento de análise de conta ou de pagamento.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"tipo":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. Duas respostas distintas, quase sempre em meses distintos."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroDemonstrativo":{"type":"string","nullable":true,"description":"O número que a operadora deu ao demonstrativo. NÃO identifica o documento: ele se repete entre operadoras e entre competências. A identidade de um retorno é o protocolo mais a data."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão."},"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data do crédito. Só em documento de pagamento."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Quando NÓS recebemos o documento — o portal o renderiza no download."},"completude":{"type":"string","description":"FULL | ACCEPTED_ONLY | GLOSA_ONLY — o que o conjunto de arquivos permite afirmar. Num GLOSA_ONLY o cobrado e o liberado NÃO chegaram: não são zero."},"profundidade":{"type":"string","nullable":true,"description":"Até onde a fonte desce: A (item + motivo) · B (item) · C (guia) · D (protocolo) · E (overlay) · F (só o fechamento financeiro)."},"versaoTiss":{"type":"string","nullable":true,"description":"Versão do padrão TISS do documento (ex. `4.01.00`). Quem dita a versão é a operadora."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"protocolos":{"type":"integer","description":"Quantos protocolos o documento cobre. A lista deles vem no detalhe."},"guias":{"type":"integer","description":"Quantas guias o documento cobre. A lista delas vem no detalhe."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}}},"DemonstrativoDetalhado":{"type":"object","description":"O documento inteiro: protocolos, guias e glosas — e a liquidação, quando é documento de pagamento.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"tipo":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. Duas respostas distintas, quase sempre em meses distintos."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroDemonstrativo":{"type":"string","nullable":true,"description":"O número que a operadora deu ao demonstrativo. NÃO identifica o documento: ele se repete entre operadoras e entre competências. A identidade de um retorno é o protocolo mais a data."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão."},"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Data que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download."},"completude":{"type":"string","description":"FULL | ACCEPTED_ONLY | GLOSA_ONLY — o que o conjunto de arquivos permite afirmar. Num GLOSA_ONLY o cobrado e o liberado NÃO chegaram: não são zero."},"profundidade":{"type":"string","nullable":true,"description":"Até onde a fonte desce: A (item + motivo) · B (item) · C (guia) · D (protocolo) · E (overlay) · F (só o fechamento financeiro)."},"versaoTiss":{"type":"string","nullable":true,"description":"Versão do padrão TISS do documento (ex. `4.01.00`). Quem dita a versão é a operadora."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"guias":{"type":"integer","description":"Total de guias do documento, inclusive as que a paginação não trouxe."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."},"avisos":{"type":"array","description":"O que impede ler este documento errado — por exemplo, que um GLOSA_ONLY não declara o cobrado.","items":{"type":"string"}},"fontes":{"type":"array","description":"Os documentos que compõem este demonstrativo. Mais de um é normal: operadora que manda o aceito e o glosado em arquivos separados aparece aqui com dois.","items":{"type":"object","description":"De onde o documento veio. Duas origens: o arquivo do inbox e a mensagem TISS — e a segunda é a dominante (2.900 contra 440 na análise). Nenhum documento da base fica sem origem.","properties":{"origem":{"type":"string","enum":["ARQUIVO","MENSAGEM_TISS"],"description":"`ARQUIVO`: um arquivo que chegou à caixa de entrada. `MENSAGEM_TISS`: a resposta estruturada do webservice. A segunda domina — 2.900 contra 440 na análise."},"papel":{"type":"string","description":"ACCEPTED (só o aceito) | GLOSA (só o recusado) | FULL (o documento inteiro)."},"ordem":{"type":"integer","description":"A posição deste registro na sequência, a partir de 1."},"arquivo":{"type":"object","properties":{"id":{"type":"string","description":"O id a passar em `/demonstrativos/{id}/arquivos/{arquivoId}`."},"nome":{"type":"string","description":"Nome do arquivo de onde o dado veio, como a operadora o nomeou."},"extensao":{"type":"string","description":"O invólucro. `formato` é o que conseguimos ler dele."},"formato":{"type":"string","nullable":true,"description":"Em que formato o dado chegou."},"tamanhoBytes":{"type":"integer","nullable":true,"description":"Tamanho do arquivo em bytes."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}},"description":"O arquivo de onde o dado veio."}}}},"protocolos":{"type":"array","items":{"type":"object","properties":{"numeroProtocolo":{"type":"string","nullable":true,"description":"O número do protocolo na operadora."},"numeroLotePrestador":{"type":"string","nullable":true,"description":"O número que o prestador deu ao lote no arquivo enviado."},"dataProtocolo":{"type":"string","format":"date","nullable":true,"description":"A data do protocolo na operadora — a data de NEGÓCIO do documento de análise, e a que define a competência."},"situacao":{"type":"string","nullable":true,"description":"O estado do protocolo na língua da operadora, sem tradução."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"glosas":{"type":"array","description":"Glosas de nível PROTOCOLO. Não são distribuídas pelas guias: o documento não as atribuiu.","items":{"$ref":"#/components/schemas/Glosa"}},"guias":{"type":"array","items":{"type":"object","properties":{"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"situacao":{"type":"string","nullable":true,"description":"O estado da guia na língua da operadora, sem tradução — cada uma tem o seu vocabulário."},"atendimentoDe":{"type":"string","format":"date","nullable":true,"description":"Primeiro dia do atendimento coberto pela guia."},"atendimentoAte":{"type":"string","format":"date","nullable":true,"description":"Último dia do atendimento coberto pela guia. Igual a `atendimentoDe` quando foi um dia só."},"fonteOrdem":{"type":"integer","nullable":true,"description":"Qual dos arquivos do demonstrativo composto trouxe esta guia. Cruze com `fontes[].ordem`."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"glosas":{"type":"array","description":"As glosas desta guia dentro deste documento.","items":{"$ref":"#/components/schemas/Glosa"}}}},"description":"As guias do documento."},"totalDeGuias":{"type":"integer","description":"Quantas guias o protocolo tem ao todo — inclusive as que o teto de 200 por resposta não trouxe."},"temMaisGuias":{"type":"boolean","description":"O protocolo tem mais guias do que o teto de 200 por resposta."}}},"description":"Os protocolos que este documento cobre."},"liquidacao":{"type":"array","description":"O fechamento financeiro, UMA ENTRADA POR DATA DE CRÉDITO. Só em documento de pagamento; vazio na análise.","items":{"type":"object","description":"O líquido mora AQUI, por data de crédito, e não no topo do documento: os débitos são retidos sobre o DIA, e a operadora repete o bloco em cada demonstrativo daquela data. Somar entre documentos multiplica a retenção.","properties":{"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele."},"forma":{"type":"string","nullable":true,"description":"Como o dinheiro foi pago, como a operadora declarou (ex. crédito em conta)."},"banco":{"type":"string","nullable":true,"description":"Banco do crédito, como o documento o informa."},"agencia":{"type":"string","nullable":true,"description":"Agência do crédito, como o documento a informa."},"conta":{"type":"string","nullable":true,"description":"Conta do crédito, como o documento a informa."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"debitos":{"type":"array","description":"O que foi descontado do crédito do dia: impostos, taxas, acertos de período anterior.","items":{"type":"object","description":"Uma linha do acerto financeiro do dia — um desconto ou um acréscimo sobre o crédito.","properties":{"tipo":{"type":"string","description":"A natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior)."},"subtipo":{"type":"string","nullable":true,"description":"O detalhamento do tipo, quando a operadora o abre."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}},"creditos":{"type":"array","description":"O que foi somado ao crédito do dia, fora as guias.","items":{"type":"object","description":"Uma linha do acerto financeiro do dia — um desconto ou um acréscimo sobre o crédito.","properties":{"tipo":{"type":"string","description":"A natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior)."},"subtipo":{"type":"string","nullable":true,"description":"O detalhamento do tipo, quando a operadora o abre."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}},"totalDebitos":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"totalCreditos":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liquido":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}}}},"Guia":{"type":"object","description":"A guia pelas três camadas que a atravessam: envio, análise e pagamento.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"numeroLote":{"type":"string","nullable":true,"description":"O número do lote, como ele foi transmitido à operadora."},"numeroProtocolo":{"type":"string","nullable":true,"description":"O número do protocolo na operadora."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"dataExecucao":{"type":"string","format":"date","nullable":true,"description":"Data em que o procedimento foi executado, `AAAA-MM-DD`."},"creditoEm":{"type":"string","format":"date","nullable":true,"description":"Data em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele."},"camadas":{"type":"object","description":"Quais documentos existem para esta guia. MEDIDO nas tabelas de retorno, não inferido da coluna: o motor grava zero e não nulo, então a coluna não distingue \"não mandou\" de \"mandou zero\".","properties":{"envio":{"type":"boolean","description":"O lote saiu daqui. Falso em 40.746 das 40.760 guias — o portal devolve julgamento, não o arquivo enviado."},"analise":{"type":"boolean","description":"Existe documento de análise para esta guia — a operadora já julgou a conta."},"pagamento":{"type":"boolean","description":"Existe documento de pagamento — ela já declarou o crédito. Sem esta camada, `pago` é nulo."},"completudeAnalise":{"type":"string","nullable":true,"description":"A completude do documento de análise que chegou. Num `GLOSA_ONLY`, o cobrado e o liberado não vieram — não são zero."}}},"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"cobradoDaOperadora":{"type":"boolean","description":"Sem envio, o cobrado é a palavra da operadora — a única testemunha que sobrou."},"processado":{"type":"string","nullable":true,"description":"O que a operadora reconheceu como devido."},"liberado":{"type":"string","nullable":true,"description":"O que ela aceitou pagar — julgamento da análise."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"pago":{"type":"string","nullable":true,"description":"O que o demonstrativo de PAGAMENTO declara. Nulo enquanto essa camada não existir."},"diferenca":{"type":"string","nullable":true,"description":"cobrado − liberado. Nulo quando um dos lados falta: indeterminada não é zero."},"divergenciaPagamento":{"type":"string","nullable":true,"description":"pago − liberado. Positivo = pagou mais."},"situacaoPagamento":{"type":"object","nullable":true,"description":"DERIVADA de pago × liberado. A coluna `statusPagamento` está nula em 39.131 de 39.131 linhas.","properties":{"codigo":{"type":"string","enum":["PAGO_INTEGRAL","PAGO_PARCIAL","PAGO_A_MAIOR","NAO_PAGO"],"description":"O confronto entre o que foi pago e o que foi liberado. `PAGO_A_MAIOR` existe e costuma ser reemissão contada duas vezes — confira `pagamentos`."},"descricao":{"type":"string","description":"O mesmo veredito em português, para exibir."}}},"pagamentos":{"type":"integer","description":"Quantas datas de crédito somaram em `pago`. >1 merece conferência."},"temGlosaDeclarada":{"type":"boolean","description":"A operadora declarou glosa nesta guia. Diferente de ter pago a menor sem declarar — isso é glosa silenciosa."},"motivos":{"type":"array","description":"Os motivos de glosa que pesam sobre esta guia, somando os do nível da guia e os dos itens dela.","items":{"type":"object","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo, como a operadora o emitiu. Na glosa, é o código da Tabela 38 da ANS quando ela usa o oficial."},"descricao":{"type":"string","nullable":true,"description":"O motivo em texto, na língua da operadora — não traduzido."},"origem":{"type":"string","nullable":true,"description":"De que nível o motivo veio: `GUIA` ou `ITEM`."}}}},"itens":{"type":"object","description":"Quantas linhas cada lado tem. Números diferentes já indicam divergência antes de abrir os itens.","properties":{"envio":{"type":"integer","nullable":true,"description":"Quantos itens saíram daqui. Nulo quando não há camada de envio."},"retorno":{"type":"integer","nullable":true,"description":"Quantos itens a operadora devolveu."}}}}},"ItemDoDemonstrativo":{"type":"object","description":"O item como a operadora o declarou — o nível mais fundo do retorno, e onde a glosa mora em 56.709 das 56.971 glosas medidas. O motivo vai junto, e não num segundo pedido.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"guia":{"type":"object","properties":{"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."}},"description":"A guia a que este registro pertence."},"sequencial":{"type":"integer","nullable":true,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"tipo":{"type":"string","description":"PROCEDIMENTO | DESPESA (material, medicamento, taxa)."},"procedimento":{"type":"object","properties":{"tabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","nullable":true,"description":"O que a operadora escreveu."},"termoOficial":{"type":"string","nullable":true,"description":"O termo da TUSS. Divergir do anterior é informação, não erro."}},"description":"O procedimento a que a linha se refere."},"despesa":{"type":"object","nullable":true,"description":"Só em item do tipo DESPESA: procedimento não tem código de despesa nem registro ANVISA.","properties":{"codigo":{"type":"string","nullable":true,"description":"Código do material, medicamento ou taxa na tabela declarada."},"registroANVISA":{"type":"string","nullable":true,"description":"Registro do produto na ANVISA, quando a linha é material ou medicamento."}}},"grauParticipacao":{"type":"string","nullable":true,"description":"O papel do profissional no procedimento, no código TISS (ex. `00` = cirurgião)."},"unidadeMedida":{"type":"string","nullable":true,"description":"Unidade em que a quantidade é contada, no código de TRÊS dígitos da tabela 60 do TUSS (`001` a `061`). Obrigatória em despesa — o padrão TISS recusa despesa sem ela, e texto livre como \"ampola\" não serve."},"realizadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando o procedimento foi realizado."},"quantidade":{"type":"string","nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"valorUnitario":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"valores":{"type":"object","description":"A glosa é a SOMA das glosas do item — não há coluna de glosa no item, a recusa mora na tabela de glosas.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"total":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"fonteOrdem":{"type":"integer","nullable":true,"description":"Qual dos arquivos do demonstrativo composto trouxe esta linha. Cruze com `fontes[].ordem` do detalhe."},"motivos":{"type":"array","description":"Por que esta linha foi cortada, na palavra da operadora e no termo oficial. Vem junto, e não num segundo pedido — é o insumo do recurso.","items":{"type":"object","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo, como a operadora o emitiu. Na glosa, é o código da Tabela 38 da ANS quando ela usa o oficial."},"significado":{"type":"string","nullable":true,"description":"O termo oficial da Tabela 38 da ANS, quando o código existe nela."},"tipo":{"type":"string","enum":["TABELA_ANS","CODIGO_OPERADORA","CATEGORIA","TEXTO_LIVRE","NENHUM"],"description":"Que espécie de motivo é este, derivado do que veio preenchido. `NENHUM` = cortaram sem dizer por quê."},"codigoOperadora":{"type":"string","nullable":true,"description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."},"categoria":{"type":"string","nullable":true,"description":"O agrupamento que a operadora deu ao motivo, quando ela agrupa."},"notaAuditor":{"type":"string","nullable":true,"description":"O argumento do auditor. Insumo direto do recurso."},"descricao":{"type":"string","nullable":true,"description":"O motivo em texto, na língua da operadora — não traduzido."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}}}},"ItemConciliado":{"type":"object","description":"O item pelas três camadas, com o veredito do motor: a chave que casou, a diferença, o split e a decisão do faturista. É o cruzamento que o Revenue faz, não o que a operadora disse.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"chave":{"type":"string","description":"A chave que casou os dois lados: operadora + guia + código."},"tipoDeMatch":{"type":"string","description":"Como os dois lados casaram: pelo código do procedimento, pela sequência na guia, ou por aproximação. Casamento fraco merece conferência antes de virar decisão."},"envio":{"type":"object","nullable":true,"description":"Nulo é o caso dominante: o portal devolve julgamento, não o arquivo que o prestador mandou.","properties":{"sequencial":{"type":"integer","nullable":true,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"tipo":{"type":"string","nullable":true,"description":"Natureza da linha enviada: `PROCEDIMENTO` ou `DESPESA`."},"tabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"O código que VOCÊ cobrou."},"descricao":{"type":"string","nullable":true,"description":"A descrição que você enviou. Compare com a da análise: operadora que renomeia costuma ter traduzido para o código dela."},"quantidade":{"type":"string","nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"valorUnitario":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"executadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando a execução ocorreu, em ISO 8601 com fuso."}}},"analise":{"type":"object","nullable":true,"description":"Nulo quando o item saiu daqui e a operadora não o mencionou.","properties":{"sequencial":{"type":"integer","nullable":true,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"tabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"O código que a OPERADORA devolveu. Diferente do enviado quando ela traduziu para a tabela dela."},"descricao":{"type":"string","nullable":true,"description":"A descrição que a operadora devolveu."},"quantidade":{"type":"string","nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"realizadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando o procedimento foi realizado."}}},"pagamento":{"type":"object","nullable":true,"description":"Vem da GUIA de pagamento: o demonstrativo de pagamento desce até a guia em 2.929 de 2.929 documentos, nunca até o item.","properties":{"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"diferenca":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"split":{"type":"object","description":"A operadora quebrou o item em dois — liberou parte da quantidade.","properties":{"detectado":{"type":"boolean","description":"A operadora liberou parte da quantidade e cortou o resto, quebrando a linha em duas."},"detalhe":{"type":"string","nullable":true,"description":"Detalhe em texto livre, para humano. Não é contrato."}}},"decisao":{"type":"object","description":"Do faturista, não da operadora: ACEITA | EM_RECURSO. A glosa mora no item, e o recurso TISS é item a item.","properties":{"valor":{"type":"string","nullable":true,"description":"Valor em reais, decimal em string com duas casas — dinheiro não trafega como number."},"em":{"type":"string","format":"date-time","nullable":true,"description":"Quando este fato foi registrado, em ISO 8601 com fuso."},"nota":{"type":"string","nullable":true,"description":"A nota escrita por quem registrou o fato — fica no histórico do recurso."}}}}},"TermoTuss":{"type":"object","description":"Um termo da terminologia TUSS. Por padrão só o vigente: código revogado numa guia é recusa certa.","properties":{"codigo":{"type":"string","description":"O código do termo na tabela. Único dentro da tabela, não entre tabelas."},"termo":{"type":"string","description":"O termo como a tabela oficial o nomeia."},"descricaoDetalhada":{"type":"string","nullable":true,"description":"A descrição longa do termo, quando a tabela oficial traz uma."},"tabela":{"type":"integer","description":"22 = procedimentos · 38 = motivos de glosa · 19/20 = materiais e medicamentos."},"tipoDaTabela":{"type":"string","description":"A tabela TUSS de onde o termo vem, pelo número oficial da ANS."},"vigenteDe":{"type":"string","format":"date","nullable":true,"description":"Primeiro dia em que o termo vale na tabela oficial."},"vigenteAte":{"type":"string","format":"date","nullable":true,"description":"Nulo = vigente. Preenchido no passado = revogado."},"apresentacao":{"type":"string","nullable":true,"description":"Como o produto se apresenta (ex. frasco 10 ml). Só em material e medicamento."},"fabricante":{"type":"string","nullable":true,"description":"Fabricante do produto. Só em material e medicamento."},"registroANVISA":{"type":"string","nullable":true,"description":"Registro do produto na ANVISA, quando a linha é material ou medicamento."},"porte":{"type":"string","nullable":true,"description":"O porte do procedimento na tabela, quando ela o classifica — entra no cálculo de honorário."},"capitulo":{"type":"string","nullable":true,"description":"O capítulo da tabela a que o termo pertence."},"grupo":{"type":"string","nullable":true,"description":"O grupo dentro do capítulo."}}},"OperadoraAns":{"type":"object","description":"Operadora registrada na ANS. É aqui que se acha o `registroANS` a partir do CNPJ ou do nome.","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"cnpj":{"type":"string","description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."},"razaoSocial":{"type":"string","description":"Razão social, como consta no cadastro público."},"nomeFantasia":{"type":"string","nullable":true,"description":"Nome fantasia, quando o cadastro informa."},"modalidade":{"type":"string","description":"A natureza da operadora na classificação da ANS (ex. cooperativa médica, medicina de grupo, seguradora)."},"cidade":{"type":"string","nullable":true,"description":"Município, por extenso."},"uf":{"type":"string","nullable":true,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."},"registradaEm":{"type":"string","format":"date","nullable":true,"description":"Quando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora."}}},"EstabelecimentoCnes":{"type":"object","description":"Estabelecimento de saúde no CNES — o código que a guia TISS exige do prestador.","properties":{"codigoCNES":{"type":"string","description":"Código do estabelecimento no CNES, sete dígitos."},"cnpj":{"type":"string","nullable":true,"description":"CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem."},"razaoSocial":{"type":"string","description":"Razão social, como consta no cadastro público."},"nomeFantasia":{"type":"string","nullable":true,"description":"Nome fantasia, quando o cadastro informa."},"tipoUnidade":{"type":"object","description":"A espécie de estabelecimento na classificação do CNES.","properties":{"codigo":{"type":"integer","description":"O código do tipo no CNES (7 = hospital geral, 22 = clínica especializada, 39 = SADT)."},"descricao":{"type":"string","nullable":true,"description":"O tipo por extenso."}}},"cidade":{"type":"string","nullable":true,"description":"Município, por extenso."},"codigoMunicipioIBGE":{"type":"string","nullable":true,"description":"Código do município no IBGE, sete dígitos."},"uf":{"type":"string","nullable":true,"description":"Sigla da unidade federativa, duas letras (ex. `SC`)."}}},"DocumentoRecebido":{"type":"object","description":"Tudo que chegou, por portal ou por upload — inclusive o que NÃO virou dado. Medido: de 14.838 arquivos, 1.413 pararam (946 sem identificação da operadora, 455 com erro, 12 rejeitados).","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nomeArquivo":{"type":"string","description":"O nome do arquivo como a fonte o nomeou."},"extensao":{"type":"string","description":"O invólucro. `formato` é o que conseguimos ler dele."},"formato":{"type":"string","nullable":true,"description":"Em que formato o dado chegou."},"tipoDocumento":{"type":"string","nullable":true,"description":"O que o identificador reconheceu no arquivo (ex. `DEMONSTRATIVO_ANALISE`). Nulo quando ele não reconheceu — e esses 946 arquivos são o motivo de esta rota existir."},"tamanhoBytes":{"type":"integer","description":"Tamanho do arquivo em bytes."},"situacao":{"type":"object","description":"Quatro valores públicos sobre quinze estados internos: a esteira é nossa, a pergunta é sua.","properties":{"codigo":{"type":"string","enum":["EM_ANDAMENTO","PROCESSADO","PENDENTE","FALHOU"],"description":"`PROCESSADO` virou dado consultável. `PENDENTE` parou esperando gente. `FALHOU` quebrou. Os dois últimos somam `parados` no resumo."},"descricao":{"type":"string","description":"O mesmo estado de `situacao.codigo`, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar."},"estadoInterno":{"type":"string","description":"Não é contrato — pode mudar. É o que o suporte pede quando algo trava."}}},"operadora":{"type":"object","nullable":true,"properties":{"registroANS":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"recebidoEm":{"type":"string","format":"date-time","description":"Quando o arquivo chegou ao Miydas, em ISO 8601 com fuso."},"processadoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o arquivo virou dado consultável, em ISO 8601 com fuso. `null` = ainda não virou."},"totais":{"type":"object","nullable":true,"description":"O que o leitor extraiu. Nulo em documento que não virou dado.","properties":{"guias":{"type":"integer","nullable":true,"description":"As guias do documento."},"itens":{"type":"integer","nullable":true,"description":"Quantas linhas de item o leitor extraiu do documento."},"faturado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"pago":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"confianca":{"type":"number","nullable":true,"description":"Quanto o identificador confiou no palpite, de 0 a 1."},"erro":{"type":"string","nullable":true,"description":"Prefixado pela FASE em que parou: triagem, processamento ou distribuição."},"avisos":{"nullable":true,"description":"Avisos do leitor, no formato que o handler produziu."}}},"ResumoDeDocumentos":{"type":"object","description":"De tudo que chegou, quanto virou dado — e quanto parou.","properties":{"total":{"type":"integer","description":"O total do recorte pedido."},"parados":{"type":"integer","description":"PENDENTE + FALHOU: chegou e não virou dado. É o número que importa."},"porSituacao":{"type":"array","items":{"type":"object","properties":{"situacao":{"type":"string","description":"A situação, no código que a rota devolve."},"documentos":{"type":"integer","description":"Quantos documentos estão nesta situação."}}},"description":"Os mesmos números, abertos por situação."},"porEstadoInterno":{"type":"array","description":"A mesma contagem pelos quinze estados da nossa esteira. Não é contrato — serve para pedir suporte sabendo onde parou.","items":{"type":"object","properties":{"estadoInterno":{"type":"string","description":"O estado da esteira interna. Pode mudar sem aviso."},"documentos":{"type":"integer","description":"Quantos documentos estão neste estado interno."}}}}}},"PassosDaExecucao":{"type":"object","description":"Onde o robô esteve e onde parou. Quando uma execução falha, é aqui que se vê se nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu.","properties":{"execucaoId":{"type":"string","description":"A execução que produziu este registro, pelo identificador do Miydas."},"tentativas":{"type":"integer","description":"Quantas execuções a cadeia tem: a raiz mais as retentativas."},"passos":{"type":"array","description":"A trilha, em ordem. É aqui que se vê se o robô nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu.","items":{"type":"object","properties":{"tentativa":{"type":"integer","description":"Qual tentativa produziu este passo."},"numero":{"type":"integer","description":"A ordem do passo dentro da tentativa, a partir de 1."},"nome":{"type":"string","description":"O que o passo faz, em uma linha (ex. login, buscar documento, baixar)."},"tipo":{"type":"string","description":"A categoria do passo — navegação, requisição, extração."},"situacao":{"type":"string","enum":["PENDING","RUNNING","SUCCESS","FAILED","SKIPPED"],"description":"Como este passo terminou. O primeiro `FAILED` da lista é onde a execução realmente parou."},"iniciadoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o processamento começou, em ISO 8601 com fuso."},"concluidoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o processamento terminou, em ISO 8601 com fuso. `null` = ainda corre."},"duracaoMs":{"type":"integer","nullable":true,"description":"Quanto durou, em milissegundos."},"erro":{"type":"string","nullable":true,"description":"O que falhou. `null` quando não falhou nada."}}}}}},"CodigoDaOperadora":{"type":"object","description":"De-para do código próprio da operadora para a TUSS. Quando o retorno vem com o código dela, não há o que fazer sem esta tradução.","properties":{"codigoOperadora":{"type":"string","description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."},"codigoTuss":{"type":"string","nullable":true,"description":"Código do procedimento na TUSS, a terminologia da ANS."},"descricao":{"type":"string","nullable":true,"description":"A descrição que acompanha o código nos retornos da operadora."},"origem":{"type":"string","description":"DERIVADO = observado nos retornos, não declarado pela operadora."},"ocorrencias":{"type":"integer","description":"Quantas vezes o par apareceu. Com 1, é palpite; com 40, é fato. O número sai para você decidir."}}},"DocumentosDaOperadora":{"type":"object","description":"O que a operadora publica, e se conseguimos ler.","properties":{"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"documentos":{"type":"array","description":"O que esta operadora publica — e, em cada um, se já sabemos traduzir.","items":{"type":"object","properties":{"nome":{"type":"string","description":"Como a operadora chama o documento no portal dela."},"tipoDocumento":{"type":"string","description":"Para que tipo nosso ele mapeia (ex. `DEMONSTRATIVO_PAGAMENTO`)."},"formato":{"type":"string","description":"Em que formato o dado chegou."},"periodicidade":{"type":"string","nullable":true,"description":"De quanto em quanto tempo ela publica, quando há regra (ex. mensal, quinzenal)."},"leitura":{"type":"string","description":"NAO_IMPLEMENTADO = a operadora publica e ainda não traduzimos: o documento chega e para na caixa de entrada como PENDENTE."}}}}}},"LoteImportado":{"type":"object","description":"O lote que o prestador IMPORTOU — o XML que ele mandou à operadora. Não é o mesmo de `/v1/lotes`, que é o lote montado por esta API: os dois não se cruzam. É daqui que vem a camada de envio das guias.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"numeroLote":{"type":"string","description":"O número do lote, como ele foi transmitido à operadora."},"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"tipoGuia":{"type":"string","description":"Tipo de guia TISS: `SP_SADT`, `CONSULTA`, `RESUMO_INTERNACAO`, `HONORARIO`."},"versaoTiss":{"type":"string","description":"Versão do padrão TISS do documento (ex. `4.01.00`). Quem dita a versão é a operadora."},"origem":{"type":"string","description":"IMPORTADO (veio de arquivo) | GERADO (montado aqui)."},"situacao":{"type":"string","description":"O estado do lote importado aqui dentro — se foi lido, validado e distribuído em guias."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"emitidoEm":{"type":"string","format":"date","nullable":true,"description":"Data que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download."},"transmitidoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o lote foi transmitido à operadora, em ISO 8601 com fuso."},"valorTotal":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"conformidade":{"type":"object","description":"O veredito do esquema oficial da ANS sobre o XML importado.","properties":{"xsdValido":{"type":"boolean","nullable":true,"description":"O documento passou no esquema oficial da ANS (XSD). Lote inválido é recusado antes de ir à operadora."}}},"guias":{"type":"integer","description":"As guias do documento."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}}},"ItemFaturavel":{"type":"object","description":"Um procedimento realizado que ainda precisa ser cobrado. É a unidade do pré-faturamento: a conferência aponta nele, a guia o agrupa e a glosa, lá na frente, bate nele.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"fonte":{"type":"string","enum":["LIS_API","REQUISICAO","PLANILHA"],"description":"De onde o exame entrou: mandado pelo LIS, capturado numa requisição aqui, ou importado de planilha."},"idNaOrigem":{"type":"string","description":"O id que o exame tem NA ORIGEM. É a identidade do fato: reenviar o mesmo id atualiza a linha, nunca cria uma segunda cobrança."},"paciente":{"type":"object","description":"Quem fez o exame, como a origem informou.","properties":{"nome":{"type":"string","nullable":true,"description":"Nome do paciente como a origem o informou."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"cpf":{"type":"string","nullable":true,"description":"CPF, 11 dígitos. Aceito com ou sem máscara."}}},"operadora":{"type":"object","description":"Para quem vai a cobrança. Tudo nulo = exame particular ou ainda sem destino.","properties":{"registroAns":{"type":"string","nullable":true,"description":"Registro da operadora na ANS, seis dígitos, como consta no cadastro público."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."},"convenioId":{"type":"string","nullable":true,"description":"O convênio cadastrado que casa com o registro ANS, quando existe."}}},"procedimento":{"type":"object","description":"O que foi feito.","properties":{"tabela":{"type":"string","description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","description":"Descrição do procedimento, como a fonte a informou."},"quantidade":{"type":"integer","description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."}}},"valorUnitario":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"valorTotal":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"dataExecucao":{"type":"string","format":"date-time","nullable":true,"description":"Quando o exame foi feito. Nulo = a origem ainda não confirmou execução — o que é achado da conferência, não motivo para esconder o item."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão."},"situacao":{"type":"string","enum":["A_FATURAR","EM_GUIA","EM_LOTE","ENVIADO","EXCLUIDO"],"description":"Onde o item está no ciclo do dinheiro."},"auditoria":{"type":"string","enum":["NAO_AUDITADO","APTO","ALERTA","BLOQUEADO","DESATUALIZADO"],"description":"O que a conferência concluiu. É INDEPENDENTE da situação: um item pode estar A_FATURAR e BLOQUEADO ao mesmo tempo — essa é a fila de trabalho."},"auditadoEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando a última conferência válida rodou. Nulo = nunca foi conferido."},"responsavelUserId":{"type":"string","nullable":true,"description":"Quem está com este item na mão."},"requisicao":{"type":"object","nullable":true,"description":"A requisição que capturou o exame, quando ele nasceu aqui dentro.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"numero":{"type":"string","description":"O número legível da requisição que capturou o exame, do prestador para o prestador."}}},"autorizacao":{"type":"object","nullable":true,"description":"A guia que autorizou ESTE exame. Nula = não há autorização vinculada — o que não quer dizer que não seja exigida.","properties":{"guiaId":{"type":"string","description":"A guia a que este registro se refere, pelo identificador do Miydas."},"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"situacao":{"type":"string","nullable":true,"description":"Em que pé está a guia que autoriza este exame."},"quantidadeAutorizada":{"type":"string","nullable":true,"description":"Quanto a operadora liberou deste procedimento. Comparar com a quantidade executada é o que revela cobrança a descoberto."},"statusItem":{"type":"string","nullable":true,"description":"O que a operadora decidiu sobre ESTE procedimento dentro da guia."}}},"achados":{"type":"array","description":"O que a conferência encontrou de aberto neste item. Resolver um não encerra os outros.","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"codigo":{"type":"string","description":"Código do catálogo interno: AUT-001, VAL-002."},"familia":{"type":"string","description":"A que grupo o problema pertence: autorização, valor, procedimento, execução, documentação."},"severidade":{"type":"string","enum":["BLOQUEIA","ALERTA","INFO"],"description":"`BLOQUEIA` impede faturar; `ALERTA` deixa seguir com ressalva; `INFO` é observação."},"status":{"type":"string","enum":["ABERTO","EM_ANALISE","AGUARDANDO","RESOLVIDO","DISPENSADO"],"description":"Em que ponto o processamento está."},"mensagem":{"type":"string","description":"O problema em uma frase, como o faturista o lê."}}}}}},"RemessaDeItensFaturaveis":{"type":"object","description":"O que a remessa fez. Como a gravação é idempotente pelo `idNaOrigem`, o resumo é o que distingue exame novo de exame que já estava aqui — e é como você confere que um reenvio não cobrou nada duas vezes.","properties":{"itens":{"type":"array","description":"Os exames gravados, como ficaram.","items":{"$ref":"#/components/schemas/ItemFaturavel"}},"resumo":{"type":"object","description":"A contagem da remessa.","properties":{"criados":{"type":"integer","description":"Exames que não existiam e nasceram agora."},"atualizados":{"type":"integer","description":"Exames que já estavam gravados e foram atualizados pelo que veio."}}}}},"GuiasDoLote":{"type":"object","description":"As guias do lote com os itens de cada uma — SP/SADT e Consulta na mesma lista, distinguidas por `tipo`.","properties":{"loteId":{"type":"string","description":"O lote a que esta guia pertence, pelo identificador do Miydas."},"numeroLote":{"type":"string","description":"O número do lote, como ele foi transmitido à operadora."},"guias":{"type":"array","items":{"type":"object","properties":{"tipo":{"type":"string","enum":["SP_SADT","CONSULTA"],"description":"O tipo da guia TISS. `CONSULTA` não tem itens: a consulta é o próprio procedimento."},"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"autorizadaEm":{"type":"string","format":"date","nullable":true,"description":"Quando a operadora autorizou, em ISO 8601 com fuso."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"itens":{"type":"array","description":"Vazio em CONSULTA: a consulta É o procedimento, e não tem item.","items":{"type":"object","properties":{"sequencial":{"type":"integer","nullable":true,"description":"A ordem do registro dentro do documento, como a operadora a numerou."},"tipo":{"type":"string","description":"Natureza da linha: `PROCEDIMENTO` ou `DESPESA` (material, medicamento, taxa)."},"tabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"Código do item na tabela declarada."},"descricao":{"type":"string","nullable":true,"description":"Descrição do item, como a fonte a informou."},"quantidade":{"type":"string","nullable":true,"description":"Quantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (`1,5`) e arredondar aqui mudaria o valor da conta."},"valorUnitario":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"executadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando a execução ocorreu, em ISO 8601 com fuso."}}}},"atendidaEm":{"type":"string","format":"date","nullable":true,"description":"Data do atendimento declarada no documento."}}},"description":"As guias do documento."}}},"ProcedenciaDaGuia":{"type":"object","description":"De onde veio cada número desta guia — o arquivo de envio e os documentos de retorno, com o que cada um sabia.","properties":{"guia":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"numeroLote":{"type":"string","nullable":true,"description":"O número do lote, como ele foi transmitido à operadora."},"numeroProtocolo":{"type":"string","nullable":true,"description":"O número do protocolo na operadora."},"operadora":{"type":"string","nullable":true,"description":"A operadora do documento, identificada pelo registro ANS."},"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"carteirinha":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão."},"dataExecucao":{"type":"string","format":"date-time","nullable":true,"description":"Data em que o procedimento foi executado, `AAAA-MM-DD`."},"statusConciliacao":{"type":"integer","description":"O veredito do motor de conciliação sobre esta guia."},"conciliadaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando a conciliação rodou sobre este registro, em ISO 8601 com fuso."},"justificativa":{"type":"string","nullable":true,"description":"A justificativa registrada, em texto livre."},"observacao":{"type":"string","nullable":true,"description":"Observação registrada, em texto livre."}},"description":"A guia a que este registro pertence."},"envio":{"type":"object","nullable":true,"description":"Nulo quando a guia nasceu do retorno: o portal não guarda o arquivo que o prestador mandou.","properties":{"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"itens":{"type":"integer","nullable":true,"description":"Quantas linhas o arquivo de envio trazia para esta guia."},"arquivo":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nome":{"type":"string","description":"Nome do arquivo de onde o dado veio, como a operadora o nomeou."},"extensao":{"type":"string","description":"Extensão do arquivo, sem o ponto."},"formato":{"type":"string","nullable":true,"description":"Em que formato o dado chegou."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}},"description":"O arquivo de onde o dado veio."}}},"analise":{"type":"array","description":"Cada documento de ANÁLISE que falou desta guia. Mais de um é normal: a operadora reemite, e cada reemissão é uma linha aqui.","items":{"type":"object","properties":{"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"demonstrativo":{"type":"string","nullable":true,"description":"O número do demonstrativo de onde este número veio."},"emitidoEm":{"type":"string","format":"date-time","nullable":true,"description":"A data do PROTOCOLO, não a emissão do demonstrativo — essa é o dia do download."},"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"completude":{"type":"string","description":"O quanto do documento a operadora mandou: `FULL` (a conta toda), `ACCEPTED_ONLY` (só o aceito) ou `GLOSA_ONLY` (só o recusado). Somar valores de documentos de completudes diferentes dá número errado."},"profundidade":{"type":"string","nullable":true,"description":"Até onde o documento desce: `PROTOCOLO`, `GUIA` ou `ITEM`. Documento que para na guia não permite recurso item a item."},"fontes":{"type":"array","description":"Os arquivos que compõem este documento — é o caminho de volta ao papel.","items":{"type":"object","properties":{"papel":{"type":"string","description":"O que este arquivo carrega: `ACCEPTED` (só o aceito), `GLOSA` (só o recusado) ou `FULL` (o documento inteiro)."},"arquivo":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nome":{"type":"string","description":"Nome do arquivo de onde o dado veio, como a operadora o nomeou."},"extensao":{"type":"string","description":"Extensão do arquivo, sem o ponto."},"formato":{"type":"string","nullable":true,"description":"Em que formato o dado chegou."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}},"description":"O arquivo de onde o dado veio."}}}}}}},"pagamento":{"type":"array","description":"Cada documento de PAGAMENTO que falou desta guia. Mais de uma linha com datas de crédito diferentes é parcela; com a mesma data, é reemissão.","items":{"type":"object","properties":{"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"demonstrativo":{"type":"string","nullable":true,"description":"O número do demonstrativo de onde este número veio."},"pagoEm":{"type":"string","format":"date-time","nullable":true,"description":"Sem reserva: ausente é ausente."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liquidoDoDemonstrativo":{"type":"string","nullable":true,"description":"NÃO é o líquido desta guia. É o do documento, e os débitos são do DIA inteiro — costuma vir negativo."},"completude":{"type":"string","description":"O quanto do documento a operadora mandou: `FULL` (a conta toda), `ACCEPTED_ONLY` (só o aceito) ou `GLOSA_ONLY` (só o recusado). Somar valores de documentos de completudes diferentes dá número errado."},"profundidade":{"type":"string","nullable":true,"description":"Até onde o documento desce: `PROTOCOLO`, `GUIA` ou `ITEM`. Documento que para na guia não permite recurso item a item."},"fontes":{"type":"array","description":"Os arquivos que compõem este documento — é o caminho de volta ao papel.","items":{"type":"object","properties":{"papel":{"type":"string","description":"O que este arquivo carrega: `ACCEPTED` (só o aceito), `GLOSA` (só o recusado) ou `FULL` (o documento inteiro)."},"arquivo":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"nome":{"type":"string","description":"Nome do arquivo de onde o dado veio, como a operadora o nomeou."},"extensao":{"type":"string","description":"Extensão do arquivo, sem o ponto."},"formato":{"type":"string","nullable":true,"description":"Em que formato o dado chegou."},"importadoEm":{"type":"string","format":"date-time","description":"Quando este documento entrou no Miydas, em ISO 8601 com fuso."}},"description":"O arquivo de onde o dado veio."}}}}}}}}},"RetornoSemVinculo":{"type":"object","description":"Julgamento da operadora que não casou com guia nenhuma. Medido: 4.666 linhas, R$ 65.244,35 em disputa. Não é o mesmo que guia sem envio — essa existe e aparece em /v1/guias.","properties":{"tipo":{"type":"string","enum":["ANALISE","PAGAMENTO"],"description":"`ANALISE`: o julgamento da conta — o que a operadora reconheceu e o que glosou. `PAGAMENTO`: o caixa — o que ela creditou. Duas respostas distintas, quase sempre em meses distintos."},"motivo":{"type":"string","enum":["GUIA_DESCONHECIDA","OPERADORA_DIVERGENTE","SEM_NUMERO_DE_GUIA"],"description":"OPERADORA_DIVERGENTE pede corrigir cadastro; GUIA_DESCONHECIDA pede procurar a guia. Ações opostas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"demonstrativoId":{"type":"string","description":"Abre em GET /v1/demonstrativos/{id} — o caminho de volta à prova."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"competencia":{"type":"string","nullable":true,"description":"YYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão."},"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"beneficiario":{"type":"string","nullable":true,"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"valores":{"type":"object","description":"Ausência é `null`, nunca \"0.00\": zero é valor que a operadora declarou.","properties":{"informado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"processado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosa":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}}}},"ResumoDeRetornosSemVinculo":{"type":"object","description":"Quanto está solto, e onde. Não é paginado: somar meia competência daria um total errado.","properties":{"total":{"type":"integer","description":"O total do recorte pedido."},"montante":{"type":"string","description":"Glosa quando há; senão o liberado — o valor em disputa na linha."},"porMotivo":{"type":"array","items":{"type":"object","properties":{"motivo":{"type":"string","description":"O motivo, como a operadora o nomeou."},"linhas":{"type":"integer","description":"Quantas linhas o recorte tem."},"montante":{"type":"string","description":"O montante deste motivo, em reais, decimal em string."}}},"description":"Os mesmos números, abertos por motivo."},"porOperadora":{"type":"array","items":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora, para exibição."},"linhas":{"type":"integer","description":"Quantas linhas o recorte tem."},"montante":{"type":"string","description":"O montante desta operadora, em reais, decimal em string."}}},"description":"Os mesmos números, abertos por operadora."},"porCompetencia":{"type":"array","items":{"type":"object","properties":{"competencia":{"type":"string","nullable":true,"description":"Mês `AAAA-MM` da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos."},"linhas":{"type":"integer","description":"Quantas linhas o recorte tem."},"montante":{"type":"string","description":"O montante deste mês, em reais, decimal em string."}}},"description":"Os mesmos números, abertos por mês de competência."}}},"MotivoDeGlosa":{"type":"object","description":"Um motivo distinto recebido por esta clínica, com quanto custou. Ordenado por valor.","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo. Nulo é o agrupamento de tudo que veio sem código."},"significado":{"type":"string","nullable":true,"description":"Da Tabela 38, ou o texto da categoria quando o motivo veio sem código."},"tipo":{"type":"string","enum":["TABELA_ANS","CODIGO_OPERADORA","CATEGORIA"],"description":"De onde o código vem: a tabela oficial da ANS, a tabela própria da operadora, ou só uma categoria."},"glosas":{"type":"integer","description":"Quantas glosas esta clínica recebeu com este motivo."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"GlosaSilenciosa":{"type":"object","description":"Pagaram a menor e não declararam glosa. Não aparece em relatório de glosa justamente por isso. Medido em produção: 82 guias, R$ 52.198,49.","properties":{"guiaId":{"type":"string","description":"A guia a que este registro se refere, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"executadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando a execução ocorreu, em ISO 8601 com fuso."},"pagoEm":{"type":"string","format":"date","nullable":true,"description":"Data do crédito do pagamento."},"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"diferenca":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"percentual":{"type":"number","nullable":true,"description":"Percentual já calculado, com duas casas. `12.50` é doze e meio por cento."},"situacaoConciliacao":{"type":"integer","description":"0–7. Ver `situacao.codigo` da guia do beneficiário para o significado."}}},"Beneficiario":{"type":"object","description":"O histórico de uma carteirinha nesta clínica. A pergunta que nenhum sistema respondia.","properties":{"carteira":{"type":"string","description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"nome":{"type":"string","nullable":true,"description":"A operadora frequentemente não manda. A carteirinha é a chave; o nome é enriquecimento."},"operadoras":{"type":"array","items":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}}},"description":"As operadoras alcançadas pelo recorte pedido."},"resumo":{"type":"object","description":"O histórico desta carteirinha nesta clínica, somado.","properties":{"guias":{"type":"integer","description":"As guias do documento."},"cobrado":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"liberado":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"glosado":{"type":"object","description":"Dois números, os dois verdade: `declarado` é o que a operadora chamou de glosa; `derivado` é cobrado menos liberado.","properties":{"declarado":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."},"derivado":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"taxaGlosa":{"type":"number","description":"Proporção 0–1 do derivado sobre o cobrado. 0 quando não houve cobrança."},"guiasComGlosaDeclarada":{"type":"integer","description":"Em quantas guias a operadora declarou glosa."},"guiasPagas":{"type":"integer","description":"Em quantas guias já houve crédito declarado."},"primeiraGuia":{"type":"string","format":"date","nullable":true,"description":"Data da primeira guia desta carteirinha aqui."},"ultimaGuia":{"type":"string","format":"date","nullable":true,"description":"Data da guia mais recente desta carteirinha aqui."}}},"glosas":{"type":"object","description":"As glosas desta carteirinha, somadas.","properties":{"total":{"type":"integer","description":"O total do recorte pedido."},"valorTotal":{"type":"string","description":"Decimal em string, duas casas — dinheiro não é number."}}},"alertas":{"type":"array","description":"Sinal medido no histórico desta carteirinha, não previsão de modelo.","items":{"type":"object","properties":{"tipo":{"type":"string","description":"Que sinal é este (ex. taxa de glosa acima da média, guia parada sem retorno)."},"detalhe":{"type":"string","description":"Detalhe em texto livre, para humano. Não é contrato."}}}}}},"BeneficiarioEncontrado":{"type":"object","properties":{"carteira":{"type":"string","description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"nome":{"type":"string","nullable":true,"description":"Nome do beneficiário. A operadora frequentemente não manda — a chave é a carteirinha."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"ultimaGuia":{"type":"string","format":"date","nullable":true,"description":"Data da guia mais recente desta carteirinha, para distinguir homônimos na busca."}}},"GuiaDoBeneficiario":{"type":"object","description":"A guia pelo olhar da conciliação: os valores e o veredito do casamento entre cobrado e pago.","properties":{"guiaId":{"type":"string","description":"A guia a que este registro se refere, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroGuiaPrestador":{"type":"string","description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"lote":{"type":"string","nullable":true,"description":"O número do lote em que esta guia foi enviada."},"protocolo":{"type":"string","nullable":true,"description":"O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois."},"executadoEm":{"type":"string","format":"date","nullable":true,"description":"Quando a execução ocorreu, em ISO 8601 com fuso."},"pagoEm":{"type":"string","format":"date","nullable":true,"description":"Data do crédito do pagamento."},"valores":{"type":"object","description":"Os quatro números da guia. Ausência é `null`, nunca \"0.00\".","properties":{"cobrado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"liberado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"glosado":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"diferenca":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."}}},"conciliacao":{"type":"object","description":"O cruzamento que o Miydas fez entre o cobrado e o pago — não é o que a operadora disse.","properties":{"situacao":{"type":"object","description":"O veredito do motor de conciliação sobre a guia, como código e por extenso.","properties":{"codigo":{"type":"integer","description":"O código do veredito, de 0 a 7. `descricao` traz o mesmo em português — use o código na lógica."},"descricao":{"type":"string","description":"O mesmo estado de `situacao.codigo`, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar."}}},"glosaDeclarada":{"type":"boolean","description":"A operadora declarou glosa. `false` com diferença a menor é glosa silenciosa: cortaram sem dizer."},"direcaoDiferenca":{"type":"string","nullable":true,"description":"A_MENOR | A_MAIOR | null."},"percentualGlosa":{"type":"number","nullable":true,"description":"Quanto da cobrança virou glosa, em percentual com duas casas."},"scoreConfianca":{"type":"number","nullable":true,"description":"O quanto o casamento entre o que foi cobrado e o que foi pago é confiável."},"prioridadeRevisao":{"type":"string","nullable":true,"description":"O quanto esta guia merece atenção humana, combinando valor em jogo e confiança do casamento."}}}}},"GlosaDoBeneficiario":{"type":"object","properties":{"glosaId":{"type":"string","description":"A glosa a que este registro se refere, pelo identificador do Miydas."},"nivel":{"type":"string","description":"Em que nível a glosa pende: `ITEM`, `GUIA` ou `PROTOCOLO`. Medido na base: 56.709 em item, 262 em guia, nenhuma em protocolo — o recurso TISS é item a item, e é no item que a glosa quase sempre mora."},"motivo":{"type":"object","description":"Por que cortaram, na palavra da operadora e no termo oficial.","properties":{"codigo":{"type":"string","nullable":true,"description":"O código do motivo, como a operadora o emitiu."},"significado":{"type":"string","nullable":true,"description":"O termo oficial da Tabela 38 da ANS, quando o código existe nela."},"codigoOperadora":{"type":"string","nullable":true,"description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."},"categoria":{"type":"string","nullable":true,"description":"O agrupamento que a operadora deu ao motivo, quando ela agrupa."}}},"descricao":{"type":"string","nullable":true,"description":"O texto livre que a operadora escreveu sobre esta glosa."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"procedimento":{"type":"object","nullable":true,"properties":{"codigo":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","nullable":true,"description":"Descrição do procedimento, como a fonte a informou."}},"description":"O procedimento a que a linha se refere."},"registradaEm":{"type":"string","format":"date-time","description":"Quando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora."}}},"ElegibilidadeResumida":{"type":"object","description":"Elegibilidade já consultada. Leitura: não fala com a operadora.","properties":{"elegibilidadeId":{"type":"string","description":"A consulta de elegibilidade, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"elegivel":{"type":"boolean","nullable":true,"description":"A operadora respondeu que o beneficiário pode ser atendido."},"alcance":{"type":"string","nullable":true,"description":"CARTEIRINHA | PROCEDIMENTO — até onde a operadora respondeu."},"motivoNaoElegivel":{"type":"string","nullable":true,"description":"O que a operadora respondeu quando negou o atendimento, na língua dela."},"plano":{"type":"string","nullable":true,"description":"Nome do plano do beneficiário na operadora."},"validadeCarteira":{"type":"string","format":"date","nullable":true,"description":"Último dia de validade da carteirinha informado pela operadora."},"consultadaEm":{"type":"string","format":"date-time","description":"Quando a consulta à operadora aconteceu, em ISO 8601 com fuso."}}},"AutorizacaoResumida":{"type":"object","properties":{"autorizacaoId":{"type":"string","description":"A autorização, pelo identificador do Miydas."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."}},"description":"A operadora do documento, identificada pelo registro ANS."},"situacao":{"type":"object","description":"O veredito da operadora sobre a guia, no nosso vocabulário e no dela.","properties":{"codigo":{"type":"string","nullable":true,"description":"O veredito traduzido (`AUTORIZADA`, `NEGADA`, `EM_ANALISE`…). Nulo enquanto ela não respondeu."},"codigoOperadora":{"type":"string","nullable":true,"description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."}}},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"validadeSenha":{"type":"string","format":"date","nullable":true,"description":"Último dia em que a senha de autorização pode ser usada. Passou disso, a guia volta para a fila."},"autorizadaEm":{"type":"string","format":"date","nullable":true,"description":"Quando a operadora autorizou, em ISO 8601 com fuso."},"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"solicitadaEm":{"type":"string","format":"date-time","description":"Quando a solicitação foi feita, em ISO 8601 com fuso."}}},"EloDaLinhaDoTempo":{"type":"object","description":"Um elo com o instante em que o fato ACONTECEU, não em que foi registrado — guia pela execução, pagamento pelo crédito. Elo sem data é omitido em vez de receber data inventada.","properties":{"em":{"type":"string","format":"date-time","description":"Quando este fato foi registrado, em ISO 8601 com fuso."},"tipo":{"type":"string","enum":["GUIA_EXECUTADA","GUIA_PAGA","GLOSA","ELEGIBILIDADE","AUTORIZACAO"],"description":"Que fato é este elo."},"titulo":{"type":"string","description":"O fato em uma linha, pronto para exibir na linha do tempo."},"valor":{"type":"string","nullable":true,"description":"Decimal em string. `null` = a fonte não informou; `\"0.00\"` = informou zero. Os dois são diferentes."},"referencia":{"type":"string","nullable":true,"description":"O número de guia, quando há. Senão o id do recurso."}}},"Autorizacao":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"numeroGuiaPrestador":{"type":"string","nullable":true,"description":"O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui."},"numeroGuiaOperadora":{"type":"string","nullable":true,"description":"O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela."},"processamento":{"$ref":"#/components/schemas/Processamento","description":"O andamento do pedido COM A OPERADORA. Enquanto ele não concluir, a situação abaixo é nula — o recurso existe, a resposta ainda não."},"situacao":{"type":"object","nullable":true,"description":"Nula até a operadora responder. `codigoOperadora` é o que ela mandou.","properties":{"codigo":{"type":"string","enum":["A_ENVIAR","ENVIANDO","EM_ANALISE","AUTORIZADA","PARCIALMENTE_AUTORIZADA","NEGADA","AGUARDANDO_JUSTIFICATIVA","AGUARDANDO_DOCUMENTACAO","CANCELADA","NAO_EXIGE_AUTORIZACAO","INDETERMINADA"],"description":"O veredito traduzido. `NAO_EXIGE_AUTORIZACAO` não é negativa: é a operadora dizendo que o procedimento passa direto."},"descricao":{"type":"string","description":"O mesmo estado de `situacao.codigo`, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar."},"codigoOperadora":{"type":"string","nullable":true,"description":"O código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ."}}},"senha":{"type":"string","nullable":true,"description":"A senha de autorização que a operadora concedeu. É ela que autoriza a execução."},"validadeSenha":{"type":"string","format":"date","nullable":true,"description":"Último dia em que a senha de autorização pode ser usada. Passou disso, a guia volta para a fila."},"dataAutorizacao":{"type":"string","format":"date","nullable":true,"description":"Data em que a operadora autorizou, `AAAA-MM-DD`."},"dataSolicitacao":{"type":"string","format":"date","nullable":true,"description":"O dia em que a autorização foi pedida. É por ele que `de` e `ate` recortam a listagem."},"beneficiario":{"type":"object","properties":{"carteira":{"type":"string","nullable":true,"description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"nome":{"type":"string","nullable":true,"description":"Nome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro."}},"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"solicitante":{"type":"object","nullable":true,"properties":{"nome":{"type":"string","nullable":true,"description":"Nome do profissional solicitante."},"conselho":{"type":"string","description":"Sigla do conselho profissional (`CRM`, `CRO`, `COREN`…)."},"numero":{"type":"string","description":"Número de inscrição do solicitante no conselho."},"uf":{"type":"string","description":"Sigla da unidade federativa, duas letras (ex. `SC`)."},"cbo":{"type":"string","description":"Ocupação do profissional na CBO, seis dígitos."}},"description":"Quem pediu o procedimento."},"pedido":{"type":"object","description":"O que foi pedido, como está gravado agora — e é isto que `PATCH /v1/autorizacoes/{id}` corrige enquanto a guia não foi autorizada. Vem junto porque campo corrigível sem o valor atual ao lado se lê como \"não preenchido\", e quem corrige reescreve por cima do que havia.","properties":{"carater":{"type":"string","nullable":true,"enum":["ELETIVO","URGENCIA"],"description":"Eletivo ou urgência/emergência."},"indicacaoClinica":{"type":"string","nullable":true,"description":"A justificativa clínica do pedido, como foi enviada."},"observacao":{"type":"string","nullable":true,"description":"Observação livre para o auditor da operadora."},"numeroGuiaPrincipal":{"type":"string","nullable":true,"description":"A guia principal, quando esta é continuação de outra."},"coberturaEspecial":{"type":"string","nullable":true,"description":"Cobertura especial (`dm_tipoCoberturaEspecial`): gestante, aidético ou recém-nascido."},"recemNascido":{"type":"boolean","description":"Atendimento a recém-nascido na mesma guia da mãe."},"atendimento":{"type":"object","nullable":true,"description":"Tipo e regime de atendimento e indicação de acidente, nos domínios TISS. `null` quando a operadora não os pede.","properties":{"tipoAtendimento":{"type":"string","description":"Tipo de atendimento (`dm_tipoAtendimento`). Exame de laboratório costuma ser `23`."},"regimeAtendimento":{"type":"string","description":"Regime de atendimento (`dm_regimeAtendimento`): ambulatorial, hospitalar, domiciliar."},"indicacaoAcidente":{"type":"string","description":"Indicação de acidente (`dm_indicacaoAcidente`). `9` é \"não é acidente\"."},"saudeOcupacional":{"type":"string","description":"Tipo de saúde ocupacional (`dm_tipoSaudeOcupacional`), quando o exame é admissional, periódico ou demissional."}}},"portal":{"type":"object","nullable":true,"description":"Campos que só certos portais pedem — CID-10, tempo de doença, data do acidente. `null` quando nenhum foi informado.","properties":{"cid":{"type":"string","description":"CID-10 da hipótese diagnóstica, quando o portal o exige."},"tempoDoenca":{"type":"string","description":"Há quanto tempo o quadro dura, no formato que o portal pede."},"dataAcidente":{"type":"string","description":"O dia do acidente, quando houve (AAAA-MM-DD)."}}}}},"evidencias":{"type":"object","description":"O que existe de PROVA sobre o desfecho — e não as URLs. Os arquivos são privados; os bytes saem por `GET /autorizacoes/{id}/evidencia/{tela|guia}`, que confere a empresa. URL assinada aqui entraria no histórico de toda consulta de lista.","properties":{"tela":{"type":"boolean","description":"Há print do portal no momento em que ele respondeu — autorizada, negada ou erro. Capturado no envio; guias enviadas antes de 20/11/2026 não têm."},"guia":{"type":"boolean","description":"Há o PDF que a própria operadora imprime, baixado no ato da autorização. Só onde o portal oferece impressão nativa."}}},"procedimentos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifica este procedimento. É o que se manda em `refazItem` ao pedir de novo o que foi negado."},"tabela":{"type":"string","nullable":true,"description":"Qual tabela o código usa (`22` = TUSS procedimentos, `00` = tabela própria da operadora). Padrão `22`."},"codigo":{"type":"string","nullable":true,"description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","nullable":true,"description":"Descrição do procedimento, como ela vai no documento."},"quantidadeSolicitada":{"type":"number","nullable":true,"description":"Quantas unidades você pediu."},"quantidadeAutorizada":{"type":"number","nullable":true,"description":"Quantas a operadora liberou. Menor que a solicitada é autorização parcial — execute só o autorizado, ou a diferença vira glosa."},"quantidadeExecutada":{"type":"number","nullable":true,"description":"Quantas foram REALMENTE executadas, quando já se declarou. `null` é \"ainda não declarado\" e `0` é \"conferi e não executei\" — a diferença importa. Item com `quantidadeAutorizada` nula e esta preenchida é exame acrescentado na execução."},"motivos":{"type":"array","items":{"type":"string"},"description":"O que a operadora alegou sobre ESTE procedimento."},"refazItem":{"type":"string","nullable":true,"description":"O `id` do procedimento que este refaz, numa guia anterior. `null` é a primeira tentativa. É por esta cadeia que se sabe quantas vezes o mesmo exame foi pedido."}}},"description":"Os procedimentos do documento."},"motivos":{"type":"array","items":{"type":"string"},"description":"O que a operadora alegou sobre a guia inteira."},"requisicao":{"type":"object","nullable":true,"description":"A requisição que originou a guia. `null` quando ela nasceu direto. `parte`/`partes` respondem \"por que três guias?\" — a operadora limita exames por guia, e a requisição foi dividida.","properties":{"id":{"type":"string","description":"A requisição, para abrir o papel que originou esta guia."},"numero":{"type":"string","description":"O número legível da requisição, do prestador para o prestador (REQ-2026-0412)."},"parte":{"type":"number","nullable":true,"description":"Qual das guias desta requisição é esta. `null` quando a requisição gerou uma só."},"partes":{"type":"number","nullable":true,"description":"Em quantas guias a requisição foi dividida pelo limite de exames da operadora."}}},"proximaAcao":{"type":"object","description":"O que fazer agora com esta guia. Decidido pelo servidor: só ele sabe quantos dias de silêncio deixam de ser normais, o que cada código de negativa significa e se a senha está vencendo. Mostre; não recalcule.","properties":{"codigo":{"type":"string","description":"ENVIAR, CONSULTAR, IMPRIMIR_GUIA, REFAZER_COM_CAPTURA… — para a interface decidir o botão."},"texto":{"type":"string","description":"A frase pronta, escrita para quem está no balcão."},"precisaDeMim":{"type":"boolean","description":"Esta guia espera alguém AGORA. Guia em análise dentro do prazo responde `false` — enchê-la na fila é como se esconde a que precisa."}}},"execucao":{"type":"object","nullable":true,"description":"A execução do exame, nas operadoras que exigem registrá-la depois do atendimento. `null` não afirma que o exame não foi feito: afirma que não foi executado pelo Miydas — pode ter sido registrado à mão no portal da operadora.","properties":{"executada":{"type":"boolean","description":"A operadora registrou o atendimento."},"parcial":{"type":"boolean","description":"Parte do pedido entrou na guia; o resto continua pendente."},"guiaGerada":{"type":"string","nullable":true,"description":"A guia de serviço que a operadora emitiu ao executar — número NOVO, diferente de `numeroGuiaOperadora`, e é ele que o faturamento cobra."},"situacaoOperadora":{"type":"string","nullable":true,"description":"O rótulo que a operadora deu à execução (ex.: \"Executada\")."},"mensagem":{"type":"string","nullable":true,"description":"O que a operadora respondeu à execução, na frase dela — inclusive a recusa, quando houve."},"em":{"type":"string","format":"date-time","nullable":true,"description":"Quando a execução foi registrada."}}},"historico":{"type":"array","description":"O que já se fez com esta guia, em ordem — a solicitação e cada consulta ou cancelamento depois dela.","items":{"type":"object","properties":{"ocorridoEm":{"type":"string","format":"date-time","description":"Quando o fato aconteceu, em ISO 8601 com fuso."},"tipo":{"type":"string","enum":["SOLICITACAO","CONSULTA","CANCELAMENTO"],"description":"Que ação foi esta."}}}},"origem":{"type":"string","enum":["SOLICITACAO","CONSULTA"],"description":"`SOLICITACAO`: a guia nasceu aqui. `CONSULTA`: foi pedida fora do Miydas e importada depois."},"etapa":{"type":"string","enum":["PREVIA","EXECUCAO"],"description":"Como a guia foi pedida: `PREVIA` antes de executar (o caso normal) ou `EXECUCAO` com o exame já feito. Decide se a operadora cobra a confirmação de presença do beneficiário — por isso quem vai transmitir uma guia `A_ENVIAR` precisa saber antes de enviar."},"teste":{"type":"boolean","description":"true: criado por chave de teste (`myd_test_…`), executado na homologação da operadora e visível só para chaves de teste."},"proximaConsultaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando o acompanhamento automático volta a perguntar à operadora. `null` quando a guia não está em acompanhamento — porque já tem desfecho, ou porque ainda não saiu daqui. Serve para não consultar à mão o que o robô já ia consultar."},"consultasAutomaticas":{"type":"number","description":"Quantas vezes o Miydas já reconsultou esta guia por conta própria."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."},"atualizadaEm":{"type":"string","format":"date-time","description":"Quando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso."}}},"Elegibilidade":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"operadora":{"type":"object","properties":{"registroANS":{"type":"string","description":"Registro da operadora na ANS, seis dígitos (ex. `334561`). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora."},"nome":{"type":"string","nullable":true,"description":"Razão social da operadora como a ANS a publica. Informativo — a chave é o registro."}},"description":"A operadora do documento, identificada pelo registro ANS."},"carteira":{"type":"string","description":"Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador."},"processamento":{"$ref":"#/components/schemas/Processamento","description":"O andamento da consulta COM A OPERADORA. Enquanto ele não concluir, `elegivel` é nulo."},"elegivel":{"type":"boolean","nullable":true,"description":"A operadora respondeu que o beneficiário pode ser atendido."},"alcance":{"type":"string","nullable":true,"enum":["CARTEIRINHA","PROCEDIMENTO"],"description":"Até onde a operadora respondeu: pela carteirinha, ou por procedimento."},"beneficiario":{"type":"object","properties":{"nome":{"type":"string","nullable":true,"description":"Nome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro."},"validadeCarteira":{"type":"string","format":"date","nullable":true,"description":"Último dia de validade da carteirinha informado pela operadora."},"plano":{"type":"string","nullable":true,"description":"Nome do plano do beneficiário na operadora."}},"description":"O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica."},"procedimentosPedidos":{"type":"array","items":{"type":"string"},"description":"Os códigos que você perguntou. Devolvidos de volta para que a ausência de um deles em `procedimentos` seja visível: operadora que só responde pela carteirinha não respondeu por procedimento nenhum."},"procedimentos":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do procedimento na tabela declarada."},"descricao":{"type":"string","nullable":true,"description":"Descrição do procedimento, como ela vai no documento."},"elegivel":{"type":"boolean","description":"A operadora cobre ESTE procedimento para este beneficiário."},"motivos":{"type":"array","items":{"type":"string"},"description":"O que ela alegou sobre este procedimento."},"foraDoContrato":{"type":"boolean","description":"Não está no contrato do prestador com a operadora"}}},"description":"Os procedimentos do documento."},"motivos":{"type":"array","items":{"type":"string"},"description":"O que a operadora alegou sobre a elegibilidade como um todo."},"avisos":{"type":"array","items":{"type":"string"},"description":"O que você precisa saber para não ler esta resposta errado — por exemplo, que a operadora respondeu só pela carteirinha."},"teste":{"type":"boolean","description":"true: criado por chave de teste (`myd_test_…`), executado na homologação da operadora e visível só para chaves de teste."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."}}},"Evento":{"type":"object","properties":{"nome":{"type":"string","description":"O nome do evento, no formato `recurso.fato` (ex. `autorizacao.concluida`). É o que se assina."},"recurso":{"type":"string","description":"A que família de recurso este evento pertence — é o prefixo do nome."},"quando":{"type":"string","description":"Em que momento do ciclo este evento é emitido."},"escopoNecessario":{"type":"string","nullable":true,"description":"Escopo que a chave precisa ter para receber"}}},"Assinatura":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"url":{"type":"string","description":"A URL, com esquema."},"eventos":{"type":"array","items":{"type":"string"},"description":"Nomes exatos, `recurso.*` ou `*`"},"descricao":{"type":"string","nullable":true,"description":"Para que serve esta assinatura. É o que distingue uma da outra na lista."},"ativa":{"type":"boolean","description":"A assinatura está recebendo eventos."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."},"atualizadaEm":{"type":"string","format":"date-time","description":"Quando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso."}}},"AssinaturaCriada":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"url":{"type":"string","description":"A URL, com esquema."},"eventos":{"type":"array","items":{"type":"string"},"description":"Nomes exatos, `recurso.*` ou `*`"},"descricao":{"type":"string","nullable":true,"description":"Para que serve esta assinatura. É o que distingue uma da outra na lista."},"ativa":{"type":"boolean","description":"A assinatura está recebendo eventos."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."},"atualizadaEm":{"type":"string","format":"date-time","description":"Quando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso."},"segredo":{"type":"string","description":"Só nesta resposta. Guarde: é com ele que se confere `miydas-assinatura`."}}},"SegredoAssinatura":{"type":"object","description":"O segredo novo depois da troca. O anterior para de valer na hora.","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"segredo":{"type":"string","description":"Só nesta resposta. Guarde: é com ele que se confere o cabeçalho `miydas-assinatura`."}}},"Entrega":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."},"evento":{"type":"string","description":"O nome do evento, no formato `recurso.fato`."},"recurso":{"type":"object","nullable":true,"properties":{"tipo":{"type":"string","description":"Que tipo de recurso o evento descreve (ex. `autorizacao`, `lote`)."},"id":{"type":"string","nullable":true,"description":"Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato."}},"description":"Que tipo de recurso este registro descreve."},"status":{"type":"string","enum":["PENDENTE","ENTREGUE","FALHOU"],"description":"Em que ponto o processamento está."},"tentativas":{"type":"integer","description":"Quantas vezes já tentamos."},"httpStatus":{"type":"integer","nullable":true,"description":"O código HTTP que o seu endpoint devolveu na entrega."},"erro":{"type":"string","nullable":true,"description":"O que falhou. `null` quando não falhou nada."},"criadaEm":{"type":"string","format":"date-time","description":"Quando o registro nasceu no Miydas, em ISO 8601 com fuso."},"entregueEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando a entrega do evento foi aceita pelo seu endpoint, em ISO 8601 com fuso."},"proximaTentativaEm":{"type":"string","format":"date-time","nullable":true,"description":"Quando sai a próxima tentativa de entrega. `null` = não há outra."}}},"ResultadoTeste":{"type":"object","properties":{"entrega":{"type":"string","description":"O id da entrega de teste — acompanhe por ele em `/assinaturas/{id}/entregas`."},"entregue":{"type":"boolean","description":"O seu endpoint aceitou (2xx). `false` com `httpStatus` nulo = não respondeu a tempo."},"httpStatus":{"type":"integer","nullable":true,"description":"O código HTTP que o seu endpoint devolveu na entrega."},"erro":{"type":"string","nullable":true,"description":"O que falhou. `null` quando não falhou nada."}}}},"responses":{"NaoAutenticado":{"description":"Chave ausente, inválida ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CHAVE_INVALIDA","message":"Chave de API inválida"}}}},"EscopoInsuficiente":{"description":"A chave não tem o escopo exigido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"ESCOPO_INSUFICIENTE","message":"Esta chave não tem permissão para esta operação"}}}},"PedidoInvalido":{"description":"Pedido recusado antes de chamar a operadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"VALIDATION_ERROR","message":"Pedido inválido — veja os campos em details.campos","details":{"campos":[{"campo":"carteira","erro":"Required"}]}}}}}}},"security":[{"chaveApi":[]}],"x-escopos":{"operadora:ler":"Ver operadoras atendidas, conectores e capacidades","execucao:ler":"Acompanhar execuções e seus resultados","conexao:ler":"Ver conexões configuradas e a saúde delas","convenio:ler":"Ver o catálogo de operadoras e os convênios habilitados","elegibilidade:executar":"Consultar elegibilidade de beneficiário","elegibilidade:ler":"Ler elegibilidades já feitas","webhook:gerenciar":"Assinar eventos (webhooks)","utilizacao:ler":"Consultar histórico de atendimentos do beneficiário — inclui atendimentos feitos em outros prestadores da operadora","autorizacao:ler":"Consultar situação de autorização","lote:ler":"Ver lotes de faturamento e a situação de protocolos","lote:gerenciar":"Montar lotes de faturamento — sem transmitir","retorno:ler":"Buscar demonstrativos e retornos","retencao:ler":"Ver imposto retido pela operadora — ISS, PIS, INSS, COFINS","glosa:ler":"Ver glosas com o significado oficial da ANS, resumo e motivos","guia:ler":"Ver a guia pelas três camadas — envio, análise e pagamento — e a procedência de cada número","beneficiario:ler":"Ver o histórico de uma carteirinha — guias, glosas, elegibilidades e autorizações. Expõe dado de paciente identificado: conceder é decisão, não padrão","recurso:ler":"Consultar situação de recurso de glosa","credencial:verificar":"Testar credenciais de uma conexão","faturavel:ler":"Ver o que o laboratório realizou e ainda não cobrou","autorizacao:executar":"Solicitar autorização de procedimento","lote:enviar":"Enviar lote de faturamento","guia:cancelar":"Cancelar guia ou lote","recurso:enviar":"Enviar recurso contra glosas","anexo:enviar":"Enviar anexos","faturavel:registrar":"Mandar ao Miydas os exames realizados, para conferir antes de faturar","documento:enviar":"Enviar laudo, pedido ou comprovante","comunicacao:enviar":"Comunicar internação ou alta","conexao:gerenciar":"Criar conexão e gravar credenciais de portal","convenio:gerenciar":"Habilitar operadora para a clínica"}}