Ogmma Revenue

Faturamento

POST/v1/lotes/{id}/resolucoes

Registra o que foi apurado na operadora sobre um lote indeterminado

Único caminho que libera o reenvio de um lote cuja transmissão ficou sem resposta. É manual porque não há como confirmar sozinho: sem protocolo não existe consulta de protocolo. chegou: true exige o protocolo que a operadora deu — é por ele que status e demonstrativo são consultados depois. chegou: false devolve o lote para pronto.

Escopo:
lote:enviar
Resposta:
200

Pedido

Caminho

{id}*Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.

Corpo (JSON)

CampoTipoO que é
chegou*booleanotrue: você confirmou na operadora que o lote entrou — exige o protocolo. false: não entrou, e o lote volta a poder ser enviado.
protocolotexto
1–40 caracteres
O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
nota*textoA nota escrita por quem registrou o fato — fica no histórico do recurso.

* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.

Exemplo de chamada

curl -X POST https://api.miydas.com.br/v1/lotes/cmf3k2x9a0001aut/resolucoes \
  -H "Authorization: Bearer $MIYDAS_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "chegou": true,
    "protocolo": "PROTO-18700001",
    "nota": "protocolo localizado no portal da operadora em 20/10, lote consta como recebido"
  }'

Resposta 200

dataLoteO recurso. Os campos estão na tabela abaixo.

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.

Campos de Lote

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.

Exemplo de retorno

{
  "data": {
    "id": "cmf3k2x9a0001lot",
    "referenciaExterna": "fatura-2026-09-0042",
    "operadora": {
      "registroANS": "334561",
      "nome": "Unimed Blumenau"
    },
    "competencia": "2026-09",
    "numeroLote": "202609",
    "situacao": {
      "codigo": "TRANSMITIDO",
      "descricao": "Recebido pela operadora, com protocolo. Veja `processamento` para o que ela fez com o conteudo.",
      "podeEnviar": false
    },
    "processamento": {
      "codigo": "PROCESSANDO",
      "descricao": "A operadora recebeu e esta importando o lote.",
      "acao": "Aguarde e consulte o lote. Nao gere lote novo.",
      "motivo": null,
      "em": "2026-09-27T13:05:10.000Z"
    },
    "conformidade": {
      "xsdValido": true,
      "erros": null
    },
    "totais": {
      "guias": 1,
      "procedimentos": 1,
      "valorTotal": "12.50"
    },
    "protocolo": "PROTO-18700001",
    "transmitidoEm": "2026-09-27T13:05:00.000Z",
    "ultimoErro": null,
    "criadoEm": "2026-09-27T13:00:00.000Z"
  }
}

Experimente sem chave

O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.

curl https://api.miydas.com.br/v1/sandbox/lotes_resolver

O sandbox responde sempre em GET, mesmo para uma operação POST: ele devolve a forma da resposta, não executa nada.

A chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.

Erros

CódigoHTTPQuandoO que fazer
RECURSO_NAO_ENCONTRADO404O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.Confira o id.
LOTE_NAO_INDETERMINADO409Pediu-se resolução de um lote que não está indeterminado.Não há o que resolver; veja a situação atual do lote.
PROTOCOLO_OBRIGATORIO400Marcou-se chegou: true sem informar o protocolo.Informe o protocolo que a operadora deu — é por ele que status e demonstrativo são consultados depois.

Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.