...
...
Índice
| Índice | ||||
|---|---|---|---|---|
|
Descrição:
Retorna uma lista dos períodos liberados para consulta ao demonstrativo de pagamento.
Regas de negócio
O aplicativo irá enviar para este webservice o conteúdo dos campos chaveUnica e integração os campos chave_cooperado (código do cooperado no seu sistema) e numero_cr (número de inscrição no concelho regional), devem ser retornados dentro do objeto de integração no payload de login.
Deve retornar uma lista com as competências e períodos de pagamento ao cooperado. A lista de períodos deve ser ordenada em ordem cronológica decrescente. Recomendamos retornar no máximo os últimos 12 meses, para não sobrecarregar a requisição;
...
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
| Nota |
|---|
OrientaçõesParâmetros de entradaSerã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”:
|
Método de listaPeriodos
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com/ listaPeriodos | POST | application/json | Retorna uma lista dos períodos liberados para consulta ao demonstrativo de pagamento. |
Parâmetros de entrada
Atributo | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | M | Objeto | nó integração retornado no login do beneficiário |
contrato | C | String | Contrato selecionado |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
numeroContrato | M | String | Chave de identificação do controlado selecionado. | Enviado quando o parâmetro utilizaSelecaoContrato estiver ativo. |
Exemplo request
| Bloco de código | ||
|---|---|---|
| ||
url:
https://www.operadoradesaude.com.br/mobilesaude/listaPeriodos
Body:
{
"chaveUnica": "<chaveUnica>",
"integracao": "{objeto}"
} |
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 | Id de banco de dados do título no seu sistema interno. | Somente números inteiros (Não podem existir letras, espaços em branco, ou pontos decimais). Número único. Não pode ser repetido. |
valor | M | Number | Informe o valor total do periodo | |
dataPagamento | M | String | Informe a data de pagamento deste período. Essa informação será apresentada ao cooperado na tela de Períodos. | Formato: YYYY-MM-DD |
chavePagamento | M | String | Código do título no seu sistema interno, exemplo “MS00579”. | Formato: Texto livre. Utilize este campo para montar a chave que irá identificar o período Deve ser um identificador único. Não pode ser repetido. |
Exemplo retorno API - sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"alerta": "",
"competencias": [
{
"titulo": 2024 - Junho,
"subtitulo": "",
"valorTotal": 20003.96,
"periodos": [
{
"descricao": "Segunda quinzena",
"dataPagamento": "2024-06-01",
"valor": 11003.01,
"chavePagamento": "55555555:2024-06-01:101010"
},
{
"descricao": "Primeira quinzena",
"dataPagamento": "2024-06-01",
"valor": 9000.95,
"chavePagamento": "55555555:2024-06-01:101010"
}
]
},
{
"titulo": "Clinica Xyz",
"subitulo": "Contrato: 1202100012",
"valorTotal": 19150.5,
"periodos": [
{
"descricao": "Segunda quinzena",
"dataPagamento": "2024-05-01",
"valor": 10150,
"chavePagamento": "55555555:2024-05-01:101010"
},
{
"descricao": "Primeira quinzena",
"dataPagamento": "2024-05-01",
"valor": 9000.95,
"chavePagamento": "55555555:2024-05-01:101010"
}
]
},
{
"ano": 2024,
"mes": 3,
"valorTotal": 20003.96,
"periodos": [
{
"descricao": "Segunda quinzena",
"dataPagamento": "2024-04-01",
"valor": 11003.01,
"chavePagamento": "55555555:2024-04-01:101010"
},
{
"descricao": "Primeira quinzena",
"dataPagamento": "2024-04-01",
"valor": 9000.95,
"chavePagamento": "55555555:2024-04-01:101010"
}
]
}
]
} |
Descrição dos objetos e atributos de retorno - falha
| Aviso |
|---|
|
...
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 | ||
|---|---|---|
| ||
{
"mensagem": "Não foi possível obter os detalhes deste débito. Por favor, entre em contato com suporte."
} |
...