Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	BankSlip - Retorna os dados do boleto bancário

Retorna os dados no json do boleto bancário informado.

/totvsHealthPlans/invoicing/v1/titles/{titleId}/bankSlip

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
titleId (path)	string	Chave do Titulo (E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO)	*required
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
expand (query)	string	Lista com o nome das propriedades para expandir, descritos no campo *_expandables* da api.

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

digitableLine	string	Linha digitável	*required
dueDate	string (date)	Vencimento	*required
documentDate	string (date)	Data do Documento	*required
documentNumber	string	Nro.Documento	*required
documentType	string	Espécie Doc.	*required
acceptance	string	Aceite	*required
processingDate	string (date)	Data do Processamento	*required
documentValue	number (double)	(=)Valor do Documento	*required
otherAdditions	number (double)	(+)Outros Acréscimos	*required
discount	number (double)	(-)Desconto/Abatimento	*required
competenceMonth	string	Mês Competencia	*required
competenceYear	string	Ano Competencia	*required
assignor	object (json)	Operadora Saúde - Cedente do boleto	*required
assignor.name	string	Nome	*required
assignor.address	string	Endereço	*required
assignor.addressComplement	string	Complemento de Endereço	*required
assignor.district	string	Bairro	*required
assignor.cityCodeResidence	string	Cidade	*required
assignor.stateAbbreviation	string	Estado	*required
assignor.zipCode	string	CEP	*required
assignor.phoneNumber	string	Telefone	*required
assignor.cnpj	string	CNPJ	*required
assignor.codeSusep	string	Código SUSEP - ANS	*required
assignor.observation	string	Observação	*required
assignor.instructions	string	Instruções/Texto de responsabilidade do cedente	*required
drawee	object (json)	Recibo do Sacado	*required
drawee.name	string	Nome do Cliente	*required
drawee.code	string	Código do Cliente	*required
drawee.cpf	string	CPF (Para pessoa física)	*required
drawee.cnpj	string	CNPJ (Para pessoa jurídica)	*required
drawee.address	string	Endereço do Cliente	*required
drawee.district	string	Bairro do Cliente	*required
drawee.cityCodeResidence	string	Cidade	*required
drawee.stateAbbreviation	string	Estado	*required
drawee.zipCode	string	CEP	*required
bank	object (json)	Banco	*required
bank.name	string	Nome do Banco	*required
bank.code	string	Código do Banco	*required
bank.agencyAssignorCode	string	Agência/Código Cedente	*required
bank.ourNumber	string	Nosso Número	*required
bank.walletCode	string	Carteira	*required
_expandables	array	Propriedades expansíveis: billingDetails openMonths users userUsage
billingDetails	array	Detalhes da Cobrança dos beneficiários
billingDetails.subscriberId	string	Matricula do Beneficiário
billingDetails.name	string	Nome do Beneficiário
billingDetails.compositions	array	Composições do título do Beneficiário
billingDetails.compositions.typeCode	string	Código do lançamento
billingDetails.compositions.typeDescription	string	Descrição do lançamento
billingDetails.compositions.value	number (double)	Valor
billingDetails.compositions.numberANS	string	Número na ANS
openMonths	array	Meses em aberto
openMonths.month	string	Mês em aberto
openMonths.year	string	Ano em aberto
users	array	Usuários (Beneficiários da Família)
users.recordType	string	Tipo de Registro do Beneficiário
users.name	string	Nome do Beneficiário
users.effectiveDate	string (date)	Data de Inclusão
userUsage	array	Detalhes da Utilização
userUsage.subscriberName	string	Nome do Beneficiário
userUsage.healthProviderName	string	Nome da Rede de Atendimento
userUsage.procedureCode	string	Código do Procedimento
userUsage.procedureName	string	Descrição do Procedimento
userUsage.executionDate	string (date)	Data Utilização
userUsage.quantity	number (double)	Quantidade
userUsage.coPaymentValue	number (double)	Valor Total

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "digitableLine": "",
    "dueDate": "2022-10-17",
    "documentDate": "2023-05-26",
    "documentNumber": "000007042",
    "documentType": "R$",
    "acceptance": "N",
    "processingDate": "2022-10-17",
    "documentValue": 0,
    "otherAdditions": 0,
    "discount": 0,
    "competenceMonth": "01",
    "competenceYear": "2022",
    "assignor": {
        "name": "OPERADORA 417505",
        "address": "RUA COPACABANA",
        "addressComplement": "",
        "district": "SAO PAULO",
        "cityCodeResidence": "SAO PAULO",
        "stateAbbreviation": "SP",
        "zipCode": "02461000",
        "phoneNumber": "",
        "cnpj": "54097504000109",
        "codeSusep": "417505",
        "observation": "",
        "instructions": ""
    },
    "drawee": {
        "name": "VITOR MIGUEL FREITAS",
        "code": "TMSWBI",
        "cpf": "40492401810",
        "cnpj": "",
        "address": "ALBERT BARTHOLOME ,100",
        "district": "JARDIM DAS VERTENTES",
        "cityCodeResidence": "SAO PAULO",
        "stateAbbreviation": "SP",
        "zipCode": "05541000"
    },
    "bank": {
        "name": "BANCO DO PRE FA",
        "code": "-9",
        "agencyAssignorCode": "00001/0000000001",
        "ourNumber": "",
        "walletCode": "9"
    },
    "_expandables": [
        "billingDetails",
        "openMonths",
        "users",
        "userUsage"
    ]
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002-406",
            "message": "Chave titleId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave titleId."
        }
    ]
}

Aviso

Expandir

title	(404) - Titulo não encontrada

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E003",
    "message": "Título não encontrado no Financeiro",
    "detailedMessage": "Não foi encontrada na tabela SE1 o título PLS000007942 DP (E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO)."
}

Aviso

Expandir

title	(400) - Boleto não disponível

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E004",
    "message": "Boleto Bancário não disponível.",
    "detailedMessage": "O título PLS000007032 DP se encontra na situação em Carteira no Financeiro."
}

Âncora

	bankSlipBase64
	bankSlipBase64

Painel

titleColor	Orange
borderStyle	solid
title	BankSlip/Base64 - Retorna o boleto bancário em arquivo base 64

Retorna o boleto bancário informado em arquivo base 64.

/totvsHealthPlans/invoicing/v1/titles/{titleId}/bankSlip/base64

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
titleId (path)	string	Chave do Titulo (E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

fileName	string	Nome do arquivo em PDF		*required
file	string	String do arquivo em base 64		*required

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "fileName": "boletosc005630.pdf",
    "file": "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YW..."
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002-406",
            "message": "Chave titleId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave titleId."
        }
    ]
}

Aviso

Expandir

title	(404) - Titulo não encontrada

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E003",
    "message": "Título não encontrado no Financeiro",
    "detailedMessage": "Não foi encontrada na tabela SE1 o título PLS000007942 DP (E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO)."
}

Aviso

Expandir

title	(400) - Boleto não disponível

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

{
    "code": "E004",
    "message": "Boleto Bancário não disponível.",
    "detailedMessage": "O título PLS000007032 DP se encontra na situação em Carteira no Financeiro."
}

03. TELA API TITLES

Outras Ações / Ações relacionadas

...

Campo	Descrição
E1_CODINT	Código da operadora saúde
E1_CODEMP	Código da empresa
E1_MATRIC	Matricula da família
E1_PREFIXO	Prefixo do titulo
E1_NUM	Número do titulo
E1_PARCELA	Parcela do titulo
E1_TIPO	Tipo do titulo
MV_RELT	Diretório no servidor para gravar os boletos gerados pela api

05. TABELAS UTILIZADAS

Contas a Receber (SE1)

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

03. TELA API TITLES

05. TABELAS UTILIZADAS