Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Titles - Retorna os títulos dos beneficiários/empresas
    2. BankSlip - Retorna os dados do boleto bancário
    3. BankSlip/Base64 - Retorna o boleto bancário em arquivo base 64
  3. Tela api titles
    1. Outras Ações / Ações relacionadas
  4. Tela api titles
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

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

...

Informações
titleNomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items


02. EXEMPLO DE UTILIZAÇÃO

Âncora
titles
titles

Painel
titleColorOrange
borderStylesolid
titleTitles - 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
Expandir
titleParameters
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
health-insurer-code (query)stringCódigo da operadora (E1_CODINT)*required
company-code (query)stringCódigo da empresa (E1_CODEMP)*required
family-code (query)string

Matricula da família (E1_MATRIC)

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


contract-code (query)string

Contrato da empresa (E1_CONEMP)

Obs: Filtro para títulos referente a empresa


contract-version-code (query)string

Versão do contrato (E1_VERCON)

Obs: Filtro para títulos referente a empresa


subcontract-code (query)string

Subcontrato do contrato da empresa (E1_SUBCON)

Obs: Filtro para títulos referente a empresa


subcontract-version-code (query)string

Versão do subcontrato (E1_VERSUB)

Obs: Filtro para títulos referente a empresa


type (query)stringTipo do título (E1_TIPO), pode ser enviado mais de um tipo. Ex: NCC,DP
status (query)stringStatus do título (E1_STATUS)
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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsintegerQuantidade de registros ainda existem para retorno
*required
itemsarrayLista de títulos retornados

items.customer-idstringCódigoE1_CLIENTE*required
items.customer-storestringDescriçãoE1_LOJA*required
items.customer-namestringTipo de grupo (Pessoa física ou jurídica)E1_NOMCLI
items.issue-datestring (date)Data de Emissão do TituloE1_EMISSAO*required
items.prefixstringPrefixo do tituloE1_PREFIXO
items.numberstringNumero do TituloE1_NUM*required
items.parcelstringParcela do TituloE1_PARCELA
items.typestringTipo do titulo           E1_TIPO*required
items.base-monthstringMês Base    E1_MESBASE
items.base-yearstringAno BaseE1_ANOBASE
items.real-due-datestring (date)Vencimento real do TituloE1_VENCREA*required
items.amountnumber (double)Valor do Titulo          E1_VALOR*required
items.balancenumber (double)Saldo a ReceberE1_SALDO
items.net-valuenumber (double)Valor Liquido da BaixaE1_VALLIQ
items.low-datestring (date)Data de Baixa do TituloE1_BAIXA
items.statusstringStatus do TituloE1_STATUS
items.title-idstringChave de busca do TituloE1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO*required
items.linksarray

links relacionados ao recurso títles (Padrão HATEOAS):

  • rel: bankSlip
  • rel: bankSlip/base64

*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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": "PLS000007027+DP",
            "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
titleColorOrange
borderStylesolid
titleBankSlip/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
titleParameters
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)stringChave do Titulo (E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO)*required
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
fileNamestringNome do arquivo em PDF
*required
filestringString do arquivo em base 64
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "fileName": "boletosc005630.pdf",
    "file": "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YW..."
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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çãoDescrição
Não se aplicaNão se aplica

04. TELA API TITLES

Principais Campos e Parâmetros

CampoDescrição
E1_CODINTCódigo da operadora saúde
E1_CODEMPCódigo da empresa
E1_MATRICMatricula da família
E1_PREFIXOPrefixo do titulo
E1_NUMNúmero do titulo
E1_PARCELAParcela do titulo
E1_TIPOTipo do titulo
MV_RELTDiretó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)

...