Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Valor de Cobrança
2. Tabela de Códigos de Erros
Tela Valor de Cobrança
1. Outras Ações / Ações relacionadas
Tela Valor de Cobrança
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização do endpoint de valor de cobrança do beneficiários, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).

/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/billing

Esse endpoint será utilizado 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

02. EXEMPLO DE UTILIZAÇÃO

Valor de Cobrança

Retorna a composição do valor de cobrança a ser faturado ou já faturado da família do beneficiário.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/billing

Image Modified

Parâmetros

SubscriberId (path)	Image Modified	Número da carteirinha do beneficiário	*required
Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required
baseMonth (query)	Image Modified	Mês base do valor de cobrança	*required
baseYear (query)	Image Modified	Ano base do valor de cobrança	*required
billingType (query)	Image Modified	Tipo de cobrança a ser retornada, sendo: 1 = Cobrança a Faturar 2 = Cobrança já Faturado	*required

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

collectionNumber

Image Added

Número do Lote de cobrança gerado

Atributo retornado somente no tipo 2 = Cobrança já Faturado

title

Image Added

Chave do título gerado: E1_PREFIXO, E1_NUM, E1_PARCELA, E1_TIPO

Atributo retornado somente no tipo 2 = Cobrança já Faturado

credits

Image Modified

Valor total de créditos da cobrança

do

da família para mês/ano informado

do beneficiário


debts	Image Modified	Valor total de créditos da cobrança da família para mês/ano informado
familyAmount	Image Modified
employerCredits	Image Modified
employerDebts	Image Modified
employerAmount	Image Modified
amount	Image Modified
amountType	Image Modified
beneficiaries	Image Modified
beneficiaries.subscriberId	Image Modified
beneficiaries.name	Image Modified
beneficiaries.amount	Image Modified
beneficiaries.compositions	Image Modified
beneficiaries.compositions.typeCode	Image Modified
beneficiaries.compositions.typeDescription	Image Modified
beneficiaries.compositions.type	Image Modified
beneficiaries.compositions.retroactive	Image Modified
beneficiaries.compositions.value	Image Modified
beneficiaries.compositions.observation	Image Modified
beneficiaries.compositions.product	Image Modified
beneficiaries.compositions.outputType	Image Modified
accumulated	Image Modified
accumulated.type	Image Modified
accumulated.balance1	Image Modified
accumulated.balance2	Image Modified

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (A Faturar)
linenumbers	true
collapse	true

{
  "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"
        }
      ]
    }
  ],
  "accumulated": [
    {
      "type": "[151] - Serv. Aux. (SADT) (CO-P.)",
      "balance1": "50.00",
      "balance2": "10.00"
    }
  ]
}

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Já Faturado)
linenumbers	true
collapse	true

{
  "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": []
}

...

Dados Inválidos (404)

code	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

Tabela de Código de Erros

Código de erros informado no Json de retorno com falha (404):

Code	message	detailedMessage
E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}
E002	Composição do título não encontrado.	Não foi encontrado nenhuma composição para o título {titleId}
E003	Não permitido a geração do PDF	Não é permitido gerar o pdf para o status atual do título {titleId}
E004	Título não encontrado.	Não foi encontrado no contas a receber (Financeiro) o título {titleId}

03. TELA VALOR DE COBRANÇA

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Valor de Cobrança

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)

Tabela de Código de Erros

03. TELA VALOR DE COBRANÇA