...
Retorna a composição do Título no PLS (Tabela BM1)
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/compositions |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| titleId (path) |
| Chave identificador do título retornado no endpoint:/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/titles Atributo: titleId | *required |
| fields (query) |
| Filtro de campos dos registros |
...
Não possui body!
...
collectionNumber |
| Numero do lote de cobrança que o título foi gerado Campo: BM1_PLNUCO |
| month |
| Mês de cobrança do título Campo: BM1_MES |
| year |
| Ano de cobrança do título Campo: BM1_ANO |
| debts |
| Valor total de débitos do título Campo: BM1_VALOR |
| credits |
| Valor total de créditos do título Campo: BM1_VALOR |
| amount |
| Valor total de crédito e débito Campo: BM1_VALOR |
| amountType |
| Tipo do valor total, sendo Débito ou Crédito. |
| beneficiaries |
| Beneficiários vinculados ao título |
| beneficiaries.subscriberId |
| Carteirinha do beneficiário Campo: BM1_MATUSU |
| beneficiaries.name |
| Nome do beneficiário Campo: BM1_NOMUSR |
| beneficiaries.compositions |
| Composição do título do beneficiário |
| beneficiaries.compositions.typeCode |
| Código do lançamento do faturamento Campo: BM1_CODTIP |
| beneficiaries.compositions.typeDescription |
| Descrição do lançamento do faturamento Campo: BM1_DESTIP |
| beneficiaries.compositions.type |
| Tipo do lançamento, sendo Débito ou Crédito. Campo: BM1_TIPO |
| beneficiaries.compositions.value |
| Valor da composição do lançamento Campo: BM1_VALOR |
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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
}
]
}
]
} |
...
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": "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
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/titles/{titleId}/pdf |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| titleId (path) |
| Chave identificador do título retornado no endpoint:/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/titles Atributo: titleId | *required |
...
Não possui body!
...
documentNumber |
| Número do título Campo: E1_NUM |
| base64 |
| PDF do título no formato base 64 |
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"documentNumber": "000007042",
"base64": "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlw..."
} |
...
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": "E004",
"message": "Título não encontrado.",
"detailedMessage": "Não foi encontrado no contas a receber (Financeiro) o título PLS000007022 DP"
} |
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} |
...
