Histórico da Página
...
Esses endpoints são utilizados na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
...
| 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:
Caso o status não seja informado, será retornado todos os status. | |
| allTitles (query) |
| Demais Títulos, inclusive títulos que não são de origem SIGAPLS
| |
| 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) |
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"items": [
{
"e1_prefixo": "PLS",
"e1_num": "000007023",
"e1_parcela": "",
"e1_tipo": "NCC",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2021-1-25",
"e1_valor": 200.01,
"e1_baixa": "2021-1-22",
"e1_saldo": 0,
"e1_valliq": 200.01,
"status": "B",
"latedays": 0,
"titleid": "PLS000007023 NCC"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007037",
"e1_parcela": "",
"e1_tipo": "NCC",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-1-25",
"e1_valor": 50,
"e1_baixa": "2022-1-19",
"e1_saldo": 0,
"e1_valliq": 50,
"status": "B",
"latedays": 0,
"titleid": "PLS000007037 NCC"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007038",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-2-25",
"e1_valor": 590,
"e1_baixa": "2022-1-19",
"e1_saldo": 0,
"e1_valliq": 590,
"status": "B",
"latedays": 0,
"titleid": "PLS000007038 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007038",
"e1_parcela": "",
"e1_tipo": "NCC",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-2-25",
"e1_valor": 50,
"e1_baixa": "2022-1-19",
"e1_saldo": 0,
"e1_valliq": 50,
"status": "B",
"latedays": 0,
"titleid": "PLS000007038 NCC"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007039",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-3-25",
"e1_valor": 590,
"e1_baixa": "",
"e1_saldo": 590,
"e1_valliq": 0,
"status": "A",
"latedays": 343,
"titleid": "PLS000007039 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "000007039",
"e1_parcela": "",
"e1_tipo": "NCC",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-3-25",
"e1_valor": 50,
"e1_baixa": "2022-1-19",
"e1_saldo": 0,
"e1_valliq": 50,
"status": "B",
"latedays": 0,
"titleid": "PLS000007039 NCC"
},
{
"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",
"latedays": 0,
"titleid": "PLS000007042 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",
"latedays": 137,
"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",
"latedays": 0,
"titleid": "PLS000007045 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": "",
"e1_saldo": 475,
"e1_valliq": 0,
"status": "A",
"latedays": 137,
"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",
"latedays": 0,
"titleid": "PLS000007048 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",
"latedays": 130,
"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",
"latedays": 0,
"titleid": "PLS000007051 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "242536471",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-11-24",
"e1_valor": 200,
"e1_baixa": "",
"e1_saldo": 200,
"e1_valliq": 0,
"status": "A",
"latedays": 99,
"titleid": "PLS242536471 DP"
},
{
"e1_prefixo": "PLS",
"e1_num": "365890285",
"e1_parcela": "",
"e1_tipo": "DP",
"e1_cliente": "TMSWBI",
"e1_loja": "01",
"e1_nomcli": "VITOR MIGUEL FREITAS",
"e1_vencrea": "2022-12-12",
"e1_valor": 300,
"e1_baixa": "",
"e1_saldo": 300,
"e1_valliq": 0,
"status": "A",
"latedays": 81,
"titleid": "PLS365890285 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",
"latedays": 70,
"titleid": "PLS000007053 DP"
}
],
"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": 5622.01
} |
...
...
Mensagens de Erros
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. |
...
| Informações | ||
|---|---|---|
| ||
A rotina antiga da Posição do Beneficiário possuía alguns pontos de entrada para customizar a busca dos títulos e ordenação, portanto foi criado os seguintes pontos de entrada: |
Composição do Título
Retorna a composição do Título no PLS (Tabela BM1)
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"collectionNumber": "00000232",
"month": "01",
"year": "2022",
"debts": 419,
"credits": 0,
"amount": 419,
"amountType": "Débito",
"beneficiaries": [
{
"subscriberId": "00011008000027010",
"name": "HERNANDES ALVES DA SILVA",
"compositions": [
{
"typeCode": "101",
"typeDescription": "Produto/Plano (Mensalidade)",
"type": "Débito",
"value": 120
},
{
"typeCode": "103",
"typeDescription": "Taxa Inscricao/Adesao",
"type": "Débito",
"value": 10
}
]
},
{
"subscriberId": "00011008000027028",
"name": "FABIANA SOPHIA MELO",
"compositions": [
{
"typeCode": "101",
"typeDescription": "Produto/Plano (Mensalidade)",
"type": "Débito",
"value": 279
},
{
"typeCode": "103",
"typeDescription": "Taxa Inscricao/Adesao",
"type": "Débito",
"value": 10
}
]
}
]
} |
...
...
Mensagens de Erros
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. |
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"documentNumber": "000007042",
"base64": "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlw..."
} |
...
...
Mensagens de Erros
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. |
...
Código de erros informado no Json de retorno com falha (404):
Code | message | detailedMessage | Status Code |
|---|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} | 404 |
| E002 | Composição do título não encontrado. | Não foi encontrado nenhuma composição para o título {titleId} | 404 |
| E003 | Não permitido a geração do PDF | Não é permitido gerar o pdf para o status atual do título {titleId} | 400 |
| E004 | Título não encontrado. | Não foi encontrado no contas a receber (Financeiro) o título {titleId} | 404 |
| E005 | Cliente financeiro sem cobrança. | Não foi encontrado nenhuma cobrança para o cliente financeiro do beneficiário de matricula {subscriberId} | 400 |
03. TELA TÍTULOS DE COBRANÇA DO BENEFICIÁRIO
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas