Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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) 

...

Bloco de código
languagec#
themeMidnight
titleExemplo de retorno - Sucesso (Já Faturado)
linenumberstrue
collapsetrue
{
   "baseMonth":"12",
   "baseYear":"2022",
   "billsToBill":{
      "credits":0,
      "debts":0,
      "familyAmount":0,
      "employerCredits":0,
      "employerDebts":0,
      "employerAmount":0,
      "amount":0,
      "amountType":"D",
      "beneficiaries":[
         
      ],
      "accumulated":[
         
      ]
   },
   "billsAlreadyBilled":{
      "collectionNumber":"000100000232",
      "title":"PLS000007052 DP",
      "credits":0,
      "debts":475,
      "employerCredits":0,
      "employerDebts":0,
      "amount":475,
      "amountType":"D",
      "beneficiaries":[
         {
            "subscriberId":"00011008000027010",
            "name":"HERNANDES ALVES DA SILVA",
            "amount":196,
            "compositions":[
               {
                  "typeCode":"101",
                  "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
                  "type":"Débito",
                  "retroactive":"Não",
                  "value":196,
                  "observation":"21",
                  "product":"000000000000000000000000000035",
                  "outputType":"501"
               }
            ]
         },
         {
            "subscriberId":"00011008000027028",
            "name":"FABIANA SOPHIA MELO",
            "amount":279,
            "compositions":[
               {
                  "typeCode":"101",
                  "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
                  "type":"Débito",
                  "retroactive":"Não",
                  "value":279,
                  "observation":"35",
                  "product":"000000000000000000000000000035",
                  "outputType":"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.

...

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
E003Falha ao processar a CobrançaNã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

...