Ogmma Revenue

Objetos da resposta

O que cada campo é, e não só de que tipo ele é. Todo campo tem definição — é verificado por teste na API, e campo sem definição não entra no contrato.

Dinheiro vem como string decimal com duas casas, nunca como número. Ausência é null, nunca "0.00": zero é um valor que a operadora declarou, e tratá-los igual é como se perde glosa de vista.

Paginacao

Onde esta página está dentro do total. Vem ao lado de data, fora dele.

CampoTipoO que é
totalinteiroQuantos registros existem no filtro pedido — não quantos vieram nesta página.
limiteinteiroO teto aplicado nesta resposta, seja o que você pediu ou o padrão da rota.
deslocamentointeiroQuantos registros foram pulados para chegar nesta página.
temMaisbooleanoHá página seguinte. Equivale a deslocamento + itens < total, já calculado.

LeituraDeArquivo

O resultado de ler um arquivo. Nada foi gravado: o acervo e GET /v1/demonstrativos.

Devolvido por:POST /v1/demonstrativos/leituras

CampoTipoO que é
arquivoobjetoO arquivo de onde o dado veio.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
formatotexto
um de: XML, ZIP
O involucro. Num ZIP, cada XML interno foi lido.
bytesinteiroTamanho do arquivo recebido.
demonstrativoslista de objetosUm por documento encontrado no arquivo. Um ZIP com varios XML devolve varios; um XML, normalmente um.
tipotexto
um de: ANALISE, PAGAMENTO
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.
numeroDemonstrativotextoO 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.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
competenciatextoYYYY-MM, como o documento a declara.
operadoratextoO nome da operadora como o documento o escreve — nao e o catalogo ANS.
emitidoEmtextoData que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download.
creditoEmtextoData do credito. So em documento de pagamento.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
valorPagotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
guiaslista de objetosAs guias do documento.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
beneficiariotextoO 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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
atendimentoEmtextoData de realizacao do atendimento, como o documento a declara.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de objetosGlosas de nivel GUIA — as de item estao em itens[].glosas.
codigotextoCodigo da glosa na tabela 38 do TISS, como o documento o trouxe.
descricaotextoO significado do codigo. Preenchido da tabela 38 quando o documento manda so o codigo.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
itenslista de objetosProcedimentos e despesas da guia, como o documento os lista.
tipotexto
um de: PROCEDIMENTO, DESPESA
PROCEDIMENTO: a tabela de procedimentos. DESPESA: material, medicamento, taxa, diaria, OPME.
sequencialtextoA ordem do registro dentro do documento, como a operadora a numerou.
codigoProcedimentotextoCódigo do procedimento na tabela declarada em codigoTabela.
codigoDespesatextoSo em item de despesa.
descricaotextoDescrição do item, como a fonte a informou.
quantidadetextoQuantas 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.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de objetosAs glosas deste item — o nivel em que o recurso e montado, porque no TISS ele e item a item.
codigotextoCodigo da glosa na tabela 38 do TISS, como o documento o trouxe.
descricaotextoO significado do codigo. Preenchido da tabela 38 quando o documento manda so o codigo.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liquidacaoobjetoO 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".
totalDebitostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totalCreditostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
lancamentoslista de objetosLinha a linha do que foi descontado e somado ao credito.
naturezatexto
um de: DEBITO, CREDITO
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.
tipotextoO codigo do tipo de debito ou credito, como a operadora o declara.
descricaotextoO texto do lancamento (ex. "IRPJ Prod Medica").
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
avisoslista de textoVazio 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

Andamento com a operadora. CONCLUIDO = a operadora respondeu; o desfecho está no recurso.

CampoTipoO que é
statustexto
um de: PENDENTE, PROCESSANDO, CONCLUIDO, FALHOU
Em que ponto o processamento está.
iniciadoEmtextoQuando o processamento começou, em ISO 8601 com fuso.
concluidoEmtextoQuando o processamento terminou, em ISO 8601 com fuso. null = ainda corre.
erroobjetoO que falhou. null quando não falhou nada.
errortextoCódigo estável do erro, feito para lógica. É o contrato — a mensagem não é.
messagetextoO erro em português, para humano. Pode mudar sem aviso.
podeRepetirbooleanoRepetir o mesmo pedido pode dar outro resultado. false = o erro é definitivo, corrija antes.

Lote

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.

Devolvido por:POST /v1/lotesGET /v1/lotesGET /v1/lotes/{id}POST /v1/lotes/{id}/enviosPOST /v1/lotes/{id}/resolucoes

CampoTipoO que é
idtextoIdentificador 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.
referenciaExternatextoO id do lote no seu sistema. Chave de idempotência.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
competenciatextoYYYY-MM
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
situacaoobjetoA TRANSMISSÃO: o lote chegou à operadora e ganhou protocolo? Não diz o que a operadora achou do conteúdo — isso é processamento.
codigotexto
um de: PRONTO, INVALIDO, TRANSMITIDO, TRANSMITINDO, RECUSADO, INDETERMINADO
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.
descricaotextoO mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar.
podeEnviarbooleanoEste lote pode ser transmitido agora. false em lote já transmitido, inválido ou indeterminado.
processamentoobjetoO 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.
codigotexto
um de: PROCESSANDO, ACEITO, REJEITADO
O veredito sobre o conteúdo. REJEITADO com situacao TRANSMITIDO é caso real: chegou, foi protocolado, e nenhuma conta passou.
descricaotextoO mesmo estado de processamento.codigo, em português, para mostrar a gente. O contrato é o código.
acaotextoO que fazer agora. Em REJEITADO: corrigir e gerar lote NOVO, nunca retransmitir este.
motivotextoO motivo na língua da operadora (ex. "CM104 - NUMERO DE GUIA INVALIDO").
emtextoQuando soubemos do julgamento.
conformidadeobjetoVeredito do esquema oficial da ANS. Lote inválido é recusado na transmissão.
xsdValidobooleanoO documento passou no esquema oficial da ANS (XSD). Lote inválido é recusado antes de ir à operadora.
erros—O que falhou, item por item.
totaisobjetoOs totais do documento, já somados.
guiasinteiroQuantas guias o lote leva.
procedimentosinteiroQuantas linhas de procedimento o lote leva, somando todas as guias.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
transmitidoEmtextoQuando o lote foi transmitido à operadora, em ISO 8601 com fuso.
ultimoErrotextoTexto para humano. O contrato é o código do erro, não esta frase.
criadoEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.

Retencao

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.

Devolvido por:GET /v1/retencoes/demonstrativosGET /v1/retencoes/{demonstrativoId}

CampoTipoO que é
demonstrativoIdtextoO demonstrativo a que este registro pertence, pelo identificador do Miydas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
numeroDemonstrativotextoO 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.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão.
fonteCompetenciatexto
um de: CREDITO, AUSENTE
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.
emitidoEmtextoData que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download.
creditoEmtextoData do primeiro crédito do demonstrativo. Vários créditos é caso real.
totaltextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
decomposicaoobjetoNulo quando a operadora mandou só o total (405 de 2.915 medidos).
isstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
pistextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
irtextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
insstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
cofinstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
outrostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
naoMapeadosobjetoTributo 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.
conferenciaobjetoConfere o total declarado contra a soma dos quatro tributos. Nulo quando falta um dos lados.
somaDosTributostextoDecimal em string, duas casas — dinheiro não é number.
conferebooleanofalse = 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.
valorLiquidoDoDemonstrativotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

RetencaoConsolidada

O consolidado fiscal do recorte pedido, com o que NÃO fecha declarado em semDecomposicao e divergencias.

Devolvido por:GET /v1/retencoes

CampoTipoO que é
competenciatextoO recorte pedido. Nulo = todas as competências.
recorteobjetoO 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.
registroANStextoRegistro 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.
demonstrativosinteiroQuantos demonstrativos entraram neste consolidado.
totaltextoDecimal em string, duas casas — dinheiro não é number.
porTributoobjetoTributos 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.
isstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
pistextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
irtextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
insstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
cofinstextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
outrostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
naoMapeadosobjetoTributo 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.
semDecomposicaoobjetoQuanto do total chegou sem abertura por tributo. Não lance isto como ISS.
demonstrativosinteiroQuantos vieram só com o total, sem abertura por tributo.
totaltextoDecimal em string, duas casas — dinheiro não é number.
divergenciasinteiroDemonstrativos em que o total declarado não bate com a soma dos tributos.
porOperadoralista de objetosOs mesmos números, abertos por operadora.
registroANStextoRegistro 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.
nometextoRazão social da operadora, para exibição.
demonstrativosinteiroQuantos demonstrativos desta operadora entram no total.
totaltextoDecimal em string, duas casas — dinheiro não é number.
porCompetencialista de objetosOs mesmos números, abertos por mês de competência.
competenciatextoMê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.
demonstrativosinteiroQuantos demonstrativos deste mês entram no total.
totaltextoDecimal em string, duas casas — dinheiro não é number.

Glosa

Uma glosa, no nível em que a operadora a declarou, com o significado oficial do motivo.

Devolvido por:GET /v1/glosasGET /v1/glosas/{id}

CampoTipoO que é
idtextoIdentificador 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.
niveltexto
um de: PROTOCOLO, GUIA, ITEM
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.
motivoobjetoO motivo como a operadora o deu. significado vem da Tabela 38 da ANS quando o código existe lá.
codigotextoO código do motivo, como a operadora o emitiu.
significadotextoTermo oficial da Tabela 38. Nulo quando o código não existe na tabela.
tipotexto
um de: TABELA_ANS, CODIGO_OPERADORA, CATEGORIA, TEXTO_LIVRE, NENHUM
Derivado do que está presente, não do campo tipoMotivo do banco — que está nulo em 93 % das linhas.
tipoDeclaradotextoO que o parser gravou em tipoMotivo. Para auditar o parser, não para decidir.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
categoriatextoO 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.
notaAuditortextoArgumento do auditor da operadora. Insumo direto de recurso.
descricaotextoO texto livre que a operadora escreveu sobre esta glosa, além do motivo codificado.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
guiaobjetoA guia a que este registro pertence.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
beneficiariotextoO 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.
itemobjetoO 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.
codigoTabelatextoQual tabela o código usa (22 = TUSS procedimentos, 18/19/20 = materiais, taxas e medicamentos, 00 = tabela própria da operadora).
codigoProcedimentotextoCódigo do procedimento na tabela declarada em codigoTabela.
descricaotextoA descrição do procedimento glosado, como o documento a trouxe.
evidenciaobjetoO documento de onde a glosa saiu, com até onde ele veio.
demonstrativoIdtextoO demonstrativo a que este registro pertence, pelo identificador do Miydas.
emitidoEmtextoQuando NÓS recebemos o documento — o portal o renderiza no download.
protocoloEmtextoA data de negócio do protocolo, de onde sai a competência.
fonteOrdeminteiroQual arquivo do demonstrativo composto trouxe esta glosa.
completudetextoFULL | ACCEPTED_ONLY | GLOSA_ONLY — o que o conjunto de arquivos permite afirmar.
profundidadetextoAté onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item.
registradaEmtextoQuando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora.

ResumoDeGlosas

O retrato agregado do recorte: quanto, em que nível, e quanto veio sem motivo.

Devolvido por:GET /v1/glosas/resumo

CampoTipoO que é
recorteobjetoO 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.
registroANStextoRegistro 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.
competenciatextoMê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.
glosasinteiroQuantas glosas no recorte.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
comSignificadoOficialobjetoQuantas têm código que existe na Tabela 38. proporcao é 0–1, não percentual.
glosasinteiroQuantas trazem código que existe na Tabela 38 da ANS.
proporcaonúmeroA fração delas sobre o total, de 0 a 1. 0.62 é 62% — não é percentual.
semCodigoobjetoA operadora cortou e não disse por quê. Material de recurso.
glosasinteiroQuantas vieram sem motivo codificado.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
porNivellista de objetosOs mesmos números, abertos pelo nível em que a glosa pende.
niveltextoO nível em que a glosa pende: ITEM, GUIA ou PROTOCOLO.
glosasinteiroQuantas glosas pendem deste nível.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
maioresPorValorlista de objetosOs motivos que mais custaram, do mais caro para o mais barato. É por onde se começa a recorrer.
codigotextoO código do motivo. Nulo agrupa tudo que veio sem código.
significadotextoO termo da Tabela 38, quando o código existe nela.
glosasinteiroQuantas glosas têm este motivo.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.

Demonstrativo

O retorno da operadora como acervo: um documento de análise de conta ou de pagamento.

Devolvido por:GET /v1/demonstrativos

CampoTipoO que é
idtextoIdentificador 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.
tipotexto
um de: ANALISE, PAGAMENTO
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.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
numeroDemonstrativotextoO 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.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão.
creditoEmtextoData do crédito. Só em documento de pagamento.
emitidoEmtextoQuando NÓS recebemos o documento — o portal o renderiza no download.
completudetextoFULL | 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.
profundidadetextoAté onde a fonte desce: A (item + motivo) · B (item) · C (guia) · D (protocolo) · E (overlay) · F (só o fechamento financeiro).
versaoTisstextoVersão do padrão TISS do documento (ex. 4.01.00). Quem dita a versão é a operadora.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
protocolosinteiroQuantos protocolos o documento cobre. A lista deles vem no detalhe.
guiasinteiroQuantas guias o documento cobre. A lista delas vem no detalhe.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.

DemonstrativoDetalhado

O documento inteiro: protocolos, guias e glosas — e a liquidação, quando é documento de pagamento.

Devolvido por:GET /v1/demonstrativos/{id}

CampoTipoO que é
idtextoIdentificador 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.
tipotexto
um de: ANALISE, PAGAMENTO
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.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
numeroDemonstrativotextoO 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.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão.
creditoEmtextoData em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele.
emitidoEmtextoData que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download.
completudetextoFULL | 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.
profundidadetextoAté onde a fonte desce: A (item + motivo) · B (item) · C (guia) · D (protocolo) · E (overlay) · F (só o fechamento financeiro).
versaoTisstextoVersão do padrão TISS do documento (ex. 4.01.00). Quem dita a versão é a operadora.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
guiasinteiroTotal de guias do documento, inclusive as que a paginação não trouxe.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
avisoslista de textoO que impede ler este documento errado — por exemplo, que um GLOSA_ONLY não declara o cobrado.
fonteslista de objetosOs 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.
origemtexto
um de: ARQUIVO, MENSAGEM_TISS
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.
papeltextoACCEPTED (só o aceito) | GLOSA (só o recusado) | FULL (o documento inteiro).
ordeminteiroA posição deste registro na sequência, a partir de 1.
arquivoobjetoO arquivo de onde o dado veio.
idtextoO id a passar em /demonstrativos/{id}/arquivos/{arquivoId}.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoO invólucro. formato é o que conseguimos ler dele.
formatotextoEm que formato o dado chegou.
tamanhoBytesinteiroTamanho do arquivo em bytes.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
protocoloslista de objetosOs protocolos que este documento cobre.
numeroProtocolotextoO número do protocolo na operadora.
numeroLotePrestadortextoO número que o prestador deu ao lote no arquivo enviado.
dataProtocolotextoA data do protocolo na operadora — a data de NEGÓCIO do documento de análise, e a que define a competência.
situacaotextoO estado do protocolo na língua da operadora, sem tradução.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de GlosaGlosas de nível PROTOCOLO. Não são distribuídas pelas guias: o documento não as atribuiu.
guiaslista de objetosAs guias do documento.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
beneficiariotextoO 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.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
situacaotextoO estado da guia na língua da operadora, sem tradução — cada uma tem o seu vocabulário.
atendimentoDetextoPrimeiro dia do atendimento coberto pela guia.
atendimentoAtetextoÚltimo dia do atendimento coberto pela guia. Igual a atendimentoDe quando foi um dia só.
fonteOrdeminteiroQual dos arquivos do demonstrativo composto trouxe esta guia. Cruze com fontes[].ordem.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de GlosaAs glosas desta guia dentro deste documento.
totalDeGuiasinteiroQuantas guias o protocolo tem ao todo — inclusive as que o teto de 200 por resposta não trouxe.
temMaisGuiasbooleanoO protocolo tem mais guias do que o teto de 200 por resposta.
liquidacaolista de objetosO fechamento financeiro, UMA ENTRADA POR DATA DE CRÉDITO. Só em documento de pagamento; vazio na análise.
creditoEmtextoData em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele.
formatextoComo o dinheiro foi pago, como a operadora declarou (ex. crédito em conta).
bancotextoBanco do crédito, como o documento o informa.
agenciatextoAgência do crédito, como o documento a informa.
contatextoConta do crédito, como o documento a informa.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
debitoslista de objetosO que foi descontado do crédito do dia: impostos, taxas, acertos de período anterior.
tipotextoA natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior).
subtipotextoO detalhamento do tipo, quando a operadora o abre.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
creditoslista de objetosO que foi somado ao crédito do dia, fora as guias.
tipotextoA natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior).
subtipotextoO detalhamento do tipo, quando a operadora o abre.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totalDebitostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totalCreditostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liquidotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

Guia

A guia pelas três camadas que a atravessam: envio, análise e pagamento.

Devolvido por:GET /v1/guiasGET /v1/guias/{id}

CampoTipoO que é
idtextoIdentificador 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.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
numeroProtocolotextoO número do protocolo na operadora.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
beneficiariotextoO 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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
dataExecucaotextoData em que o procedimento foi executado, AAAA-MM-DD.
creditoEmtextoData em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele.
camadasobjetoQuais 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".
enviobooleanoO lote saiu daqui. Falso em 40.746 das 40.760 guias — o portal devolve julgamento, não o arquivo enviado.
analisebooleanoExiste documento de análise para esta guia — a operadora já julgou a conta.
pagamentobooleanoExiste documento de pagamento — ela já declarou o crédito. Sem esta camada, pago é nulo.
completudeAnalisetextoA completude do documento de análise que chegou. Num GLOSA_ONLY, o cobrado e o liberado não vieram — não são zero.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
cobradoDaOperadorabooleanoSem envio, o cobrado é a palavra da operadora — a única testemunha que sobrou.
processadotextoO que a operadora reconheceu como devido.
liberadotextoO que ela aceitou pagar — julgamento da análise.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
pagotextoO que o demonstrativo de PAGAMENTO declara. Nulo enquanto essa camada não existir.
diferencatextocobrado − liberado. Nulo quando um dos lados falta: indeterminada não é zero.
divergenciaPagamentotextopago − liberado. Positivo = pagou mais.
situacaoPagamentoobjetoDERIVADA de pago × liberado. A coluna statusPagamento está nula em 39.131 de 39.131 linhas.
codigotexto
um de: PAGO_INTEGRAL, PAGO_PARCIAL, PAGO_A_MAIOR, NAO_PAGO
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.
descricaotextoO mesmo veredito em português, para exibir.
pagamentosinteiroQuantas datas de crédito somaram em pago. >1 merece conferência.
temGlosaDeclaradabooleanoA operadora declarou glosa nesta guia. Diferente de ter pago a menor sem declarar — isso é glosa silenciosa.
motivoslista de objetosOs motivos de glosa que pesam sobre esta guia, somando os do nível da guia e os dos itens dela.
codigotextoO código do motivo, como a operadora o emitiu. Na glosa, é o código da Tabela 38 da ANS quando ela usa o oficial.
descricaotextoO motivo em texto, na língua da operadora — não traduzido.
origemtextoDe que nível o motivo veio: GUIA ou ITEM.
itensobjetoQuantas linhas cada lado tem. Números diferentes já indicam divergência antes de abrir os itens.
enviointeiroQuantos itens saíram daqui. Nulo quando não há camada de envio.
retornointeiroQuantos itens a operadora devolveu.

ItemDoDemonstrativo

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.

Devolvido por:GET /v1/demonstrativos/{id}/itens

CampoTipoO que é
idtextoIdentificador 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.
guiaobjetoA guia a que este registro pertence.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
beneficiariotextoO 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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tipotextoPROCEDIMENTO | DESPESA (material, medicamento, taxa).
procedimentoobjetoO procedimento a que a linha se refere.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoO que a operadora escreveu.
termoOficialtextoO termo da TUSS. Divergir do anterior é informação, não erro.
despesaobjetoSó em item do tipo DESPESA: procedimento não tem código de despesa nem registro ANVISA.
codigotextoCódigo do material, medicamento ou taxa na tabela declarada.
registroANVISAtextoRegistro do produto na ANVISA, quando a linha é material ou medicamento.
grauParticipacaotextoO papel do profissional no procedimento, no código TISS (ex. 00 = cirurgião).
unidadeMedidatextoUnidade 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.
realizadoEmtextoQuando o procedimento foi realizado.
quantidadetextoQuantas 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.
valorUnitariotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
valoresobjetoA glosa é a SOMA das glosas do item — não há coluna de glosa no item, a recusa mora na tabela de glosas.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totaltextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
fonteOrdeminteiroQual dos arquivos do demonstrativo composto trouxe esta linha. Cruze com fontes[].ordem do detalhe.
motivoslista de objetosPor 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.
codigotextoO código do motivo, como a operadora o emitiu. Na glosa, é o código da Tabela 38 da ANS quando ela usa o oficial.
significadotextoO termo oficial da Tabela 38 da ANS, quando o código existe nela.
tipotexto
um de: TABELA_ANS, CODIGO_OPERADORA, CATEGORIA, TEXTO_LIVRE, NENHUM
Que espécie de motivo é este, derivado do que veio preenchido. NENHUM = cortaram sem dizer por quê.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
categoriatextoO agrupamento que a operadora deu ao motivo, quando ela agrupa.
notaAuditortextoO argumento do auditor. Insumo direto do recurso.
descricaotextoO motivo em texto, na língua da operadora — não traduzido.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

ItemConciliado

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.

Devolvido por:GET /v1/guias/{id}/itens

CampoTipoO que é
idtextoIdentificador 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.
chavetextoA chave que casou os dois lados: operadora + guia + código.
tipoDeMatchtextoComo 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.
envioobjetoNulo é o caso dominante: o portal devolve julgamento, não o arquivo que o prestador mandou.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tipotextoNatureza da linha enviada: PROCEDIMENTO ou DESPESA.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoO código que VOCÊ cobrou.
descricaotextoA descrição que você enviou. Compare com a da análise: operadora que renomeia costuma ter traduzido para o código dela.
quantidadetextoQuantas 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.
valorUnitariotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
executadoEmtextoQuando a execução ocorreu, em ISO 8601 com fuso.
analiseobjetoNulo quando o item saiu daqui e a operadora não o mencionou.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoO código que a OPERADORA devolveu. Diferente do enviado quando ela traduziu para a tabela dela.
descricaotextoA descrição que a operadora devolveu.
quantidadetextoQuantas 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.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
realizadoEmtextoQuando o procedimento foi realizado.
pagamentoobjetoVem da GUIA de pagamento: o demonstrativo de pagamento desce até a guia em 2.929 de 2.929 documentos, nunca até o item.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
diferencatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
splitobjetoA operadora quebrou o item em dois — liberou parte da quantidade.
detectadobooleanoA operadora liberou parte da quantidade e cortou o resto, quebrando a linha em duas.
detalhetextoDetalhe em texto livre, para humano. Não é contrato.
decisaoobjetoDo faturista, não da operadora: ACEITA | EM_RECURSO. A glosa mora no item, e o recurso TISS é item a item.
valortextoValor em reais, decimal em string com duas casas — dinheiro não trafega como number.
emtextoQuando este fato foi registrado, em ISO 8601 com fuso.
notatextoA nota escrita por quem registrou o fato — fica no histórico do recurso.

TermoTuss

Um termo da terminologia TUSS. Por padrão só o vigente: código revogado numa guia é recusa certa.

Devolvido por:GET /v1/referencias/tuss

CampoTipoO que é
codigotextoO código do termo na tabela. Único dentro da tabela, não entre tabelas.
termotextoO termo como a tabela oficial o nomeia.
descricaoDetalhadatextoA descrição longa do termo, quando a tabela oficial traz uma.
tabelainteiro22 = procedimentos · 38 = motivos de glosa · 19/20 = materiais e medicamentos.
tipoDaTabelatextoA tabela TUSS de onde o termo vem, pelo número oficial da ANS.
vigenteDetextoPrimeiro dia em que o termo vale na tabela oficial.
vigenteAtetextoNulo = vigente. Preenchido no passado = revogado.
apresentacaotextoComo o produto se apresenta (ex. frasco 10 ml). Só em material e medicamento.
fabricantetextoFabricante do produto. Só em material e medicamento.
registroANVISAtextoRegistro do produto na ANVISA, quando a linha é material ou medicamento.
portetextoO porte do procedimento na tabela, quando ela o classifica — entra no cálculo de honorário.
capitulotextoO capítulo da tabela a que o termo pertence.
grupotextoO grupo dentro do capítulo.

OperadoraAns

Operadora registrada na ANS. É aqui que se acha o registroANS a partir do CNPJ ou do nome.

Devolvido por:GET /v1/referencias/operadoras-ans

CampoTipoO que é
registroANStextoRegistro 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.
cnpjtextoCNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.
razaoSocialtextoRazão social, como consta no cadastro público.
nomeFantasiatextoNome fantasia, quando o cadastro informa.
modalidadetextoA natureza da operadora na classificação da ANS (ex. cooperativa médica, medicina de grupo, seguradora).
cidadetextoMunicípio, por extenso.
uftextoSigla da unidade federativa, duas letras (ex. SC).
registradaEmtextoQuando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora.

EstabelecimentoCnes

Estabelecimento de saúde no CNES — o código que a guia TISS exige do prestador.

Devolvido por:GET /v1/referencias/cnes

CampoTipoO que é
codigoCNEStextoCódigo do estabelecimento no CNES, sete dígitos.
cnpjtextoCNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.
razaoSocialtextoRazão social, como consta no cadastro público.
nomeFantasiatextoNome fantasia, quando o cadastro informa.
tipoUnidadeobjetoA espécie de estabelecimento na classificação do CNES.
codigointeiroO código do tipo no CNES (7 = hospital geral, 22 = clínica especializada, 39 = SADT).
descricaotextoO tipo por extenso.
cidadetextoMunicípio, por extenso.
codigoMunicipioIBGEtextoCódigo do município no IBGE, sete dígitos.
uftextoSigla da unidade federativa, duas letras (ex. SC).

DocumentoRecebido

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

Devolvido por:GET /v1/documentos-recebidosGET /v1/documentos-recebidos/{id}

CampoTipoO que é
idtextoIdentificador 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.
nomeArquivotextoO nome do arquivo como a fonte o nomeou.
extensaotextoO invólucro. formato é o que conseguimos ler dele.
formatotextoEm que formato o dado chegou.
tipoDocumentotextoO 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.
tamanhoBytesinteiroTamanho do arquivo em bytes.
situacaoobjetoQuatro valores públicos sobre quinze estados internos: a esteira é nossa, a pergunta é sua.
codigotexto
um de: EM_ANDAMENTO, PROCESSADO, PENDENTE, FALHOU
PROCESSADO virou dado consultável. PENDENTE parou esperando gente. FALHOU quebrou. Os dois últimos somam parados no resumo.
descricaotextoO mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar.
estadoInternotextoNão é contrato — pode mudar. É o que o suporte pede quando algo trava.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
competenciatextoMê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.
recebidoEmtextoQuando o arquivo chegou ao Miydas, em ISO 8601 com fuso.
processadoEmtextoQuando o arquivo virou dado consultável, em ISO 8601 com fuso. null = ainda não virou.
totaisobjetoO que o leitor extraiu. Nulo em documento que não virou dado.
guiasinteiroAs guias do documento.
itensinteiroQuantas linhas de item o leitor extraiu do documento.
faturadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
pagotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
confiancanúmeroQuanto o identificador confiou no palpite, de 0 a 1.
errotextoPrefixado pela FASE em que parou: triagem, processamento ou distribuição.
avisos—Avisos do leitor, no formato que o handler produziu.

ResumoDeDocumentos

De tudo que chegou, quanto virou dado — e quanto parou.

Devolvido por:GET /v1/documentos-recebidos/resumo

CampoTipoO que é
totalinteiroO total do recorte pedido.
paradosinteiroPENDENTE + FALHOU: chegou e não virou dado. É o número que importa.
porSituacaolista de objetosOs mesmos números, abertos por situação.
situacaotextoA situação, no código que a rota devolve.
documentosinteiroQuantos documentos estão nesta situação.
porEstadoInternolista de objetosA mesma contagem pelos quinze estados da nossa esteira. Não é contrato — serve para pedir suporte sabendo onde parou.
estadoInternotextoO estado da esteira interna. Pode mudar sem aviso.
documentosinteiroQuantos documentos estão neste estado interno.

PassosDaExecucao

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.

Devolvido por:GET /v1/execucoes/{id}/passos

CampoTipoO que é
execucaoIdtextoA execução que produziu este registro, pelo identificador do Miydas.
tentativasinteiroQuantas execuções a cadeia tem: a raiz mais as retentativas.
passoslista de objetosA 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.
tentativainteiroQual tentativa produziu este passo.
numerointeiroA ordem do passo dentro da tentativa, a partir de 1.
nometextoO que o passo faz, em uma linha (ex. login, buscar documento, baixar).
tipotextoA categoria do passo — navegação, requisição, extração.
situacaotexto
um de: PENDING, RUNNING, SUCCESS, FAILED, SKIPPED
Como este passo terminou. O primeiro FAILED da lista é onde a execução realmente parou.
iniciadoEmtextoQuando o processamento começou, em ISO 8601 com fuso.
concluidoEmtextoQuando o processamento terminou, em ISO 8601 com fuso. null = ainda corre.
duracaoMsinteiroQuanto durou, em milissegundos.
errotextoO que falhou. null quando não falhou nada.

CodigoDaOperadora

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.

Devolvido por:GET /v1/operadoras/{registroANS}/codigos

CampoTipoO que é
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
codigoTusstextoCódigo do procedimento na TUSS, a terminologia da ANS.
descricaotextoA descrição que acompanha o código nos retornos da operadora.
origemtextoDERIVADO = observado nos retornos, não declarado pela operadora.
ocorrenciasinteiroQuantas vezes o par apareceu. Com 1, é palpite; com 40, é fato. O número sai para você decidir.

DocumentosDaOperadora

O que a operadora publica, e se conseguimos ler.

Devolvido por:GET /v1/operadoras/{registroANS}/documentos

CampoTipoO que é
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
documentoslista de objetosO que esta operadora publica — e, em cada um, se já sabemos traduzir.
nometextoComo a operadora chama o documento no portal dela.
tipoDocumentotextoPara que tipo nosso ele mapeia (ex. DEMONSTRATIVO_PAGAMENTO).
formatotextoEm que formato o dado chegou.
periodicidadetextoDe quanto em quanto tempo ela publica, quando há regra (ex. mensal, quinzenal).
leituratextoNAO_IMPLEMENTADO = a operadora publica e ainda não traduzimos: o documento chega e para na caixa de entrada como PENDENTE.

LoteImportado

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.

Devolvido por:GET /v1/lotes-importados

CampoTipoO que é
idtextoIdentificador 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.
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
competenciatextoMê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.
tipoGuiatextoTipo de guia TISS: SP_SADT, CONSULTA, RESUMO_INTERNACAO, HONORARIO.
versaoTisstextoVersão do padrão TISS do documento (ex. 4.01.00). Quem dita a versão é a operadora.
origemtextoIMPORTADO (veio de arquivo) | GERADO (montado aqui).
situacaotextoO estado do lote importado aqui dentro — se foi lido, validado e distribuído em guias.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
emitidoEmtextoData que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download.
transmitidoEmtextoQuando o lote foi transmitido à operadora, em ISO 8601 com fuso.
valorTotaltextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
conformidadeobjetoO veredito do esquema oficial da ANS sobre o XML importado.
xsdValidobooleanoO documento passou no esquema oficial da ANS (XSD). Lote inválido é recusado antes de ir à operadora.
guiasinteiroAs guias do documento.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.

ItemFaturavel

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.

Devolvido por:GET /v1/itens-faturaveis

CampoTipoO que é
idtextoIdentificador 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.
fontetexto
um de: LIS_API, REQUISICAO, PLANILHA
De onde o exame entrou: mandado pelo LIS, capturado numa requisição aqui, ou importado de planilha.
idNaOrigemtextoO id que o exame tem NA ORIGEM. É a identidade do fato: reenviar o mesmo id atualiza a linha, nunca cria uma segunda cobrança.
pacienteobjetoQuem fez o exame, como a origem informou.
nometextoNome do paciente como a origem o informou.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
cpftextoCPF, 11 dígitos. Aceito com ou sem máscara.
operadoraobjetoPara quem vai a cobrança. Tudo nulo = exame particular ou ainda sem destino.
registroAnstextoRegistro da operadora na ANS, seis dígitos, como consta no cadastro público.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
convenioIdtextoO convênio cadastrado que casa com o registro ANS, quando existe.
procedimentoobjetoO que foi feito.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoDescrição do procedimento, como a fonte a informou.
quantidadeinteiroQuantas 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.
valorUnitariotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
valorTotaltextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
dataExecucaotextoQuando 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.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: crédito na retenção, protocolo na glosa. Nunca da emissão.
situacaotexto
um de: A_FATURAR, EM_GUIA, EM_LOTE, ENVIADO, EXCLUIDO
Onde o item está no ciclo do dinheiro.
auditoriatexto
um de: NAO_AUDITADO, APTO, ALERTA, BLOQUEADO, DESATUALIZADO
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.
auditadoEmtextoQuando a última conferência válida rodou. Nulo = nunca foi conferido.
responsavelUserIdtextoQuem está com este item na mão.
requisicaoobjetoA requisição que capturou o exame, quando ele nasceu aqui dentro.
idtextoIdentificador 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.
numerotextoO número legível da requisição que capturou o exame, do prestador para o prestador.
autorizacaoobjetoA guia que autorizou ESTE exame. Nula = não há autorização vinculada — o que não quer dizer que não seja exigida.
guiaIdtextoA guia a que este registro se refere, pelo identificador do Miydas.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
situacaotextoEm que pé está a guia que autoriza este exame.
quantidadeAutorizadatextoQuanto a operadora liberou deste procedimento. Comparar com a quantidade executada é o que revela cobrança a descoberto.
statusItemtextoO que a operadora decidiu sobre ESTE procedimento dentro da guia.
achadoslista de objetosO que a conferência encontrou de aberto neste item. Resolver um não encerra os outros.
idtextoIdentificador 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.
codigotextoCódigo do catálogo interno: AUT-001, VAL-002.
familiatextoA que grupo o problema pertence: autorização, valor, procedimento, execução, documentação.
severidadetexto
um de: BLOQUEIA, ALERTA, INFO
BLOQUEIA impede faturar; ALERTA deixa seguir com ressalva; INFO é observação.
statustexto
um de: ABERTO, EM_ANALISE, AGUARDANDO, RESOLVIDO, DISPENSADO
Em que ponto o processamento está.
mensagemtextoO problema em uma frase, como o faturista o lê.

RemessaDeItensFaturaveis

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.

Devolvido por:POST /v1/itens-faturaveis

CampoTipoO que é
itenslista de ItemFaturavelOs exames gravados, como ficaram.
resumoobjetoA contagem da remessa.
criadosinteiroExames que não existiam e nasceram agora.
atualizadosinteiroExames que já estavam gravados e foram atualizados pelo que veio.

GuiasDoLote

As guias do lote com os itens de cada uma — SP/SADT e Consulta na mesma lista, distinguidas por tipo.

Devolvido por:GET /v1/lotes-importados/{id}/guias

CampoTipoO que é
loteIdtextoO lote a que esta guia pertence, pelo identificador do Miydas.
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
guiaslista de objetosAs guias do documento.
tipotexto
um de: SP_SADT, CONSULTA
O tipo da guia TISS. CONSULTA não tem itens: a consulta é o próprio procedimento.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
autorizadaEmtextoQuando a operadora autorizou, em ISO 8601 com fuso.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
beneficiariotextoO 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.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
itenslista de objetosVazio em CONSULTA: a consulta É o procedimento, e não tem item.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tipotextoNatureza da linha: PROCEDIMENTO ou DESPESA (material, medicamento, taxa).
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoCódigo do item na tabela declarada.
descricaotextoDescrição do item, como a fonte a informou.
quantidadetextoQuantas 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.
valorUnitariotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
executadoEmtextoQuando a execução ocorreu, em ISO 8601 com fuso.
atendidaEmtextoData do atendimento declarada no documento.

ProcedenciaDaGuia

De onde veio cada número desta guia — o arquivo de envio e os documentos de retorno, com o que cada um sabia.

Devolvido por:GET /v1/guias/{id}/procedencia

CampoTipoO que é
guiaobjetoA guia a que este registro pertence.
idtextoIdentificador 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.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
numeroProtocolotextoO número do protocolo na operadora.
operadoratextoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
beneficiariotextoO 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.
carteirinhatextoNúmero da carteirinha do beneficiário na operadora, como está no cartão.
dataExecucaotextoData em que o procedimento foi executado, AAAA-MM-DD.
statusConciliacaointeiroO veredito do motor de conciliação sobre esta guia.
conciliadaEmtextoQuando a conciliação rodou sobre este registro, em ISO 8601 com fuso.
justificativatextoA justificativa registrada, em texto livre.
observacaotextoObservação registrada, em texto livre.
envioobjetoNulo quando a guia nasceu do retorno: o portal não guarda o arquivo que o prestador mandou.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
itensinteiroQuantas linhas o arquivo de envio trazia para esta guia.
arquivoobjetoO arquivo de onde o dado veio.
idtextoIdentificador 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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
analiselista de objetosCada documento de ANÁLISE que falou desta guia. Mais de um é normal: a operadora reemite, e cada reemissão é uma linha aqui.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
demonstrativotextoO número do demonstrativo de onde este número veio.
emitidoEmtextoA data do PROTOCOLO, não a emissão do demonstrativo — essa é o dia do download.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
completudetextoO 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.
profundidadetextoAté onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item.
fonteslista de objetosOs arquivos que compõem este documento — é o caminho de volta ao papel.
papeltextoO que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro).
arquivoobjetoO arquivo de onde o dado veio.
idtextoIdentificador 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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
pagamentolista de objetosCada documento de PAGAMENTO que falou desta guia. Mais de uma linha com datas de crédito diferentes é parcela; com a mesma data, é reemissão.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
demonstrativotextoO número do demonstrativo de onde este número veio.
pagoEmtextoSem reserva: ausente é ausente.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liquidoDoDemonstrativotextoNÃO é o líquido desta guia. É o do documento, e os débitos são do DIA inteiro — costuma vir negativo.
completudetextoO 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.
profundidadetextoAté onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item.
fonteslista de objetosOs arquivos que compõem este documento — é o caminho de volta ao papel.
papeltextoO que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro).
arquivoobjetoO arquivo de onde o dado veio.
idtextoIdentificador 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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.

RetornoSemVinculo

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.

Devolvido por:GET /v1/retornos-sem-vinculo

CampoTipoO que é
tipotexto
um de: ANALISE, PAGAMENTO
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.
motivotexto
um de: GUIA_DESCONHECIDA, OPERADORA_DIVERGENTE, SEM_NUMERO_DE_GUIA
OPERADORA_DIVERGENTE pede corrigir cadastro; GUIA_DESCONHECIDA pede procurar a guia. Ações opostas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
demonstrativoIdtextoAbre em GET /v1/demonstrativos/{id} — o caminho de volta à prova.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
beneficiariotextoO 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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

ResumoDeRetornosSemVinculo

Quanto está solto, e onde. Não é paginado: somar meia competência daria um total errado.

Devolvido por:GET /v1/retornos-sem-vinculo/resumo

CampoTipoO que é
totalinteiroO total do recorte pedido.
montantetextoGlosa quando há; senão o liberado — o valor em disputa na linha.
porMotivolista de objetosOs mesmos números, abertos por motivo.
motivotextoO motivo, como a operadora o nomeou.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante deste motivo, em reais, decimal em string.
porOperadoralista de objetosOs mesmos números, abertos por operadora.
registroANStextoRegistro 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.
nometextoRazão social da operadora, para exibição.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante desta operadora, em reais, decimal em string.
porCompetencialista de objetosOs mesmos números, abertos por mês de competência.
competenciatextoMê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.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante deste mês, em reais, decimal em string.

MotivoDeGlosa

Um motivo distinto recebido por esta clínica, com quanto custou. Ordenado por valor.

Devolvido por:GET /v1/glosas/motivos

CampoTipoO que é
codigotextoO código do motivo. Nulo é o agrupamento de tudo que veio sem código.
significadotextoDa Tabela 38, ou o texto da categoria quando o motivo veio sem código.
tipotexto
um de: TABELA_ANS, CODIGO_OPERADORA, CATEGORIA
De onde o código vem: a tabela oficial da ANS, a tabela própria da operadora, ou só uma categoria.
glosasinteiroQuantas glosas esta clínica recebeu com este motivo.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.

GlosaSilenciosa

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.

Devolvido por:GET /v1/glosas/silenciosas

CampoTipoO que é
guiaIdtextoA guia a que este registro se refere, pelo identificador do Miydas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
executadoEmtextoQuando a execução ocorreu, em ISO 8601 com fuso.
pagoEmtextoData do crédito do pagamento.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
diferencatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
percentualnúmeroPercentual já calculado, com duas casas. 12.50 é doze e meio por cento.
situacaoConciliacaointeiro0–7. Ver situacao.codigo da guia do beneficiário para o significado.

Beneficiario

O histórico de uma carteirinha nesta clínica. A pergunta que nenhum sistema respondia.

Devolvido por:GET /v1/beneficiarios/{carteira}

CampoTipoO que é
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
nometextoA operadora frequentemente não manda. A carteirinha é a chave; o nome é enriquecimento.
operadoraslista de objetosAs operadoras alcançadas pelo recorte pedido.
registroANStextoRegistro 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.
resumoobjetoO histórico desta carteirinha nesta clínica, somado.
guiasinteiroAs guias do documento.
cobradotextoDecimal em string, duas casas — dinheiro não é number.
liberadotextoDecimal em string, duas casas — dinheiro não é number.
glosadoobjetoDois números, os dois verdade: declarado é o que a operadora chamou de glosa; derivado é cobrado menos liberado.
declaradotextoDecimal em string, duas casas — dinheiro não é number.
derivadotextoDecimal em string, duas casas — dinheiro não é number.
taxaGlosanúmeroProporção 0–1 do derivado sobre o cobrado. 0 quando não houve cobrança.
guiasComGlosaDeclaradainteiroEm quantas guias a operadora declarou glosa.
guiasPagasinteiroEm quantas guias já houve crédito declarado.
primeiraGuiatextoData da primeira guia desta carteirinha aqui.
ultimaGuiatextoData da guia mais recente desta carteirinha aqui.
glosasobjetoAs glosas desta carteirinha, somadas.
totalinteiroO total do recorte pedido.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
alertaslista de objetosSinal medido no histórico desta carteirinha, não previsão de modelo.
tipotextoQue sinal é este (ex. taxa de glosa acima da média, guia parada sem retorno).
detalhetextoDetalhe em texto livre, para humano. Não é contrato.

BeneficiarioEncontrado

Devolvido por:GET /v1/beneficiarios

CampoTipoO que é
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
nometextoNome do beneficiário. A operadora frequentemente não manda — a chave é a carteirinha.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
ultimaGuiatextoData da guia mais recente desta carteirinha, para distinguir homônimos na busca.

GuiaDoBeneficiario

A guia pelo olhar da conciliação: os valores e o veredito do casamento entre cobrado e pago.

Devolvido por:GET /v1/beneficiarios/{carteira}/guias

CampoTipoO que é
guiaIdtextoA guia a que este registro se refere, pelo identificador do Miydas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
lotetextoO número do lote em que esta guia foi enviada.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
executadoEmtextoQuando a execução ocorreu, em ISO 8601 com fuso.
pagoEmtextoData do crédito do pagamento.
valoresobjetoOs quatro números da guia. Ausência é null, nunca "0.00".
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
diferencatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
conciliacaoobjetoO cruzamento que o Miydas fez entre o cobrado e o pago — não é o que a operadora disse.
situacaoobjetoO veredito do motor de conciliação sobre a guia, como código e por extenso.
codigointeiroO código do veredito, de 0 a 7. descricao traz o mesmo em português — use o código na lógica.
descricaotextoO mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar.
glosaDeclaradabooleanoA operadora declarou glosa. false com diferença a menor é glosa silenciosa: cortaram sem dizer.
direcaoDiferencatextoA_MENOR | A_MAIOR | null.
percentualGlosanúmeroQuanto da cobrança virou glosa, em percentual com duas casas.
scoreConfiancanúmeroO quanto o casamento entre o que foi cobrado e o que foi pago é confiável.
prioridadeRevisaotextoO quanto esta guia merece atenção humana, combinando valor em jogo e confiança do casamento.

GlosaDoBeneficiario

Devolvido por:GET /v1/beneficiarios/{carteira}/glosas

CampoTipoO que é
glosaIdtextoA glosa a que este registro se refere, pelo identificador do Miydas.
niveltextoEm 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.
motivoobjetoPor que cortaram, na palavra da operadora e no termo oficial.
codigotextoO código do motivo, como a operadora o emitiu.
significadotextoO termo oficial da Tabela 38 da ANS, quando o código existe nela.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
categoriatextoO agrupamento que a operadora deu ao motivo, quando ela agrupa.
descricaotextoO texto livre que a operadora escreveu sobre esta glosa.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
procedimentoobjetoO procedimento a que a linha se refere.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoDescrição do procedimento, como a fonte a informou.
registradaEmtextoQuando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora.

ElegibilidadeResumida

Elegibilidade já consultada. Leitura: não fala com a operadora.

Devolvido por:GET /v1/beneficiarios/{carteira}/elegibilidades

CampoTipoO que é
elegibilidadeIdtextoA consulta de elegibilidade, pelo identificador do Miydas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
elegivelbooleanoA operadora respondeu que o beneficiário pode ser atendido.
alcancetextoCARTEIRINHA | PROCEDIMENTO — até onde a operadora respondeu.
motivoNaoElegiveltextoO que a operadora respondeu quando negou o atendimento, na língua dela.
planotextoNome do plano do beneficiário na operadora.
validadeCarteiratextoÚltimo dia de validade da carteirinha informado pela operadora.
consultadaEmtextoQuando a consulta à operadora aconteceu, em ISO 8601 com fuso.

AutorizacaoResumida

Devolvido por:GET /v1/beneficiarios/{carteira}/autorizacoes

CampoTipoO que é
autorizacaoIdtextoA autorização, pelo identificador do Miydas.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
situacaoobjetoO veredito da operadora sobre a guia, no nosso vocabulário e no dela.
codigotextoO veredito traduzido (AUTORIZADA, NEGADA, EM_ANALISE…). Nulo enquanto ela não respondeu.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
validadeSenhatextoÚltimo dia em que a senha de autorização pode ser usada. Passou disso, a guia volta para a fila.
autorizadaEmtextoQuando a operadora autorizou, em ISO 8601 com fuso.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
solicitadaEmtextoQuando a solicitação foi feita, em ISO 8601 com fuso.

EloDaLinhaDoTempo

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.

Devolvido por:GET /v1/beneficiarios/{carteira}/linha-do-tempo

CampoTipoO que é
emtextoQuando este fato foi registrado, em ISO 8601 com fuso.
tipotexto
um de: GUIA_EXECUTADA, GUIA_PAGA, GLOSA, ELEGIBILIDADE, AUTORIZACAO
Que fato é este elo.
titulotextoO fato em uma linha, pronto para exibir na linha do tempo.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
referenciatextoO número de guia, quando há. Senão o id do recurso.

Autorizacao

Devolvido por:POST /v1/autorizacoesGET /v1/autorizacoesPOST /v1/autorizacoes/consultasGET /v1/autorizacoes/{id}POST /v1/autorizacoes/{id}/consultasPOST /v1/autorizacoes/{id}/envioPATCH /v1/autorizacoes/{id}POST /v1/autorizacoes/{id}/cancelamentoPUT /v1/autorizacoes/{id}/executadosPOST /v1/autorizacoes/{id}/execucao

CampoTipoO que é
idtextoIdentificador 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.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
processamentoProcessamentoO andamento do pedido COM A OPERADORA. Enquanto ele não concluir, a situação abaixo é nula — o recurso existe, a resposta ainda não.
situacaoobjetoNula até a operadora responder. codigoOperadora é o que ela mandou.
codigotexto
um de: A_ENVIAR, ENVIANDO, EM_ANALISE, AUTORIZADA, PARCIALMENTE_AUTORIZADA, NEGADA, AGUARDANDO_JUSTIFICATIVA, AGUARDANDO_DOCUMENTACAO, CANCELADA, NAO_EXIGE_AUTORIZACAO, INDETERMINADA
O veredito traduzido. NAO_EXIGE_AUTORIZACAO não é negativa: é a operadora dizendo que o procedimento passa direto.
descricaotextoO mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
validadeSenhatextoÚltimo dia em que a senha de autorização pode ser usada. Passou disso, a guia volta para a fila.
dataAutorizacaotextoData em que a operadora autorizou, AAAA-MM-DD.
dataSolicitacaotextoO dia em que a autorização foi pedida. É por ele que de e ate recortam a listagem.
beneficiarioobjetoO 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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
nometextoNome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro.
solicitanteobjetoQuem pediu o procedimento.
nometextoNome do profissional solicitante.
conselhotextoSigla do conselho profissional (CRM, CRO, COREN…).
numerotextoNúmero de inscrição do solicitante no conselho.
uftextoSigla da unidade federativa, duas letras (ex. SC).
cbotextoOcupação do profissional na CBO, seis dígitos.
pedidoobjetoO 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.
caratertexto
um de: ELETIVO, URGENCIA
Eletivo ou urgência/emergência.
indicacaoClinicatextoA justificativa clínica do pedido, como foi enviada.
observacaotextoObservação livre para o auditor da operadora.
numeroGuiaPrincipaltextoA guia principal, quando esta é continuação de outra.
coberturaEspecialtextoCobertura especial (dm_tipoCoberturaEspecial): gestante, aidético ou recém-nascido.
recemNascidobooleanoAtendimento a recém-nascido na mesma guia da mãe.
atendimentoobjetoTipo e regime de atendimento e indicação de acidente, nos domínios TISS. null quando a operadora não os pede.
tipoAtendimentotextoTipo de atendimento (dm_tipoAtendimento). Exame de laboratório costuma ser 23.
regimeAtendimentotextoRegime de atendimento (dm_regimeAtendimento): ambulatorial, hospitalar, domiciliar.
indicacaoAcidentetextoIndicação de acidente (dm_indicacaoAcidente). 9 é "não é acidente".
saudeOcupacionaltextoTipo de saúde ocupacional (dm_tipoSaudeOcupacional), quando o exame é admissional, periódico ou demissional.
portalobjetoCampos que só certos portais pedem — CID-10, tempo de doença, data do acidente. null quando nenhum foi informado.
cidtextoCID-10 da hipótese diagnóstica, quando o portal o exige.
tempoDoencatextoHá quanto tempo o quadro dura, no formato que o portal pede.
dataAcidentetextoO dia do acidente, quando houve (AAAA-MM-DD).
evidenciasobjetoO 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.
telabooleanoHá 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.
guiabooleanoHá o PDF que a própria operadora imprime, baixado no ato da autorização. Só onde o portal oferece impressão nativa.
procedimentoslista de objetosOs procedimentos do documento.
idtextoIdentifica este procedimento. É o que se manda em refazItem ao pedir de novo o que foi negado.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoDescrição do procedimento, como ela vai no documento.
quantidadeSolicitadanúmeroQuantas unidades você pediu.
quantidadeAutorizadanúmeroQuantas a operadora liberou. Menor que a solicitada é autorização parcial — execute só o autorizado, ou a diferença vira glosa.
quantidadeExecutadanúmeroQuantas 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.
motivoslista de textoO que a operadora alegou sobre ESTE procedimento.
refazItemtextoO 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.
motivoslista de textoO que a operadora alegou sobre a guia inteira.
requisicaoobjetoA 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.
idtextoA requisição, para abrir o papel que originou esta guia.
numerotextoO número legível da requisição, do prestador para o prestador (REQ-2026-0412).
partenúmeroQual das guias desta requisição é esta. null quando a requisição gerou uma só.
partesnúmeroEm quantas guias a requisição foi dividida pelo limite de exames da operadora.
proximaAcaoobjetoO 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.
codigotextoENVIAR, CONSULTAR, IMPRIMIR_GUIA, REFAZER_COM_CAPTURA… — para a interface decidir o botão.
textotextoA frase pronta, escrita para quem está no balcão.
precisaDeMimbooleanoEsta guia espera alguém AGORA. Guia em análise dentro do prazo responde false — enchê-la na fila é como se esconde a que precisa.
execucaoobjetoA 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.
executadabooleanoA operadora registrou o atendimento.
parcialbooleanoParte do pedido entrou na guia; o resto continua pendente.
guiaGeradatextoA guia de serviço que a operadora emitiu ao executar — número NOVO, diferente de numeroGuiaOperadora, e é ele que o faturamento cobra.
situacaoOperadoratextoO rótulo que a operadora deu à execução (ex.: "Executada").
mensagemtextoO que a operadora respondeu à execução, na frase dela — inclusive a recusa, quando houve.
emtextoQuando a execução foi registrada.
historicolista de objetosO que já se fez com esta guia, em ordem — a solicitação e cada consulta ou cancelamento depois dela.
ocorridoEmtextoQuando o fato aconteceu, em ISO 8601 com fuso.
tipotexto
um de: SOLICITACAO, CONSULTA, CANCELAMENTO
Que ação foi esta.
origemtexto
um de: SOLICITACAO, CONSULTA
SOLICITACAO: a guia nasceu aqui. CONSULTA: foi pedida fora do Miydas e importada depois.
etapatexto
um de: PREVIA, EXECUCAO
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.
testebooleanotrue: criado por chave de teste (myd_test_…), executado na homologação da operadora e visível só para chaves de teste.
proximaConsultaEmtextoQuando 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.
consultasAutomaticasnúmeroQuantas vezes o Miydas já reconsultou esta guia por conta própria.
criadaEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.
atualizadaEmtextoQuando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso.

Elegibilidade

Devolvido por:POST /v1/elegibilidadesGET /v1/elegibilidadesGET /v1/elegibilidades/{id}

CampoTipoO que é
idtextoIdentificador 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.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
processamentoProcessamentoO andamento da consulta COM A OPERADORA. Enquanto ele não concluir, elegivel é nulo.
elegivelbooleanoA operadora respondeu que o beneficiário pode ser atendido.
alcancetexto
um de: CARTEIRINHA, PROCEDIMENTO
Até onde a operadora respondeu: pela carteirinha, ou por procedimento.
beneficiarioobjetoO 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.
nometextoNome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro.
validadeCarteiratextoÚltimo dia de validade da carteirinha informado pela operadora.
planotextoNome do plano do beneficiário na operadora.
procedimentosPedidoslista de textoOs 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.
procedimentoslista de objetosOs procedimentos do documento.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoDescrição do procedimento, como ela vai no documento.
elegivelbooleanoA operadora cobre ESTE procedimento para este beneficiário.
motivoslista de textoO que ela alegou sobre este procedimento.
foraDoContratobooleanoNão está no contrato do prestador com a operadora
motivoslista de textoO que a operadora alegou sobre a elegibilidade como um todo.
avisoslista de textoO que você precisa saber para não ler esta resposta errado — por exemplo, que a operadora respondeu só pela carteirinha.
testebooleanotrue: criado por chave de teste (myd_test_…), executado na homologação da operadora e visível só para chaves de teste.
criadaEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.

Evento

Devolvido por:GET /v1/eventos

CampoTipoO que é
nometextoO nome do evento, no formato recurso.fato (ex. autorizacao.concluida). É o que se assina.
recursotextoA que família de recurso este evento pertence — é o prefixo do nome.
quandotextoEm que momento do ciclo este evento é emitido.
escopoNecessariotextoEscopo que a chave precisa ter para receber

Assinatura

Devolvido por:GET /v1/assinaturasGET /v1/assinaturas/{id}

CampoTipoO que é
idtextoIdentificador 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.
urltextoA URL, com esquema.
eventoslista de textoNomes exatos, recurso.* ou *
descricaotextoPara que serve esta assinatura. É o que distingue uma da outra na lista.
ativabooleanoA assinatura está recebendo eventos.
criadaEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.
atualizadaEmtextoQuando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso.

AssinaturaCriada

Devolvido por:POST /v1/assinaturas

CampoTipoO que é
idtextoIdentificador 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.
urltextoA URL, com esquema.
eventoslista de textoNomes exatos, recurso.* ou *
descricaotextoPara que serve esta assinatura. É o que distingue uma da outra na lista.
ativabooleanoA assinatura está recebendo eventos.
criadaEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.
atualizadaEmtextoQuando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso.
segredotextoSó nesta resposta. Guarde: é com ele que se confere miydas-assinatura.

SegredoAssinatura

O segredo novo depois da troca. O anterior para de valer na hora.

Devolvido por:POST /v1/assinaturas/{id}/segredo

CampoTipoO que é
idtextoIdentificador 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.
segredotextoSó nesta resposta. Guarde: é com ele que se confere o cabeçalho miydas-assinatura.

Entrega

Devolvido por:GET /v1/assinaturas/{id}/entregas

CampoTipoO que é
idtextoIdentificador 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.
eventotextoO nome do evento, no formato recurso.fato.
recursoobjetoQue tipo de recurso este registro descreve.
tipotextoQue tipo de recurso o evento descreve (ex. autorizacao, lote).
idtextoIdentificador 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.
statustexto
um de: PENDENTE, ENTREGUE, FALHOU
Em que ponto o processamento está.
tentativasinteiroQuantas vezes já tentamos.
httpStatusinteiroO código HTTP que o seu endpoint devolveu na entrega.
errotextoO que falhou. null quando não falhou nada.
criadaEmtextoQuando o registro nasceu no Miydas, em ISO 8601 com fuso.
entregueEmtextoQuando a entrega do evento foi aceita pelo seu endpoint, em ISO 8601 com fuso.
proximaTentativaEmtextoQuando sai a próxima tentativa de entrega. null = não há outra.

ResultadoTeste

Devolvido por:POST /v1/assinaturas/{id}/teste

CampoTipoO que é
entregatextoO id da entrega de teste — acompanhe por ele em /assinaturas/{id}/entregas.
entreguebooleanoO seu endpoint aceitou (2xx). false com httpStatus nulo = não respondeu a tempo.
httpStatusinteiroO código HTTP que o seu endpoint devolveu na entrega.
errotextoO que falhou. null quando não falhou nada.