Versões comparadas

Versão antiga 2

changes.mady.by.user Vinicius Fiorio Custodio

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Lucas Souza

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

...

Método "detalheExtrato”

Este método irá retornar a lista de extrato de autorização disponíveis relacionadas ao beneficiário.

Informações

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ detalheExtrato

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/detalheExtrato”.

POST

application/json

Endpoint lista os detalhes do extrato.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

...

Parâmetro

Obrigatório

Tipo

Descrição

integracao

M

Objeto

 Nó integração retornado no login do beneficiário

idAutorizacao

M

String

 Id referente ao extrato.

Exemplo request

Bloco de código
languagejson
url: 
https://www.operadoradesaude.com.br/mobilesaude/extratoAutorizacao/detalheExtrato

Body:
{
  "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
      },
  "idAutorizacao": "string"
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idAutorizacao

M

String

numeroPedido

M

String

senhaAutorizacao

M

String

idTipoServico

M

String

descricaoTipoServico

M

String

dataSolicitacao

M

String

Data de solicitação

Formato: YYYY-MM-DD

dataAutorizacao

OP

String

Data da autorizacao

Formato: YYYY-MM-DD

dataValidade

OP

String

Data de validade

Formato: YYYY-MM-DD

numeroProtocolo

M

String

tipoTratamento

OPM

String

Texto livre

Nota

Atenção

Os atributos de critério OP “Opcional” devem ser enviados mesmo que com valor Null para o funcionamento da API

Objeto prestador

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

 

especialidade

M

String

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idEventoGuia

M

String

codigo

M

String

descricao

M

String

quantidadeSolicitada

M

Float

Valor solicitado (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

quantidadeAutorizada

OP

Float

Valor autorizado (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

quantidadeExecutada

OP

Float

Valor executado (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

dataAutorizacao

OP

String

textoGlosa

OPM

String

Texto livre.

textoProcedimento

OP

Objeto

Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "textoProcedimento" descrito posteriormente.

situacao

M

Objeto

Objeto que indica a situação do pedido de reembolso.

Obrigatório o preenchimento conforme objeto "situacao" descrito posteriormente.

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

id

M

String

Código ou ID que represente o status do débito no seus sistema.

 

descricao

M

String

Descrição da situação do pedido de reembolso

“Aprovado”, “Solicitado”, “Recusado”

cor

M

String

cor da label a ser exibida.

Hexadecimal. com o #. da cor que deseja que seja usada para representar a situação do reembolso.

Ex.: #FF0000

Retorno da API - Sucesso

Bloco de código
languagejson
{
  "numeroContrato": "99991",
  "guia": {
    "idAutorizacao": "01918",
    "numeroPedido": "7151819191",
    "senhaAutorizacao": "xtp1826xyz",
    "idTipoServico": "01918",
    "descricaoTipoServico": "Consulta",
    "dataSolicitacao": "2021-03-01",
    "dataAutorizacao": "2021-03-01",
    "dataValidade": "2021-03-01",
    "numeroProtocolo": "19172918jsjs817171",
    "tipoTratamento": "texto livre"
  },
  "prestador": {
    "nome": "clinica dos olhos",
    "especialidade": "oftalmologia"
  },
  "solicitante": {
    "chaveUnica": "10101012",
    "nomeSolicitante": "Victor Hugo Prando",
    "idTipoSolicitante": "T",
    "numeroCartaoSolicitante": "010187161515"
  },
  "textoPreparo": "texto livre para o preparo",
  "chaveUnica": "10101012",
  "nomeBeneficiario": "Victor Hugo Prando",
  "idTipoBeneficiario": "T",
  "numeroCartaoBeneficiario": "010187161515",
  "situacao": {
    "id": "xyz",
    "descricao": "Autorizado",
    "cor": "#71J171J"
  },
  "eventos": [
    {
      "idAgrupador": "01",
      "descricaoAgrupador": "Exames simples",
      "textos": {
        "titulo": "Preparo",
        "descricao": "texto livre para o preparo"
      },
      "procedimentos": [
        {
          "idEventoGuia": "10101",
          "codigo": "10101012",
          "descricao": "Consulta eletiva em consultorio",
          "quantidadeSolicitada": 10.00,
          "quantidadeAutorizada": 10.00,
          "quantidadeExecutada": 5.00,
          "dataAutorizacao": "2021-03-01",
          "textoGlosa": "texto livre para justificar a negativa",
          "textoProcedimento": {
            "titulo": "Preparo",
            "descricao": "texto livre para o preparo"
          },
          "situacao": {
            "id": "xyz",
            "descricao": "Autorizado",
            "cor": "#71J171J"
          }
        }
      ]
    }
  ]
}

Retorno da API - Falha

Aviso

...