Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela api titles
1. Outras Ações / Ações relacionadas
Tela api titles
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade titles (títulos) do produto TOTVS Saúde Planos Linha Protheus.

...

Dica

title	Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Informações

title	Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase ou tudo minúsculo separado por hífen para o query param e o json do body.

02. EXEMPLO DE UTILIZAÇÃO

Âncora

	titles
	titles

Painel

titleColor	Orange
borderStyle	solid
title	Titles - Retorna os títulos dos beneficiários/empresas

Retorna os títulos da empresa ou do beneficiário no Financeiro (Contas a receber).

/totvsHealthPlans/invoicing/v1/titles

GET

Nota

Status do título (E1_STATUS)

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	*

requiredhealth-insurer-code

required
healthInsurerCode (query)	string	Código da operadora (E1_CODINT)	*required

company-code

(Quando o subcriberId não for informado)
companyCode (query)	string	Código da empresa (E1_CODEMP)	*required

family-code

(Quando o subcriberId não for informado)
subscriberId (query)	string	Matricula

da família (

do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)

familyCode (query)

string

Matricula da família (E1_MATRIC)

Obs: Filtro para títulos referente a família do beneficiário.

contract-code

contractCode (query)

string

Contrato da empresa (E1_CONEMP)

Obs: Filtro para títulos referente a empresa

contract-version-code

contractVersionCode (query)

string

Versão do contrato (E1_VERCON)

Obs: Filtro para títulos referente a empresa

subcontract-code

subcontractCode (query)

string

Subcontrato do contrato da empresa (E1_SUBCON)

Obs: Filtro para títulos referente a empresa

subcontract-version-code


subcontractVersionCode (query)	string	Versão do subcontrato (E1_VERSUB) Obs: Filtro para títulos referente a empresa
type (query)	string	Tipo do título (E1_TIPO), pode ser enviado mais de um tipo. Ex: NCC,DP
status

(query)

string

Status do título (E1_STATUS)

situation (query)

string

FIltro dos títulos pela situação, sendo:

0 = Carteira
1 = Cob.Simples
2 = Descontada
3 = Caucionada
4 = Vinculada
5 = Advogado;6=Judicial

Pode ser informado mais de uma situação, ex: 2,3,4

string


page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	integer	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de títulos retornados	*required
items.customer-_id	string	Código	E1_CLIENTE	*required
items.customer-_store	string	Descrição	E1_LOJA	*required
items.customer-_name	string	Tipo de grupo (Pessoa física ou jurídica)	E1_NOMCLI	*required
items.issue-_date	string (date)	Data de Emissão do Titulo	E1_EMISSAO	*required
items.prefix	string	Prefixo do titulo	E1_PREFIXO*required
items.number	string	Numero do Titulo	E1_NUM	*required
items.parcel	string	Parcela do Titulo	E1_PARCELA	*required
items.type	string	Tipo do titulo	E1_TIPO	*required
items.base-_month	string	Mês Base	E1_MESBASE	*required
items.base-_year	string	Ano Base	E1_ANOBASE	*required
items.real-_due-_date	string (date)	Vencimento real do Titulo	E1_VENCREA	*required
items.amount	number (double)	Valor do Titulo	E1_VALOR	*required
items.balance	number (double)	Saldo a Receber	E1_SALDO	*required
items.net-_value	number (double)	Valor Liquido da Baixa	E1_VALLIQ	*required
items.low-_date	string (date)	Data de Baixa do Titulo	E1_BAIXA*requiredBAIXA
items.status	string	Status do Titulo	E1_STATUS		Sendo: A = Aberto P = Baixado Parcial B = Baixado *required
items.title-_id	string	Chave de busca do Titulo	E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO	*required
items.situation	string	Situação do titulo	E1_SITUACA
items.links	array	links relacionados ao recurso títles (Padrão HATEOAS): rel: bankSlip rel: bankSlip/base64		*required

Bloco de código

language	c#
theme	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "customer-_id": "PLS103",
            "customer-_store": "01",
            "customer-_name": "ARTHUR E BETINA PAES",
            "issue-_date": "2021-04-05",
            "prefix": "PLS",
            "number": "000007027",
            "parcel": "",
            "type": "DP",
            "base-_month": "04",
            "base-_year": "2021",
            "real-_due-_date": "2021-04-26",
            "amount": 30351.4,
            "balance": 0,
            "net-_value": 28541.08,
            "low-_date": "2022-12-20",
            "status": "B",
            "title-id_id": "PLS000007027+DP",
			"situation": "PLS000007027+DP1",
            "links": [
                {
                    "rel": "bankSlip",
                    "href": "/totvsHealthPlans/invoicing/v1/titles/PLS000007027+DP/bankSlip"
                },
                {
                    "rel": "bankSlip/base64",
                    "href": "/totvsHealthPlans/invoicing/v1/titles/PLS000007027+DP/bankSlip/base64"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 11
}

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	RDarkEmacs
title	Exemplo
linenumbers	true

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

...

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

*requiredCNPJ

digitableLine	string	Linha digitável	*required
dueDate	string (date)	Vencimento	*required
documentDate	string (date)	Data do Documento	*required
documentNumber	string	Nro.Documento
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		*requiredCNPJ
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	RDarkEmacs
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	RDarkEmacs
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	RDarkEmacs
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	RDarkEmacs
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."
}

...

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	RDarkEmacs
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	RDarkEmacs
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	RDarkEmacs
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	RDarkEmacs
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

Ação	Descrição
Não se aplica	Não se aplica

04. TELA API TITLES

Principais Campos e Parâmetros

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)
Bancos (SA6)
Operadoras de Saúde (BA0)
Clientes (SA1)
Composição da Cobrança (BM1)
Cabeçalho de Mensagem (BH1)
Itens de Mensagem (BH2)
Beneficiários (BA1)
Eventos Processamentos Contas (BD6)

...

Árvore de páginas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA API TITLES

04. TELA API TITLES

05. TABELAS UTILIZADAS