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).
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
Retorna a composição do valor de cobrança a ser faturado ou já faturado da família do beneficiário.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/billing |
|
| 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:
| *required |
Não possui body!
| collectionNumber |
| Número do Lote de cobrança gerado Atributo retornado somente no tipo 2 = Cobrança já Faturado |
| title |
| Chave do título gerado: E1_PREFIXO, E1_NUM, E1_PARCELA, E1_TIPO Atributo retornado somente no tipo 2 = Cobrança já Faturado |
credits |
| Valor total de créditos da cobrança da família para mês/ano informado |
| debts |
| Valor total de créditos da cobrança da família para mês/ano informado |
| familyAmount |
| |
| employerCredits |
| |
| employerDebts |
| |
| employerAmount |
| |
| amount |
| |
| amountType |
| |
| beneficiaries |
| |
| beneficiaries.subscriberId |
| |
| beneficiaries.name |
| |
| beneficiaries.amount |
| |
| beneficiaries.compositions |
| |
| beneficiaries.compositions.typeCode |
| |
| beneficiaries.compositions.typeDescription |
| |
| beneficiaries.compositions.type |
| |
| beneficiaries.compositions.retroactive |
| |
| beneficiaries.compositions.value |
| |
| beneficiaries.compositions.observation |
| |
| beneficiaries.compositions.product |
| |
| beneficiaries.compositions.outputType |
| |
| accumulated |
| |
| accumulated.type |
| |
| accumulated.balance1 |
| |
| accumulated.balance2 |
|
{
"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"
}
]
} |
{
"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": []
} |
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"
} |
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} |
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 |
|---|---|
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
