Histórico da Página

...

Retorna a composição do Título no PLS (Tabela BM1)

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/compositions

Image Modified

Parâmetros

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
titleId (path)	Image Modified	Chave identificador do título retornado no endpoint:/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/titles Atributo: titleId	*required
fields (query)	Image Modified	Filtro de campos dos registros

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

collectionNumber	Image Modified	Numero do lote de cobrança que o título foi gerado Campo: BM1_PLNUCO
month	Image Modified	Mês de cobrança do título Campo: BM1_MES
year	Image Modified	Ano de cobrança do título Campo: BM1_ANO
debts	Image Modified	Valor total de débitos do título Campo: BM1_VALOR
credits	Image Modified	Valor total de créditos do título Campo: BM1_VALOR
amount	Image Modified	Valor total de crédito e débito Campo: BM1_VALOR
amountType	Image Modified	Tipo do valor total, sendo Débito ou Crédito.
beneficiaries	Image Modified	Beneficiários vinculados ao título
beneficiaries.subscriberId	Image Modified	Carteirinha do beneficiário Campo: BM1_MATUSU
beneficiaries.name	Image Modified	Nome do beneficiário Campo: BM1_NOMUSR
beneficiaries.compositions	Image Modified	Composição do título do beneficiário
beneficiaries.compositions.typeCode	Image Modified	Código do lançamento do faturamento Campo: BM1_CODTIP
beneficiaries.compositions.typeDescription	Image Modified	Descrição do lançamento do faturamento Campo: BM1_DESTIP
beneficiaries.compositions.type	Image Modified	Tipo do lançamento, sendo Débito ou Crédito. Campo: BM1_TIPO
beneficiaries.compositions.value	Image Modified	Valor da composição do lançamento Campo: BM1_VALOR

Bloco de código

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

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

...

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": "E002",
  "message": "Composição do título não encontrado.",
  "detailedMessage": "Não foi encontrado nenhuma composição para o título PLS000007022 DP"
}

...

Retorna o pdf do boleto do título em base 64

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/pdf

Image Modified

Parâmetros

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

titleId (path)

Image Modified

Chave identificador do título retornado no endpoint:/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/titles

Atributo: titleId

*required

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

documentNumber

Image Modified

Número do título

Campo: E1_NUM

base64

Image Modified

PDF do título no formato base 64

Bloco de código

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

{
	"documentNumber": "000007042",
	"base64": "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlw..."
}

...

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": "E004",
  "message": "Título não encontrado.",
  "detailedMessage": "Não foi encontrado no contas a receber (Financeiro) o título PLS000007022 DP"
}

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 TÍTULOS DE COBRANÇA DO BENEFICIÁRIO

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)

Tabela de Código de Erros

03. TELA TÍTULOS DE COBRANÇA DO BENEFICIÁRIO