Histórico da Página
...
Esse endpoint será utilizado na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
...
SubscriberId (path) | Número da carteirinha do beneficiário | *required | |||||
Authorization (header) | Cabeçalho usado para autorização das requisições | *required | |||||
Content-Type (header) | 'application/json' é o formato do conteúdo | *required | |||||
baseMonth (query) | Mês base do valor de cobrança | *required | |||||
baseYear (query) | Ano base do valor de cobrança | *required | billingType (query) | Tipo de cobrança a ser retornada, sendo: 1 = Cobrança a Faturar | *required | ||
fields (query) | Filtro de campos dos registros |
...
Operação realizada com sucesso (200)
collectionNumberbaseMonth | Número do Lote de cobrança gerado Atributo retornado somente no tipo 2 = Cobrança já Faturado | |
title | Número do título de cobrança Atributo retornado somente no tipo 2 = Cobrança já Faturado Campo: E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO | |
Mês base da cobrança | ||
baseYear | Ano base da cobrança | |
billsToBill | Cobrança à faturar | |
billsToBill.credits | Valor total de créditos para mês/ano informado | |
billsToBill.debts | Valor total de débitos para mês/ano informado | |
billsToBill.familyAmount | Valor total da família para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar | |
billsToBill.employerCredits | Valor total de crédito patronal para mês/ano informado | |
billsToBill.employerDebts | Valor total de débito patronal para mês/ano informado | |
billsToBill.employerAmount | Valor total patronal para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar | |
amountbillsToBill.amount | Valor total da cobrança para mês/ano informado | |
billsToBill.amountType | Tipo do valor total da cobrança, sendo D (Débito) ou C (Crédito) | |
billsToBill.beneficiaries | Beneficiários da cobrança | |
billsToBill.beneficiaries.subscriberId | Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | |
billsToBill.beneficiaries.name | Nome do beneficiário Campo: BA1_NOMUSR | |
billsToBill.beneficiaries.amount | Valor total do beneficiário na cobrança | |
billsToBill.beneficiaries.compositions | Composição do beneficiário | |
billsToBill.beneficiaries.compositions.typeCode | Código do tipo de lançamento de faturamento | |
billsToBill.beneficiaries.compositions.typeDescription | Descrição do lançamento de faturamento | |
billsToBill.beneficiaries.compositions.type | Tipo do lançamento, sendo Débito ou Crédito | |
billsToBill.beneficiaries.compositions.retroactive | Indica se o lançamento de faturamento é do tipo retroativo. (Sim ou Não) Os lançamentos retroativos são: 118 e 146 | |
billsToBill.beneficiaries.compositions.value | Valor do lançamento na composição. | |
billsToBill.beneficiaries.compositions.observation | Observação do lançamento, podendo ser retornado a idade do beneficiário, cobrança pro-rata etc. | |
billsToBill.beneficiaries.compositions.product | Código do Produto da nota fiscal (SB1). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1). | |
billsToBill.beneficiaries.compositions.outputType | Tipo de saída da nota fiscal (TES). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1). | |
billsToBill.accumulated | Valores acumulados dos beneficiários | |
billsToBill.accumulated.type | Tipo do Lançamento | |
billsToBill.accumulated.balance1 | Saldo 1 | |
billsToBill.accumulated.balance2 | Saldo 2 |
...
billsAlreadyBilled | Cobrança já faturada | |
billsAlreadyBilled.collectionNumber | Número do Lote de cobrança gerado | |
billsAlreadyBilled.title | Número do título de cobrança Campo: E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO | |
billsAlreadyBilled.credits | Valor total de créditos para mês/ano informado | |
billsAlreadyBilled.debts | Valor total de débitos para mês/ano informado | |
billsAlreadyBilled.employerCredits | Valor total de crédito patronal para mês/ano informado | |
billsAlreadyBilled.employerDebts | Valor total de débito patronal para mês/ano informado | |
billsAlreadyBilled.employerAmount | Valor total patronal para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar | |
billsAlreadyBilled.amount | Valor total da cobrança para mês/ano informado | |
billsAlreadyBilled.amountType | Tipo do valor total da cobrança, sendo D (Débito) ou C (Crédito) | |
billsAlreadyBilled.beneficiaries | Beneficiários da cobrança | |
billsAlreadyBilled.beneficiaries.subscriberId | Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | |
billsAlreadyBilled.beneficiaries.name | Nome do beneficiário Campo: BA1_NOMUSR | |
billsAlreadyBilled.beneficiaries.amount | Valor total do beneficiário na cobrança | |
billsAlreadyBilled.beneficiaries.compositions | Composição do beneficiário | |
billsAlreadyBilled.beneficiaries.compositions.typeCode | Código do tipo de lançamento de faturamento | |
billsAlreadyBilled.beneficiaries.compositions.typeDescription | Descrição do lançamento de faturamento | |
billsAlreadyBilled.beneficiaries.compositions.type | Tipo do lançamento, sendo Débito ou Crédito | |
billsAlreadyBilled.beneficiaries.compositions.retroactive | Indica se o lançamento de faturamento é do tipo retroativo. (Sim ou Não) Os lançamentos retroativos são: 118 e 146 | |
billsAlreadyBilled.beneficiaries.compositions.value | Valor do lançamento na composição. | |
billsAlreadyBilled.beneficiaries.compositions.observation | Observação do lançamento, podendo ser retornado a idade do beneficiário, cobrança pro-rata etc. | |
billsAlreadyBilled.beneficiaries.compositions.product | Código do Produto da nota fiscal (SB1). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1). | |
billsAlreadyBilled.beneficiaries.compositions.outputType | Tipo de saída da nota fiscal (TES). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1). | |
billsAlreadyBilled.accumulated | Valores acumulados dos beneficiários | |
billsAlreadyBilled.accumulated.type | Tipo do Lançamento | |
billsAlreadyBilled.accumulated.balance1 | Saldo 1 | |
billsAlreadyBilled.accumulated.balance2 | Saldo 2 |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"baseMonth":"12",
"baseYear":"2023",
"billsToBill":{
"credits":50,
"debts":810,
"familyAmount":760,
"employerCredits":0,
"employerDebts":0,
"employerAmount":0,
"amount":760,
"amountType":"D",
"beneficiaries":[
{
"subscriberId":"00011008000030010",
"name":"NOAH CAIO BRITO",
"amount":440,
"compositions":[
{
"typeCode":"101",
"typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
"type":"Débito",
"retroactive":"Não",
"value":480,
"observation":"60",
"product":"000000000000000000000000000035",
"outputType":"501"
},
{
"typeCode":"103",
"typeDescription":"TAXA INSCRICAO/ADESAO",
"type":"Débito",
"retroactive":"Não",
"value":10,
"observation":"60",
"product":"000000000000000000000000000035",
"outputType":"501"
},
{
"typeCode":"130",
"typeDescription":"CREDITO SERV ACESSORIO",
"type":"Crédito",
"retroactive":"Não",
"value":50,
"observation":"",
"product":"000000000000000000000000000035",
"outputType":"501"
}
]
},
{
"subscriberId":"00011008000030029",
"name":"CAUE MATEUS FILIPE PEREIRA",
"amount":320,
"compositions":[
{
"typeCode":"101",
"typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
"type":"Débito",
"retroactive":"Não",
"value":310,
"observation":"42",
"product":"000000000000000000000000000035",
"outputType":"501"
},
{
"typeCode":"103",
"typeDescription":"TAXA INSCRICAO/ADESAO",
"type":"Débito",
"retroactive":"Não",
"value":10,
"observation":"42",
"product":"000000000000000000000000000035",
"outputType":"501"
} | ||||||||||
| ||||||||||
{ "credits": 50, "debts": 810, "familyAmount": 760, "employerCredits": 0, "employerDebts": 0, "employerAmount": 0, "amount": 760, "amountType": "D", "beneficiaries": [ { "subscriberId": "00011008000030010", "name": "NOAH CAIO BRITO", "amount": 440, "compositions": [ { "typeCode": "101", "typeDescription": "PRODUTO/PLANO (MENSALIDADE)", ] } "type": "Débito", ], "retroactiveaccumulated": "Não",[ { "value": 480, "observationtype":"[151] - Serv. "60", Aux. (SADT) (CO-P.)", "productbalance1": "00000000000000000000000000003550.00", "outputTypebalance2": "50110.00" }, ] {}, "billsAlreadyBilled":{ "typeCodecollectionNumber": "103", "typeDescriptiontitle": "TAXA INSCRICAO/ADESAO", "credits":0, "typedebts": "Débito"0, "retroactiveemployerCredits": "Não"0, "valueemployerDebts": 100, "observationamount": "60"0, "productamountType": "000000000000000000000000000035D", "outputTypebeneficiaries":[ "501" }, { ], "typeCodeaccumulated": "130",[ "typeDescription": "CREDITO SERV ACESSORIO", ] } } |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "typebaseMonth": "Crédito12", "retroactivebaseYear": "Não2022", "valuebillsToBill": 50,{ "observationcredits": ""0, "productdebts": "000000000000000000000000000035"0, "outputTypefamilyAmount": "501" 0, }"employerCredits":0, ] "employerDebts":0, }"employerAmount":0, {"amount":0, "subscriberIdamountType": "00011008000030029D", "namebeneficiaries": "CAUE MATEUS FILIPE PEREIRA",[ "amount": 320], "compositionsaccumulated": [ { ] }, "typeCodebillsAlreadyBilled": "101", { "typeDescriptioncollectionNumber": "PRODUTO/PLANO (MENSALIDADE)"000100000232", "typetitle":"PLS000007052 "DébitoDP", "credits":0, "retroactivedebts": "Não"475, "valueemployerCredits": 3100, "observationemployerDebts": "42"0, "productamount": "000000000000000000000000000035"475, "outputTypeamountType": "501" }D", { "beneficiaries":[ "typeCode": "103", { "typeDescriptionsubscriberId": "TAXA INSCRICAO/ADESAO00011008000027010", "typename": "Débito"HERNANDES ALVES DA SILVA", "retroactiveamount": "Não"196, "valuecompositions":[ 10, "observation": "42", { "product": "000000000000000000000000000035", "outputTypetypeCode": "501101", } ] } ], "accumulatedtypeDescription": ["PRODUTO/PLANO (MENSALIDADE)", { "type": "[151] - Serv. Aux. (SADT) (CO-P.)", "balance1type": "50.00Débito", "balance2": "10.00" } ] } | ||||||||||
Bloco de código | ||||||||||
| ||||||||||
{ "collectionNumberretroactive": "000100000232Não", "title": "PLS000007052 DP", "creditsvalue": 0196, "debts": 475, "employerCredits": 0, "employerDebts": 0, "amount": 475, "amountType": "D", "beneficiaries": [ { "observation":"21", "product":"000000000000000000000000000035", "subscriberIdoutputType": "00011008000027010501", "name": "HERNANDES ALVES DA SILVA", } "amount": 196, ] "compositions": [ }, { "typeCodesubscriberId": "10100011008000027028", "typeDescriptionname": "PRODUTO/PLANO (MENSALIDADE)"FABIANA SOPHIA MELO", "typeamount": "Débito"279, "retroactivecompositions":[ "Não", "value": 196, { "observation": "21", "producttypeCode": "000000000000000000000000000035101", "outputTypetypeDescription":"PRODUTO/PLANO (MENSALIDADE)"501" , } ] "type":"Débito", }, { "subscriberIdretroactive": "00011008000027028Não", "name": "FABIANA SOPHIA MELO", "amountvalue": 279, "compositions": [ { "observation":"35", "typeCode": "101", "typeDescriptionproduct": "PRODUTO/PLANO (MENSALIDADE)"000000000000000000000000000035", "type": "Débito", "retroactiveoutputType": "Não501", "value": 279, } "observation": "35", ] } "product": "000000000000000000000000000035", ], "outputTypeaccumulated": "501" [ } ] } ], "accumulated": [] } } |
...
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "code": "E003", "message": "SemFalha ao Cobrançaprocessar a FaturarCobrança", "detailedMessage": "Não existe nenhuma foi possivel processar o valor de cobrança ado serbeneficiário, faturadoverifique paraas oconfigurações mêsde efaturamento anoda informadocobrança." } |
Tabela de Código de Erros
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 | Parâmetros obrigatórios | Obrigatório informar o ano base |
e mês base |
400 | |
E003 |
Nenhuma Cobrança já Faturada
Não existe nenhuma cobrança já faturada para o mês e ano informado.
Não existe nenhuma cobrança a ser faturado para o mês e ano informado.
Falha ao processar a Cobrança | Não foi possível processar o valor de cobrança do beneficiário, verifique as configurações de faturamento da cobrança. | 400 |
03. TELA VALOR DE COBRANÇA
...