Produção do Demonstrativo de Pagamento

Índice

1 Índice
2 Telas
3 Descrição:
4 Regas de negócio
5 Orientações
- 5.1 Parâmetros de entrada
6 Critérios de preenchimento
7 Objetos e atributos de retorno
8 Método de detalheDebito
- 8.1 Endpoint
- 8.2 Parâmetros de entrada
- 8.3 Exemplo request
- 8.4 Descrição dos objetos e atributos de retorno - Sucesso
  - 8.4.1 Exemplo retorno API - sucesso
  - 8.4.2 Descrição dos objetos e atributos de retorno - falha
  - 8.4.3 Exemplo retorno API - falha
9 Ícones disponíveis (.png)

Telas

Descrição:

Retorna uma lista dos procedimentos contemplados no periodo selecionado

Regas de negócio

Considera que os dados necessários para identificação do cooperado são: chaveUnica e integração. Envie no objeto integração os dados que você precisa para reconhecer o seu cooperado, esse conjunto de dados: chaveUnica + integração serão enviados em todas as requisições para seu sistema.

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

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

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

Método de detalheDebito

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
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

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

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.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Informe o texto de apresentação do período de pagamento, por exemplo: “Primeira quinzena“; “Segunda quinzena“; “Pagamento mensal”
tituloTotalizador	M	String	titulo totalizador dos registros de produção	texto livre
valorTotal	M	Float	valor total liquido a receber
dataPagamento	M	String	Data de Pagamento	Formato: Formato: YYYY-MM-DD
producao	M	Number	Array de objetos “producao”
alerta	OP	Object	Objeto do tipo "alerta"	Informativo a ser exibido no card de alerta da tela. Consulte o layout.

Objeto producao

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
procedimento	M	Objeto	Objeto do tipo "procedimento" segue a baixo na documentacao
beneficiario	M	objeto	Objeto do tipo "beneficiario" segue a baixo na documentacao
servico	M	objeto	Objeto do tipo "servico" segue a baixo na documentacao
numeroGuia	M	String	Número da guia no seu sistema de gestão
numeroAutorizacao	M	String	Número da autorização.
numeroProtocolo	M	String	Número do protocolo (PEG).
tipoContrato	M	String	Tipo de contrato	Exemplo: Custo Operacional Intercambio Pre-Pagamento
quantidadeCh	M	Number	Quantidade de CH do procedimento.	Se não houver, enviar zero
valorCh	M	Float	Valor do CH.	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) Se não houver, enviar zero
coparticipacaoNoAto	M	Float	Valor da coparticipação paga no ato em consultório.	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) Se não houver, enviar zero
regimeAtendimen to	M	String	Regime de atendimento	por exemplo: Consultório Internação PCMSO SP/SADT
naoConformidade	OP	String	Descrição da não conformidade
localExecucao	OP	String	Descrição do local de execução	Formato: Texto livre

Objeto alerta

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
icone	OP	String	icone a ser utilizado no card de alerta. Verifique a lista de icones disponiveis pela mobile.
mensagem	M	String	Informe a mensagem a ser exibida no card de alerta. Consulte o layout	texto livre
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 débito. Ex.: `#FF0000`

Objeto procedimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	String	Código do procedimento
descricao	M	String	Descrição do procedimento	Texto livre

Objeto beneficiario

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
nome	M	String	Nome do beneficiario
matricula	M	String	Numero da matricula do beneficiario
plano	M	String	Descrição do plano do beneficiário

Objeto servico

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

{
  "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

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

{
  "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