15677137 - Importar boleto e nota fiscal para geração de 2° via pelo SFA

01. DADOS GERAIS

02. ESCOPO FUNCIONAL

Importar boleto e nota fiscal para geração de 2° via pelo SFA

Na versão atual do TOTVS SFA, não existe a possibilidade de fazer o download do boleto e nota fiscal.

Portanto será disponibilizado botões nas listagens de "Títulos" e "Nota fiscal":

Novo botão em "Listagem de títulos"

Novo botão em "Nota Fiscal"

Deverá ser criado um novo plugin de integração, com descrição "Download de notas fiscais e boletos":

Com essas alterações, será possível fazer o download das notas fiscais e boletos que foram emitidos/gerados pelo Protuues, através da API que será disponibilizada para o SFA.

03. ESCOPO TÉCNICO

API NOTA FISCAL

APLICAÇÃO

CRIAR PLUGIN

• Pelo tools opção 5 deverá ser criado o registro:

pluginintegracao {
	codigo: DOWNNF,
    descricao: API Para download Danfe (PDF),
	idnAtivo: 0
}

Campo "URL Nota Fiscal"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_URL
	valor: {valor inserido no campo URL}
Campo "Usuário"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_USER
	valor: {valor inserido no campo USUÁRIO}

Campo "Senha"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_PASSWORD
	valor: {valor inserido no campo Senha}

Campo "Timeout Consulta"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_TIMEOUT
	valor: {valor inserido no campo Timeout consulta}

Campo "Grupo Empresa Default"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_GROUP
	valor: {valor inserido no campo Grupo Empresa Padrão}

• Segue protótipo de tela:

IMPLEMENTAÇÃO NA LISTAGEM DE NOTA FISCAL

• Na tela, "Venda → Nota Fiscal → Listar", exibir o botão para download do PDF, ao lado do botão de visualização conforme protótipo, de acordo com as configurações do plugin:
  • idnAtivo = 1: select idnAtivo from pluginintegracao where codigo = 'DOWNNF'

• Ao clicar no botão de download a aplicação deverá consultar o carte de acordo com a sql:

select valor from pluginintconfig where codigoelemento='CONF_GERAL' AND sglcampo='PENTAHO_URL'

• • A url do download deve ser montada da seguinte forma: URL=${Configurações do Pentaho.URL}/kettle/executeJob/?rep=COMMON_SERVICES&job=DOWNLOADNOTAFISCAL
  • No body da requisição, passar as seguintes informações:

{
empresa:
filial:
numeronotafiscal:
serienotafiscal:
url:
usuario:
senha:
}

• As informações acima serão obtidas a partir das consultas:

NOTAFISCAL.CODIGOERP: 01#01#000170196#2#2023-12-22T00:00:00, onde:

01 → empresa ***

NOTAFISCAL.IDLOCALFILIALFATURAMENTO

NOTAFISCAL.NUMERONOTAFISCAL

NOTAFISCAL.SERIE

*** Quando no cadastro do plugin o campo Grupo Empresa Default estiver diferente de NULL, então deve ser usado o valor definido na configuração do plugin; se estiver NULL, usar o grupo obtido no codigoerp da nota fiscal ou boleto 

• O retorno desta url será o arquivo em base64 para download:

{
    mensagem: {base64}
}

INTEGRAÇÃO

API DOWNLOAD NOTA FISCAL

• Criar para Pentaho-Carte os Job's DOWNLOADNOTAFISCAL no repositório COMMONS_SERVICES;
• URL de consulta deve ser montada no seguinte padrão:

GET: {URL_API_NOTA_FISCAL_CLIENTE}/{empresa}/{filial}/{documento}/{serie}

HEADERS: Authorization: Basic {TOKEN}

• • O usuário e senha, e a URL serão repassadas pela aplicação no Body da request

• O retorno recebido será no formato base64, e deve ser retornado para aplicação sem transformações dentro do XML do RESPONSE:

{
    mensagem: {base64}
}

{"code":500,"detailedMessage":"","message":"Internal Server Error"}

{
    "errorCode": 404,
    "errorMessage": "Nao encontrou a NF 01_05_000001838_11 "
}

{
    mensagem: {base64}
}

API DOWNLOAD BOLETO

APLICAÇÃO

CRIAR PLUGIN

• Pelo tools opção 5 deverá ser criado o registro:

pluginintegracao {
	codigo: DOWNBOL,
    descricao: API Para download Danfe (PDF),
	idnAtivo: 0
}

Campo "URL Nota Fiscal"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNBOL',
	codigoelemento: DOWNBOL,
	agrupador: 0,
	sglcampo: DOWNBOL_URL
	valor: {valor inserido no campo URL}
Campo "Usuário"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNBOL',
	codigoelemento: DOWNBOL,
	agrupador: 0,
	sglcampo: DOWNBOL_USER
	valor: {valor inserido no campo USUÁRIO}

Campo "Senha"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNBOL',
	codigoelemento: DOWNBOL,
	agrupador: 0,
	sglcampo: DOWNBOL_PASSWORD
	valor: {valor inserido no campo Senha}

Campo "Timeout Consulta"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNBOL',
	codigoelemento: DOWNBOL,
	agrupador: 0,
	sglcampo: DOWNBOL_TIMEOUT
	valor: {valor inserido no campo Timeout consulta}

Campo "Grupo Empresa Default"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNBOL',
	codigoelemento: DOWNBOL,
	agrupador: 0,
	sglcampo: DOWNBOL_GROUP
	valor: {valor inserido no campo Grupo Empresa Padrão}

• Segue protótipo de tela:

IMPLEMENTAÇÃO NA TELA DE LISTAGEM DE TÍTULOS

• Na tela, "Visão 360 → Títulos":  exibir o botão para download do PDF, ao lado do botão de visualização conforme protótipo acima, de acordo com as configurações do plugin:
  • idnAtivo = 1: select idnAtivo from pluginintegracao where codigo = 'DOWNBOL'

• Ao clicar no botão de download a aplicação deverá consultar a url do carte de acordo com a sql:

select valor from pluginintconfig where codigoelemento='CONF_GERAL' AND sglcampo='PENTAHO_URL'

• • A url do download deve ser montada da seguinte forma: URL=${Configurações do Pentaho.URL}/kettle/executeJob/?rep=COMMON_SERVICES&job=DOWNLOADBOLETO
  • No body da requisição, passar as seguintes informações:

INTEGRAÇÃO

API DOWNLOAD BOLETO

NÃO IMPLEMENTADO NO CLIENTE - AGUARDANDO