Comparação de Páginas

...

Índice

minLevel	1
maxLevel	7

Dica
Só são suportadas integrações no padrão REST.

Nota

Orientações

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.

Critérios de preenchimento

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

Objetos e atributos de retorno

Nota

Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.

Exemplo do atributo “contratos”:

~~Contrato~~
~~contrato~~
~~Contratos~~
contratos

Método de detalheDebito

Dica
Atente-se as orientações fornecidas pela Mobile Saúde; Atente-se aos critérios de preenchimento; Atente-se aos critérios de objetos e atributos de retorno; Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/ demonstrativoPagamento/producao	POST	application/json	Retorna uma lista detalhada dos procedimentos executados pelo cooperado no período selecionado

Parâmetros de entrada

Parâmetro	Obrigatório	Tipo	Descrição
chavePagamento	M	String	Chave de identificação do período selecionado. Essa informação é retornada pelo método listaPeriodo.
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usuário

Exemplo request

Bloco de código

language	json

url: 
https://www.operadoradesaude.com.br/mobilesaude/demonstrativoPagamento/producao

Body:
{
	"chaveUnica" : "101012",                
	"integracao": {
    	"xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "chavePagamento": "MS00579",  
}

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

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

...

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Tipo de serviço	exemplo: Consulta Exames Honorário Médico
data	M	String	Data da execução do serviço
quantidade	M	Number	Quantidade executada
valor	M	Float	Valor total do serviço executado.	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) Se não houver, informar zero

Exemplo retorno API - sucesso

Bloco de código

language	json

{
  "descricao": "Pagamento Mensal",
  "tituloTotalizador": "Total de produção",
  "valorTotal": 1257.99,
  "dataPagamento": "2024-08-01",
  "producao": [
    {
      "procedimento": {
        "codigo": "10101012",
        "descricao": "Consulta em consultorio"
      },
      "beneficiario": {
        "nome": "Fabio Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020003",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020001",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020002",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020004",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020005",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020006",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020007",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020008",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020009",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020010",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    },
    {
      "procedimento": {
        "codigo": "10101013",
        "descricao": "Cesariana (COM DIRETRIZ DE ENFERMAGEM)"
      },
      "beneficiario": {
        "nome": "Kemilly Neves",
        "matricula": "00010001000001000"
      },
      "servico": {
        "descricao": "Consulta",
        "data": "2024-08-01",
        "quantidade": 1,
        "valor": 1000
      },
      "numeroGuia": "000100020011",
      "numeroAutorizacao": "01010101",
      "numeroProtocolo": "01010101",
      "tipoContrato": "Intercambio",
      "plano": "PP/CRUP",
      "quantidadeCh": 100,
      "valorCh": 0.8,
      "coparticipacaoNoAto": 20,
      "regimeAtendimento": "internacao",
      "naoConformidade": "descrição da não conformidade",
      "localExecucao": "Consultorio"
    }
  ],
  "alerta": {
    "icone": "icon_boleto_calendar",
    "cor": "#FF0000",
    "mensagem": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
  }
}

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

Aviso
Está indicado abaixo a estrutura de retorno do seu método listaDebitos. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos. Atente-se as mensagens de retorno para cada HTTPS Status Code;

...

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Exemplo retorno API - falha

Bloco de código

language	json

{
  "mensagem": "Não foi possível obter os detalhes deste débito. Por favor, entre em contato com suporte."
}

Ícones disponíveis (.png)

icon_boleto_calendar	icon_boleto_card	icon_boleto_check
icon_boleto_exclamation	Icon_boleto_exclude	icon_boleto_money
icon_boleto_notification	icon_boleto_star