API INSS - Médico

CONTEÚDO

Visão Geral
1. Rota
2. Parâmetros de Entrada
3. Retorno
Regras de Negócio Aplicadas
Exemplo de Utilização

01. VISÃO GERAL

O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração com o APP da Unimed Brasil.

A API INSS(Medico/INSS) tem por objetivo retornar o demonstrativo de INSS do médico.

A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil:

a. Rota

/Medico/v1/Extrato

b. Parâmetros de Entrada

Esta API deve receber os seguintes parâmetros via header ou via query parameters:

Parâmetro	Tipo de Parâmetro	Tipo de dados	Formato	Obrigatório?
X-Matricula	header	Integer	99999999	Sim
competencia	query	String	MM/AAAA	Sim

c. Retorno

O objeto Json de retorno da API possui a seguinte estrutura:

{
  "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok",
  "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)",
  "Data": {
    "cooperativa": "Objeto com os dados de identificação do cooperativa",
    "secoes": "Listagem das seções (itens) do INSS que será apresentada no aplicativo"
  },
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista contendo o demonstrativo de INSS do médico

04. EXEMPLO DE UTILIZAÇÃO

Realizada uma requisição na API utilizando a matrícula e a competência conforme abaixo:

Parâmetro	Valor
competencia	07/2016
X-Matricula	00031921

{
    "Result": 1,
    "Data": {
        "secoes": [
            {
                "titulo": "Remuneração Base Inss Fis",
                "valorFormatado": "R$ 1.417,94"
            },
            {
                "titulo": "Remuneração Base Inss Ben",
                "valorFormatado": "R$ 371,44"
            },
            {
                "titulo": "Remuneração Base Inss Jur",
                "valorFormatado": "R$ 2.874,37"
            },
            {
                "titulo": "Remuneração Base Inss Pro",
                "valorFormatado": "R$ 4,00"
            },
            {
                "titulo": "Valor da Retenção Inss",
                "valorFormatado": "R$ 513,01"
            }
        ],
        "cooperativa": {
                "cidade": "CAXIAS DO SUL - RS",
                "bairro": "CINQUENTENARIO",
                "cep": "95012280",
                "uf": "RS",
                "telefone": "5530251717",
                "razaoSocial": "OPERADORA DE SAUDE TOTVS",
                "cnpj": "16859152000184",
                "endereco": "Rua dos jacarandas, 343                 "
        }
    },
    "DebugMessage": "",
    "Message": ""
}

Por fim, os registros aqui listados podem ser validados pelo programa "Demonstrativo INSS" do módulo Autorizador WEB

\

Árvore de páginas