Este documento tem como objetivo demonstrar a utilização dos endpoints de títulos de cobrança do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
Esses endpoints são utilizados na nova tela de posição do beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
Clique aqui para detalhes sobre como habilitar o serviço de APIs
Retorna o histórico de títulos de cobrança do beneficiário.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/titles |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| SubscriberId (path) |
| Número da carteirinha do beneficiário | *required |
| status (query) |
| Filtro dos títulos pelo status, sendo:
| |
| initialDate (query) |
| data inicial dos títulos: 'AAAA-MM-DD' | |
| finalDate (query) |
| data final dos títulos: 'AAAA-MM-DD' | |
| page (query) |
| Paginação da Coleção | |
| pageSize (query) |
| Quantidade de Itens por Página | |
| order (query) |
| Ordenação da Coleção | |
| fields (query) |
| Filtro de campos dos registros | |
| filter (query) |
| Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
Não possui body!
items |
| Títulos de Cobrança do beneficiário |
| items.{campo do SX3} |
| Os campos retornados da tabela SE1:
|
| items.status |
| Status do título, sendo: Aberto (A), Baixado Parcial (P), Baixado (B) |
| items.titleid |
| Chave identificador do título para ser utilizado nos endpoints:
|
| totalValues |
| Valor total de todos os títulos encontrado |
| struct |
| Estrutura dos fields de acordo com o dicionário de dados (SX3) |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"items": [
{
"e1_prefixo": "PLS",
"e1_num": "000007042",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 419,
"e1_baixa": "2022-10-17",
"e1_saldo": 0,
"e1_valliq": 419,
"status": "B",
"titleid": "PLS000007042 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007043",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 399,
"e1_baixa": "2022-10-17",
"e1_saldo": 200,
"e1_valliq": 199,
"status": "P",
"titleid": "PLS000007043 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007044",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 399,
"e1_baixa": "",
"e1_saldo": 399,
"e1_valliq": 0,
"status": "A",
"titleid": "PLS000007044 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007045",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 399,
"e1_baixa": "2022-10-17",
"e1_saldo": 0,
"e1_valliq": 399,
"status": "B",
"titleid": "PLS000007045 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007046",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 399,
"e1_baixa": "2022-10-17",
"e1_saldo": 309,
"e1_valliq": 90,
"status": "P",
"titleid": "PLS000007046 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007047",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 475,
"e1_baixa": "2022-11-16",
"e1_saldo": 172.54,
"e1_valliq": 252.46,
"status": "P",
"titleid": "PLS000007047 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007048",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 475,
"e1_baixa": "2022-10-17",
"e1_saldo": 0,
"e1_valliq": 475,
"status": "B",
"titleid": "PLS000007048 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007049",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-17",
"e1_valor": 475,
"e1_baixa": "2022-11-12",
"e1_saldo": 265,
"e1_valliq": 200,
"status": "P",
"titleid": "PLS000007049 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007050",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-24",
"e1_valor": 475,
"e1_baixa": "",
"e1_saldo": 475,
"e1_valliq": 0,
"status": "A",
"titleid": "PLS000007050 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007051",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-10-24",
"e1_valor": 475,
"e1_baixa": "2022-10-17",
"e1_saldo": 0,
"e1_valliq": 475,
"status": "B",
"titleid": "PLS000007051 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007052",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-11-23",
"e1_valor": 475,
"e1_baixa": "2022-11-12",
"e1_saldo": 85,
"e1_valliq": 200,
"status": "P",
"titleid": "PLS000007052 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007053",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-12-23",
"e1_valor": 475,
"e1_baixa": "",
"e1_saldo": 475,
"e1_valliq": 0,
"status": "A",
"titleid": "PLS000007053 DP"
},
{
"e1_prefixo": "UNI",
"e1_num": "TFC01B",
"e1_parcela": "",
"e1_tipo": "NF",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2023-1-23",
"e1_valor": 475,
"e1_baixa": "",
"e1_saldo": 475,
"e1_valliq": 0,
"status": "A",
"titleid": "UNITFC01B NF"
}
],
"hasNext": false,
"remainingRecords": 0,
"struct": [
{
"field": "E1_PREFIXO",
"type": "C",
"title": "Prefixo",
"description": "Prefixo do titulo",
"picture": "@!",
"size": 3,
"decimals": 0,
"cbox": []
},
{
"field": "E1_NUM",
"type": "C",
"title": "No. Titulo",
"description": "Numero do Titulo",
"picture": "@!",
"size": 9,
"decimals": 0,
"cbox": []
},
{
"field": "E1_PARCELA",
"type": "C",
"title": "Parcela",
"description": "Parcela do Titulo",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": []
},
{
"field": "E1_TIPO",
"type": "C",
"title": "Tipo",
"description": "Tipo do titulo",
"picture": "@!",
"size": 3,
"decimals": 0,
"cbox": []
},
{
"field": "E1_CLIENTE",
"type": "C",
"title": "Cliente",
"description": "Codigo do Cliente",
"picture": "@!",
"size": 6,
"decimals": 0,
"cbox": []
},
{
"field": "E1_LOJA",
"type": "C",
"title": "Loja",
"description": "Loja do Cliente",
"picture": "@!",
"size": 2,
"decimals": 0,
"cbox": []
},
{
"field": "E1_NOMCLI",
"type": "C",
"title": "Nome Cliente",
"description": "Nome Reduzido do Cliente",
"picture": "@!",
"size": 20,
"decimals": 0,
"cbox": []
},
{
"field": "E1_VENCREA",
"type": "D",
"title": "Vencto real",
"description": "Vencimento real do Titulo",
"picture": "",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "E1_VALOR",
"type": "N",
"title": "Vlr.Titulo",
"description": "Valor do Titulo",
"picture": "@E 9,999,999,999,999.99",
"size": 16,
"decimals": 2,
"cbox": []
},
{
"field": "E1_BAIXA",
"type": "D",
"title": "DT Baixa",
"description": "Data de Baixa do Titulo",
"picture": "",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "E1_SALDO",
"type": "N",
"title": "Saldo",
"description": "Saldo a Receber",
"picture": "@E 9,999,999,999,999.99",
"size": 16,
"decimals": 2,
"cbox": []
},
{
"field": "E1_VALLIQ",
"type": "N",
"title": "Vlr.Liq Baix",
"description": "Valor Liquido da Baixa",
"picture": "@E 9,999,999,999,999.99",
"size": 16,
"decimals": 2,
"cbox": []
}
],
"totalValues": 5815
} |
code |
| Código identificador do erro. (Tabela de Erros) |
message |
| Literal no idioma da requisição descrevendo o erro para o usuário. |
detailedMessage |
| Mensagem técnica e mais detalhada do erro. |
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
} |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| MV_PLSEXTP | Inclua a descrição relacionada |
| MV_PLTITAB | Inclua a descrição relacionada |
| MV_PLTITBX | Inclua a descrição relacionada |
