Objetivo e escopo: Rotina responsável pela geração e manutenção de Token de autenticação de acesso à API de nosso parceiro detentor de base de conhecimento fiscal. A integração entre Classificador Fiscal e a API do nosso parceiro é efetuada através de autenticação de usuário.
Classes:
FISTokenClassificador - Reúne todos os atributos e métodos necessários para geração e manutenção de Token de autenticação de acesso a API de nosso parceiro.
Métodos:
tokenSys() - Realiza login e recebe token
Método responsável por realizar a requisição de autenticação do usuário na API do nosso parceiro, detentor das regras fiscais, e receber a resposta com o token que será usado no Classificador de tributos.
Após receber o token do nosso parceiro os dados referente a autenticação são gravados/atualizados na tabela CJD (Controle de Acesso Systax) conforme descrito abaixo:
// caso o usuário já esteja cadastrado na tabela // os dados serão atualizados da seguinte forma CJD->CJD_TOKEN := ::token CJD->CJD_RFTOKE := ::refresh_token CJD->CJD_DTRET := Date() CJD->CJD_HRTOKE := Time() // caso seja um novo usuário os dados serão cadastrados // na tabela da seguinte forma CJD->CJD_FILIAL := xFilial( "CJD" ) CJD->CJD_USRSIS := cUserName CJD->CJD_USER := oConfig:username CJD->CJD_USRPAS := oConfig:senha CJD->CJD_TOKEN := ::token CJD->CJD_RFTOKE := ::refresh_token CJD->CJD_DTRET := Date() CJD->CJD_HRTOKE := Time() |
Retorno:
Retorno | tipo | descrição |
---|---|---|
cToken | String | string com o token de autenticação do usuário |
setUsername(username) - define o username
Método que define o atributo username com o nome do usuário que utilizará a API.
Parâmetros
Param | tipo | descrição |
---|---|---|
username | String | String contendo o nome do usuário que utilizará a API |
setSenha(senha) - define a senha
Método que define o atributo senha com a senha do usuário que utilizará a API.
Parâmetros
Param | tipo | descrição |
---|---|---|
senha | String | String com a senha do usuário que utilizará a API |
setUrl(url) - define a url de conexão
Método que define o atributo url com a url de conexão com a API.
Parâmetros
Param | tipo | descrição |
---|---|---|
url | String | String com a para conexão com a API |
setRefreshToken(refresh_token) - define o refresh token
Método que define o atributo refresh_token com o refresh token para o usuário que utilizará a API.
Parâmetros
Param | tipo | descrição |
---|---|---|
refresh_token | String | String com o refresh token de acesso a API |
O refresh token é um segundo token que guarda informações referente a expiração do token de autenticação. É através dele que o nosso parceiro sabe se deve gerar um novo token de acesso a API. Ele serve de controle pelo nosso parceiro. |
Functions:
getConfigClassif(aParametros) - busca configuração na CJE
Busca a configuração do Classificador de Tributos na tabela CJE e retorna a configuração em uma string preparada para ser transformada em um objeto Json.
Parâmetros
Param | tipo | descrição |
---|---|---|
aParametros | array | Array com os parâmetros que serão utilizados na clausula IN da query de busca na CJE |
Retorno
Retorno | tipo | descrição |
---|---|---|
cJson | String | String preparada com as informações da configuração do classificador |
consultaToken(cUrs) - consulta o token do usuário
Consulta se o token de acesso a API do parceiro expirou. Caso o token tenha expirado ou seja um novo usuário será requisitado um novo token de acesso para o nosso parceiro.
Parâmetros
Param | tipo | descrição |
---|---|---|
cUsr | String | String com o nome do usuário que utilizará a API |
Retorno
Retorno | tipo | descrição |
---|---|---|
cToken | String | String contendo o refresh token |
refreshToken(url, cToken) - requisita novo refresh token
Executa requisição de refresh token para a API do nosso parceiro.
Parâmetros
Param | tipo | descrição |
---|---|---|
url | String | String contendo a url de conexão com a API |
cToken | String | String contendo o token do usuário |
Retorno
Retorno | tipo | descrição |
---|---|---|
cRefresh_token | String | String contendo o refresh token referente ao token de autenticação do usuário |
Tabelas:
Tabela | Descrição |
---|---|
CJD | Controle de Acesso Systax |
CJE | Control Config Classificador |
Objetivo e escopo: Esta rotina foi criada para integrar o envio do Perfil de Produto do configurador de tributos para a base da Systax.
Após enviar o produto que está dentro do perfil de produtos no Configurador de Tributos, o código do perfil é utilizado para criar um Grupo de produto na base da Systax e incluir o produto enviado a este grupo.
Depois de realizar o processo de envio, as informações geradas são gravadas na tabela CJC
Classes:
FISEnvPerfilProduto - Contém todos os métodos para tratamento dos produtos
Métodos:
envPerfilProd(aPerfil) - Seleção e envio dos produtos dentro do perfil
Este método tem como objetivo buscar os produtos cadastrados dentro do Perfil de Produtos do configurador de Tributos, recebendo como parâmetro de busca um array com todos os códigos de perfis selecionados pelo usuário.
Após obter os produtos existentes dentro do Perfil selecionado, os produtos são enviados para a base da Systax e posteriormente agrupados através do método envGrupoProduto.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
aPerfil | Array | Array com o código de perfil selecionado |
gravaTabEnvio(cod_ncm, cCodProd, cPerfil, nOrigem, cIdClassif) - Gravação das informações geradas após envio do produto
Este método tem como objetivo gravar os dados retornados após o envio do produto para a Systax.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cod_ncm | String | Código NCM |
cCodProd | String | Código do produto |
cPerfil | String | Código de PErfil do produto |
nOrigem | Integer | Origem |
cIdClassif | Integer | Chave única gerada para controle interno |
A gravação é realizada conforme abaixo
Campo | Informação |
---|---|
CJC->CJC_FILIAL | xFilial("CJC") |
CJC->CJC_CODNCM | cod_ncm |
CJC->CJC_CODPER | cPerfil |
CJC->CJC_IDRET | cIdClassif |
CJC->CJC_STATUS | "01" |
CJC→CJC_CODPRO | cCodProd |
CJC->CJC_PRDORI | cValToChar(nOrigem) |
envGrupoProduto(cCodProd, nOrigem, cPerfil) - Agrupamento de produtos na base da Systax
Este método tem como objetivo agrupar os produtos enviados para a base da Systax, utilizando o código de perfil do configurador de tributos como Descrição do Grupo na base da Systax, recebendo como parâmetro o código do produto, origem, e o código do perfil.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cCodProd | String | Código do Produto |
nOrigem | Integer | Origem |
cPefil | String | Código do perfil do produto |
Tabelas
Tabela | Descrição |
---|---|
CJC | Perfil de produtos enviados |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Fluxo de associação do produto ao Grupo
Objetivo e escopo: Esta rotina foi criada para obter os dados do perfil de Origem e Destino
No processo de montagem do Json para cadastro de um novo cenário de operação na base da Systax, se faz necessário obter algumas informações, e uma delas é a Origem e Destino do cenário.
É importante observar que para cada linha de Uf Origem e Uf Destino contida no perfil, será criado um cenário distinto e consequentemente processada uma ou mais regras para este cenário |
Este método é chamado pelo método enviaCenário da classe FisEnviaCenario
Classes:
FISObtPerfilOperacao - Contém todos os métodos para tratamento do perfil de origem e destino
Métodos:
GetPfOper(aPerfil) - Método chamador da function que faz query de busca nas tabela F20 e F21
Este método tem como objetivo chamar a busca das origens e destinos cadastrados dentro do perfil selecionado.
Recebe como parâmetro um Array com o código do perfil selecionado.
Após obter as Origens e destinos do perfil, a rotina retorna um Json em forma de string para a classe FisEnviaCenario
Parâmetro:
Parâmetro | Tipo | Descrição |
---|---|---|
aPerfil | Array | Array com o código do perfil de Origem e Destino |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cJson | String | String com os dados de origem e destino do perfil selecionado |
Functions:
GetOper(cPerfil) - Static Function que realiza a consulta do perfil
Esta function tem o objetivo de consultar via Query os dados do perfil e retornar ao método um Json com todas as origens e destinos encontrados
Parâmetro:
Parâmetro | Tipo | Descrição |
---|---|---|
cPerfil | String | String com o código do perfil de Origem e Destino |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
oJson | Objeto Json | Objeto Json com os dados de origem e destino do perfil selecionado |
Tabelas
Tabela | Descrição |
---|---|
F20 | Perfis Tributários |
F21 | Perfil Tributário Orig./Dest. |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para montar o cenário a ser enviado para a Systax.
Este método é chamado pelo método enviaCenário da classe FisEnviaCenario, a fim de receber todos os dados já filtrados para montar o Json com um ou Mais cenários a serem enviados para a base da Systax
Classes:
FISCriaCenario - Contém todos os métodos para tratamento da criação do cenário de operação
Métodos:
CriaCenario(nEntSai,cEmpresa,cGrpProd,oJsonNat,oJsonFin,oJsonOper,oJsonPar) - Método chamador da function que faz a leitura das informações e a criação dos cenários
Este método tem como objetivo chamar a function de criação dos cenários GetOper(cPerfil).
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
nEntSai | Integer | Parâmetro informando o tipo do cenário ( 1 - Entradas, 2 - Devolução de Entradas, 3 - Saídas e 4 - Devolução de Saídas ) |
cEmpresa | String | Segmento da empresa Principal da operação |
cGrpProd | String | Código do perfil de produto selecionado |
oJsonNat | Objeto Json | Json com os dados da Natureza de operação |
oJsonFin | Objeto Json | Json com os dados da Finalidade da operação (Para cenários de vendas, este Json tem como Default = Nil) |
oJsonOper | Objeto Json | Json com os dados da Origem e Destino da operação |
oJsonPar | Objeto Json | Json com os dados do Participante a operação |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cJson | String | Json em formato de string com os cenários criados no Método |
Functions:
CriaCena(nEntSai,cEmpresa,cGrpProd,oJsonNat,oJsonFin,oJsonOper,oJsonPar) - Static Function que realiza a criação dos cenários de operação
Esta function tem o objetivo de receber e ler as informações enviadas, e montar os devidos cenários, de acordo com cada opção de perfil escolhido pelo usuário.
Parâmetro | Tipo | Descrição |
---|---|---|
nEntSai | Integer | Parâmetro informando o tipo do cenário ( 1 - Entradas, 2 - Devolução de Entradas, 3 - Saídas e 4 - Devolução de Saídas ) |
cEmpresa | String | Segmento da empresa Principal da operação |
cGrpProd | String | Código do perfil de produto selecionado |
oJsonNat | Objeto Json | Json com os dados da Natureza de operação |
oJsonFin | Objeto Json | Json com os dados da Finalidade da operação (Para cenários de vendas, este Json tem como Default = Nil) |
oJsonOper | Objeto Json | Json com os dados da Origem e Destino da operação |
oJsonPar | Objeto Json | Json com os dados do Participante a operação |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
oJson | Objeto Json | Objeto Json com os cenários criados no Método |
Tabelas: Não há tabela para esta rotina
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para enviar os cenários válidos para a Systax
Este método é chamado para processar e enviar os cenários criados para a systax, tomando como base, todos os perfis selecionados pelo cliente no Classificador Fiscal
Classes:
FISEnviaCenario - Contém todos os métodos para tratamento da criação e envio dos cenários para a Systax
Métodos:
EnviaCenario(cEntSai,cEmpresa,aCodPart,aOriDest,cGrpProd,aNatOper,aFinalid) - Método responsável pela dinâmica da montagem, validação e envio dos cenarios de operação
Este método tem como objetivo, empilhar as chamadas para obter e tratar as devidas informações a serem enviadas no cenário, bem como criar, validar e enviar os cenários para a base do parceiro Systax
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
cEntSai | String | Parâmetro informando o tipo do cenário ( 1 - Entradas, 2 - Devolução de Entradas, 3 - Saídas e 4 - Devolução de Saídas ) |
cEmpresa | String | Segmento da empresa Principal da operação |
aCodPart | Array | Array com o código do perfil de participante selecionado, código e loja do Participante {"perfil","codigo","loja"} |
aOriDest | Array | Array com os códigos de perfis de origem e destino selecionados |
cGrpProd | String | Código do perfil de produto selecionado |
aNatOper | Array | Array com as naturezas de operação selecionadas |
aFinalid | Array | Array com as finalidades selecionadas |
Pilha dos retornos dos tratamentos da informações chamados dentro do EnviaCenário( )
Chamada | Retorno |
---|---|
cJsonOper := oClasOper:GetPfOper({aOridest[nY]}) | oJsonOper:FromJSON(cJsonOper) |
cJsonNat := oClassNat:FISObtemNaturezaOperacao(aNatOper) | oJsonNat:FromJSON(cJsonNat) |
cJsonPar := oClassPart:ObtemEnquad(cCodPart) | oJsonPar:FromJSON(cJsonPar) |
cJsonFin := oClassNat:FISObtemNaturezaOperacao(aFinalid) | oJsonFin:FromJSON(cJsonFin) |
cJsonCena := oClasCena:CriaCenario(nEntSai,cEmpresa,cGrpProd,oJsonNat,oJsonFin,oJsonOper,oJsonPar) | oJsonCenario:FromJSON(cJsonCena) |
cJsVlCena := oClsVlCna:FisValidaCenario(cGrpProd,cCodPart,@oJsonCenario) | oJsVlCena:FromJSON(cJsVlCena) |
Retorno:
Após o envio do cenário para a Systax, os dados dos cenários gerados são gravados na tabela CJB, para controle interno e análise do usuário.
Functions: Não há functions neste fonte.
Tabelas:
Tabela | Descrição |
---|---|
CJG | Controle de Cenários do Classificador |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para obter a natureza da operação escolhida pelo usuário
Este método é chamado para buscar na tabela CJH, os dados da natureza de operação, a fim de ser utilizado no cenário de operação criado na FISX005B
Este método também é chamado para buscar a Finalidade da operação, para cenários de entrada de mercadoria |
Classes:
FISNatOperacao - Contém todos os métodos para busca das Naturezas de operação.
Métodos:
FISObtemNaturezaOperacao(aNatOper) - Método responsável por buscar os dados da Natureza e/ou Finalidade da Operação
Este método tem como objetivo, montar o Json de retorno após a busca das informações realizadas pela Static Function GetNatur( )
Parâmetros
Parâmetro | Tipo | Descrição | ||||
---|---|---|---|---|---|---|
aNatOper | Array | Array com os parâmetros de busca da Natureza e/ou finalidade da operação
|
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cJson | String | Json em forma de String com o código e a Descrição do referido código de natureza da Finalidade e/ou Operação |
Functions:
GetNatur(cNatOper,cNatOpTp)
Função que realiza a busca dos dados da Natureza e finalidade, para que este sejam utilizados na montagem do Json de cenário de operação
Parâmetro:
Parâmetro | Tipo | Descrição |
---|---|---|
cNatOper | String | Código da natureza e/ou finalidade da operação |
cNatOpTp | String | Tipo da operação 1 para Natureza (Vendas) |
Tabelas:
Tabela | Descrição |
---|---|
CJH | Cabeçalho do Cadastro de Natureza de Operação do Classificador |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para validar o cenário antes de realizar o envio para a Systax
Este método é chamado para verificar na tabela CJG se existe algum cenário semelhante ao que está sendo enviado.
Como chave para busca e análise, são utilizados o Código do Perfil de Produto, e o código do participante.
Classes:
FISValidaCenário - Contém todos os métodos para análise e validação do cenário
Métodos:
FISValidaCenário(cGrpProd,cCodPart,oJsonCenario) - Método responsável por chamar a função de análise de cenário e devolver um Json com o resultado
Este método tem como objetivo, montar o Json de retorno após a busca das informações realizadas pela Static Function ValidCena( )
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
cGrpProd | String | Código do perfil de produto utilizado no cenário |
cCodPart | String | Código do participante utilizado no cenário |
oJsonCenario | Objeto Json | Json do cenário criado para ser enviado a Systax |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cJson | String | Json em forma de String com os cenários validos e não válidos |
Functions:
ValidCena(cGrpProd,cCodPart,oJsonCenario)
Função que realiza a busca dos dados e realiza a validação dos itens abaixo.
Itens validados
Item | Descrição |
---|---|
uf_origem | UF de Origem da operação |
uf_destino | UF de Destino da operação |
ent_sai | Cenário é entrada ou saída |
destinação | Enquadramento fiscal do destino da operação |
finalidade | Finalidade da operação (Compras) |
cod_nat_op | Natureza da operação (Vendas) |
grupos | Código do perfil de produto |
Caso exista um cenário na base utilizando como chave de busca Código do Perfil de Produto, e o código do participante, todos estes itens são verificados.
E caso todos este itens seja iguais ao cenários que já temos na base, este cenário não será enviado novamente a systax, a fim de evitar duplicidade de geração de regras.
Parâmetro:
Parâmetro | Tipo | Descrição |
---|---|---|
cGrpProd | String | Código do perfil de produto utilizado no cenário |
cCodPart | String | Código do participante utilizado no cenário |
oJsonCenario | Objeto Json | Json do cenário criado para ser enviado a Systax |
Tabelas:
Tabela | Descrição |
---|---|
CJG | Controle de Cenário do Classificador |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para obter as regras geradas pela Systax
Este método é chamado para buscar na base da Systax, todas as regras geradas com base nas informações enviadas nos cenários e também nos produtos enviados anteriormente.
O processo para obter as regras contempla algumas etapas.
Caso o item 1 seja verdadeiro, será montado um Json de consulta conforme abaixo
Campo | Conteudo |
---|---|
id_cenario | "1" |
codigo_produto | "1" |
origem_produto | null |
paginacao | 100 |
ponteiro_atualizacao | "" |
Caso o item 2 seja verdadeiro, será montado um Json conforme abaixo
Campo | Conteudo | Observação |
---|---|---|
id_cenario | "1" | Este deve ser preenchido com o código do cenário, caso a consulta de regra seja para um cenário específico |
codigo_produto | "1" | Este deve ser preenchido com o código de produto, caso a consulta de regra seja para um (cenário + produto) específico |
origem_produto | null | Este deve ser preenchido com a origem do produto, caso a consulta de regra seja para um (cenário + produto + origem) específico |
paginacao | 100 | máximo de 100 itens por página |
ponteiro_atualizacao | "Conteúdo do campo CJI_PRIPON do dia anterior" | Obrigatório levar o conteúdo do campo CJI_PRIPON do dia anterior, a fim de obter somente atualizações de regras. |
Caso o item 3 seja verdadeiro, será montado um Json conforme abaixo
Campo | Conteudo | Observação |
---|---|---|
id_cenario | "1" | Este deve ser preenchido com o código do cenário, caso a consulta de regra seja para um cenário específico |
codigo_produto | "1" | Este deve ser preenchido com o código de produto, caso a consulta de regra seja para um (cenário + produto) específico |
origem_produto | null | Este deve ser preenchido com a origem do produto, caso a consulta de regra seja para um (cenário + produto + origem) específico |
paginacao | 100 | máximo de 100 itens por página |
ponteiro_atualizacao | "Conteúdo do campo CJI_PRIPON do mesmo dia" | Obrigatório levar o conteúdo do campo CJI_PRIPON do mesmo dia, a fim de obter somente atualizações de regras. |
Classes:
FISRetornaRegra- Contém todos os métodos para retorno das regras geradas pela Systax
Métodos:
FISRetornaRegra(cIdCenario,cCodProd,nOriProd,nOtemPont) - Método responsável por buscar as regras geradas na Systax
Este método tem como objetivo, chamar a API de regras conforme Json acima.
Depois de obter as regras conforme as devidas configurações, essas são verificadas e gravadas na tabela CJB.
Definições dos campos CJB_STATUS e CJB_STSRET
CJB_STATUS
Status | Descrição |
---|---|
R | Recusada |
I | Inativa |
S | Suspensa |
AP | Aprovada |
AA | Aguardando Aprovação |
CJB_STSRET
Status | Descrição |
---|---|
RA | Regra com atualização |
Caso o Json de consulta seja o Item 1, todas as regras são gravadas na CJB, e o campo CJB_STATUS será gravado com AA = Aguardando Aprovação
Caso o Json de consulta seja o item 2 ou 3, e se a consulta retornar alguma regra.
Esta regra será localizada na CJB através da chave Código de cenário + Código de Produto + Origem do Produto
O json da nova regra obtida será gravado no campo CJB_JSRGNW, o campo CJB_STATUS = AA e o campo CJB_STSRET = RA
Parâmetros
Parâmetro | Tipo | Descrição | Observação |
---|---|---|---|
cIdCenario | String | Id do cenário | Obrigatório apenas se for consulta de cenário específico |
cCodProd | String | Código do produto | Obrigatório apenas se for consulta de produto específico |
nOriProd | Integer | Origem do produto | Obrigatório apenas se for consulta de origem de produto específico |
nOtemPont | Integer | Parâmetro para consulta específica | Obrigatório apenas se for consulta específica |
Retorno: Nil
MontaConsulta(cIdCenario,cCodProd,nOriProd,cPontAtu)
Monta a consulta de cenários de acordo com os parâmetro enviado na chamada do método
Parâmetros
Parâmetro | Tipo | Descrição | Observação |
---|---|---|---|
cIdCenario | String | Id do cenário | Obrigatório apenas se for consulta de cenário específico |
cCodProd | String | Código do produto | Obrigatório apenas se for consulta de produto específico |
nOriProd | Integer | Origem do produto | Obrigatório apenas se for consulta de origem de produto específico |
cPontAtu | Integer | Parâmetro para consulta específica | Obrigatório apenas se for consulta específica |
GravaPont(nOperacao,cPonteiro)
Este método tem como objetivo atualizar o controle de ponteiros de atualização, a fim de registrar os ponteiros retornados pela Systax.
O Ponteiro é uma chave única de atualização criada pela systax, através dele é realizado o controle de possíveis atualizações nas regras da Systax.
Functions:
GetPriPont()
Função que realiza a busca do primeiro ponteiro gravado no dia anterior
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cPont | String | Primeiro ponteiro gerado na consulta do dia anterior |
Tabelas:
Tabela | Descrição |
---|---|
CJI | Controle de atualização do Ponteiro |
CJB | Monitor do Classificador |
Fluxo
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Esta rotina foi criada para obter o enquadramento dos participantes do cenário de Operação.
Classes:
FISObtemEnquadramento - Contém todos os métodos para análise e validação do cenário
Métodos:
ObtemEnquad(aCodPart) - Método responsável por chamar a função de análise de cenário e devolver um Json com o resultado
Este método tem como objetivo, buscar o enquadramento do participante gravado na tabela CJJ.
Através da atualização na rotina de Cadastro de Perfil de Participante, é possível amarrar o participante a um enquadramento e assim utiliza-lo nos cenários de operação do Classificador.
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
aCodPart | Array | Array com o código do perfil de participante, código e loja do participante utilizado no cenário |
Retorno:
Retorno | Tipo | Descrição |
---|---|---|
cJson | String | Json em forma de String com os devidos enquadramentos dos participantes |
Functions: Não há function para este fonte
Tabelas:
Tabela | Descrição |
---|---|
F20 | Perfis Tributários |
F22 | Perfil Trib. de Participante |
CJJ | Enquadramento Fiscal |
Carga Automática: Esta rotina não tem carga automática
Relacionamento: Esta rotina não possui relacionamento.
Objetivo e escopo: Este fonte reúne todas as classes e funções necessárias para integrar com o Configurador de Tributos os dados de alíquotas obtidos nas regras advindas do nosso parceiro detentor da base de regras fiscais.
Classes:
FISGravAliquota - Classe que contém as operações para gravar a alíquota vinda da regra da Systax
Métodos:
FISGetDados(cIDcenario,cIDProduto,cOrigem) - obtém dados dos impostos
Método para obter os dados dos impostos no Json
Parâmetros
Param | tipo | descrição |
---|---|---|
cIDcenario | String | identificação do cenário |
cIDproduto | String | código do produto |
cOrigem | String | origem do produto |
Retorno
Ret | tipo | Descrição |
---|---|---|
oJsonRetor | Json object | objeto json com os dados dos impotos |
FISGravaAliquota(cCodAliq,cDesc,cVlOrig,nPcAlq,cTpAlq) - grava alíquota no configurador
Método para gravar a alíquota no configurador de tributos
Parâmetros
Param | tipo | descrição |
---|---|---|
cCodAliq | String | código da regra de alíquota |
cDesc | String | descrição da regra |
cVlOrig | String | valor de origem |
nPcAlq | Number | percentual da alíquota |
cTpAql | String | tipo de alíquota |
Retorno
Ret | tipo | descrição |
---|---|---|
alRet | Array | array de duas posições que guarda valores booleanos: 1 - guarda bool definindo se alíquota existe (.T./.F.) 2 - guarda bool definindo se a alíquota foi criada (.T./.F.) |
FISGravaRgNCM(cCodNCM,aTributos) - grava regra por NCM
Método para gravar a regra por NCM
Parâmetros
Param | tipo | descrição |
---|---|---|
cCodNCM | String | código NCM |
aTributos | Array | array contendo dados dos tributos a serem processados |
Retorno
Ret | tipo | descrição |
---|---|---|
lPost | Logical | variável lógica que identifica se houve a gravação da regra por NCM |
GetRgNCM(cCodNCM) - obtém regra por NCM
Método que obtém a regra por NCM através das tabelas CIS e CIU do configurador de tributos.
Parâmetros
Param | tipo | descrição |
---|---|---|
cCodNCM | String | código do NCM para busca |
Retorno
Ret | tipo | descrição |
---|---|---|
self:jSvalid | Json object | objeto json com todas as regras referente ao NCM pesquisado |
GetAliq(cDesc,lExist) - obtém alíquota
Método que obtém a regra da alíquota na tabela F28 do configurador de tributos.
Parâmetros
Param | tipo | descrição |
---|---|---|
cDesc | String | descrição da regra |
lExist | Logical | existe a regra |
Retorno
Param | tipo | descrição |
---|---|---|
cCodigo | String | Código da Regra |
ValidJson(aTributos) - valida Json
Método que executa a validação do Json referente as regras por NCM.
Parâmetros
Param | tipo | descrição |
---|---|---|
aTributos | Array | array com os dados dos tributos. Apenas será usado para verificar seu tamanho |
Retorno
Ret | tipo | descrição |
---|---|---|
lRet | logical | variável lógica que confirma se o Json é válido ou não |
setcod(setcod) - passa o código de alíquota
Método para passar o código da regra de alíquota no Configurador
Parâmetros
Param | tipo | descrição |
---|---|---|
setcod | String | código a ser passado para regra de alíquota do configurador |
AtuCJE(cCJECod) - atualiza CJE
Método que atualiza a tabela CJE com o código da regra de alíquota
Parâmetros
Param | tipo | descrição |
---|---|---|
cCJECod | String | código da regra de alíquota |
UTFINDREG(cTabela,nIndice,cPesq) - encontra registro para alteração
Método para encontrar o registro para alteração, via TDD.
Parâmetros
Param | tipo | descrição |
---|---|---|
cTabela | String | tabela a ser pesquisada |
nIndice | Number | índice da tabela a ser pesquisada |
cPesq | String | chave de pesquisa conforme o índice da tabela |
Tabelas
Tabela | Descrição |
---|---|
CJE | Control Config Classificador |
CJB | Monitor do classificador |
F28 | Regra de Aliquota |
CIS | Cabeçalho da regra de NCM |
CIT | Tributo x Regra |
CIU | Regras adic. de trib p/ NCM |
Objetivo e escopo: Esta rotina tem como objetivo analisar os CSTs existentes no Json de Regra. Cada tributo possui o campo "cst", onde este quando preenchido com o valor diferente de "" (Branco) será criado a regra de escrituração.
Classes:
FISGravaCST - Contém todos os métodos para obter os CSTs vindas no Json de regras do parceiro detentor das regras fiscais e grava-las na regra de escrituração do Configurador de Tributos.
Métodos:
FISGetDados(cIDcenario,cIDProduto,cOrigem) - Método para obter os tributos no Json
Este método tem como objetivo, ler o Json de regras e analisar os tributos, a fim de obter a informação do campo "cst" para gerar a regra de escrituração do Configurador de tributos.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cIDCenário | String | Identificação do cenário a ser integrado com o configurador de tributos |
cIDProduto | String | Identificação do produto do cenário a ser integrado com o configurador de tributos |
cOrigem | String | Identificação da origem do produto do cenário a ser integrado com o configurador de tributos |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
aJsonRetor | Array | Array com os dados das regras de escrituração geradas |
FISGrvCST(cCST,aCST,cDesc,cCodCST,lPcRed) - Método para gravar a regra de escrituração
Este método tem como objetivo, Efetuar a gravação da regra de escrituração no configurador de tributos.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cCST | String | Identificação do CST vinda do Json de regra |
aCST | Array | Array contendo as tabelas de CST que será gravada a regra |
cDesc | String | Descrição da regra de escrituração |
cCodCST | String | Código da Regra de Escrituração |
lPcRed | Lógico | Variavel de verificação se o tributo contem redução da base de calculo |
Retorno:
Ret | tipo | descrição |
---|---|---|
aRet | Array | array de duas posições que guarda valores booleanos: 1 - guarda bool definindo se alíquota existe (.T./.F.) 2 - guarda bool definindo se a alíquota foi criada (.T./.F.) |
setcod(setcod) - passa o código de alíquota
Método para passar o código da regra de alíquota no Configurador
Parâmetros
Param | tipo | descrição |
---|---|---|
setcod | String | código a ser passado para regra de alíquota do configurador |
AtuCJE(cCJECod) - atualiza CJE
Método que atualiza a tabela CJE com o código da regra de alíquota
Parâmetros
Param | tipo | descrição |
---|---|---|
cCJECod | String | código da regra de alíquota |
GetIdTrib(cImposto) - Método para retornar o ID do tributo
Este método tem como objetivo, retornar o ID do tributo, fazendo um De/Para como o tributo informado no Json de Regra .
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cImposto | String | Tributo vindo do Json de regra |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
cRet | String | Id do tributo |
GetTabCST(cIdTrib,cCST,lIncide) - Método para retornar o cadastro do CST
Este método tem como objetivo, retornar os codigos da tabela de CST e a incidencia.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cIdTrib | String | Id do tributo |
cCST | String | Código CST |
lIncide | Lógico | Se há incidencia ou não |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
aRet | Array | Array contendo a incidencia do tributo |
ChkRegraEscrituracao(cCST,cTabCST,lExist,cDesc) - Método para verificar se a regra de escrituração ja consta no sistema
Este método tem como objetivo, Verificar a existencia da regra de escrituração no sistema.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cCST | String | Código CST |
cTabCST | String | Codigo do cadastro de CST |
lExit | Logico | Variavel de verificação se o cadastro está na base ou não |
cDesc | String | Descrição da regra de escrituração |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
cCodigo | String | Retorna o código existente na base, caso não tenha cadastro será retornado em branco |
Objetivo e escopo: Esta rotina tem como objetivo analisar as bases de composição de calculos existentes no Json de regra. Cada tributo possui o campo "bc_composicao", onde este quando preenchido com o valor diferente de 0 (Zero), possui uma formula de cálculo, a qual será transformada em uma formula compreensível para o Configurador de Tributos.
Classes:
FISGravaBase - Contém todos os métodos para obter a formula vinda na API de busca do parceiro detentor da base de regras fiscais e grava-las no Configurador de Tributos.
Métodos:
FISGetDados(cIDcenario,cIDProduto,cOrigem) - Método para obter os tributos no Json
Este método tem como objetivo, ler o Json de regras e analisar os tributos, a fim de obter a informação do campo bc_composicao para gerar a formula de cálculo do Configurador de tributos.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cIDCenário | String | Identificação do cenário a ser integrado com o configurador de tributos |
cIDProduto | String | Identificação do produto do cenário a ser integrado com o configurador de tributos |
cOrigem | String | Identificação da origem do produto do cenário a ser integrado com o configurador de tributos |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
aJsonRetor | Array | Array com os dados das bases de cálculos de tributos geradas |
FISGravaBase(cCodBase,cDesc,cVlOrig,nPcRed,cFormula) - Método para gravar a base do tributo no configurador de tributos
Este método tem como objetivo, gravar a base de cálculo vindas do json de regras.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cCodBase | String | Código da regra de base de calculo |
cDesc | String | Descrição da regra de base de calculo |
cVlOrig | String | Valor de origem |
nPcRed | Float | Percentual de Redução da base de Calculo |
cFormula | String | Formula da base de calculo convertida para o configurador |
Retorno:
Ret | tipo | descrição |
---|---|---|
BsRet | Array | array de duas posições que guarda valores booleanos: 1 - guarda bool definindo se alíquota existe (.T./.F.) 2 - guarda bool definindo se a alíquota foi criada (.T./.F.) |
FISGetFormulaBase(nBaseComp,cTributo) - Método de chamada da API de Formulas da Systax
Este método tem como objetivo, buscar as formulas para para composição da base de calculo.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
nBaseComp | Interger | Código da base de calculo vinda do json de regra |
cTributo | String | Tributo a ser verificado a formula da base |
Retorno:
Ret | tipo | descrição |
---|---|---|
cFormula | String | Formula da systax da base de calculo |
setcod(setcod) - passa o código de alíquota
Método para passar o código da regra de alíquota no Configurador
Parâmetros
Param | tipo | descrição |
---|---|---|
setcod | String | código a ser passado para regra de alíquota do configurador |
AtuCJE(cCJECod) - atualiza CJE
Método que atualiza a tabela CJE com o código da regra de alíquota
Parâmetros
Param | tipo | descrição |
---|---|---|
cCJECod | String | código da regra de alíquota |
FISDeParaFormula(cFormula) - Método de conversão da formula da API de Formulas da Systax
Este método tem como objetivo, efetuar a conversão da formula de base de calculo retornada da API de formulas da Systax.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cFormula | String | Formula da API da Systax |
Retorno:
Ret | tipo | descrição |
---|---|---|
cFormula | String | Formula Convertida |
FisGetBase(cDesc,lExist) - obtém a Base
Método que obtém a regra da base na tabela F27 do configurador de tributos.
Parâmetros
Param | tipo | descrição |
---|---|---|
cDesc | String | descrição da regra |
lExist | Logical | existe a regra |
Retorno
Param | tipo | descrição |
---|---|---|
cCodigo | String | Código da Regra |
Tabelas
Tabela | Descrição |
---|---|
CJE | Control Config Classificador |
CJB | Monitor do classificador |
F27 | Regra de Base de Calculo |
Objetivo e escopo: Esta rotina tem como objetivo gravar as regras de calculos existentes no Json de regra. Cada tributo já tem os cadastros de aliquotas, base e escrituração gerado anteriormente, esta classe é responsável por gerar as regras de calculos no Configurador de Tributos.
Classes:
FISGravaBase - Contém todos os métodos para efetuar o cadastro de regras dos tributos no Configurador de Tributos.
Métodos:
FISGetDados(cIDcenario,cIDProduto,cOrigem,aRegraAliquota,aRegraBase,aRegraEscrituracao) - Método para obter os tributos no Json
Este método tem como objetivo, reunir as informações de aliquotas, bases e escrituração cadastradas nas classes anteriores.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cIDCenário | String | Identificação do cenário a ser integrado com o configurador de tributos |
cIDProduto | String | Identificação do produto do cenário a ser integrado com o configurador de tributos |
cOrigem | String | Identificação da origem do produto do cenário a ser integrado com o configurador de tributos |
aRegraAliquota | Array | Array contendo os códigos de regras de aliquotas |
aRegraBase | Array | Array contendo os códigos de regras de base de calculos |
aRegraEscrituracao | Array | Array contendo os códigos de regras de escrituração |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
aJsonRetor | Array | Array com os dados das bases de cálculos de tributos geradas |
Métodos:
FISGravaRegra(cCodRegra,cDesc,cTributo,cCodAliquota,cCodBase,cCodEscrituracao,cPerfilProduto,cPerfilParticipantes,cPerfilOperacao,cPerfilOrigemDestino) - Método para Gravar a Regra de calculo do tributo
Este método tem como objetivo, efetuar a criação de regras de calculo no configurador.
Parâmetros:
Parâmetro | Tipo | Descrição |
---|---|---|
cCodRegra | String | Codigo da regra de calculo |
cDesc | String | Descrição da Regra de calculo |
cTributo | String | Tributo a ser cadastrado |
cCodAliquota | String | Codigo da regra de aliquota |
cCodBase | String | Código da regra de base de calculo |
cCodEscrituracao | String | Código da regra de escrituração |
cPerfilProduto | String | Código do perfil de produtos |
cPerfilParticipantes | String | Código do perfil de participantes |
cPerfilOperacao | String | Código do perfil de Operação |
cPerfilOrigemDestino | String | Código do perfil de Origem Destino |
Retorno:
Ret | tipo | descrição |
---|---|---|
RegraRet | Array | array de duas posições que guarda valores booleanos: 1 - guarda bool definindo se alíquota existe (.T./.F.) 2 - guarda bool definindo se a alíquota foi criada (.T./.F.) |
FisGetRegra(cDesc,cTributo,lExist) - obtém a Regra de Calculo
Método que obtém a regra de calculo na tabela F2B do configurador de tributos.
Parâmetros
Param | tipo | descrição |
---|---|---|
cDesc | String | descrição da regra |
cTributo | String | Tributo a ser verificado |
lExist | Logical | existe a regra |
Retorno
Param | tipo | descrição |
---|---|---|
cCodigo | String | Código da Regra |
GetPerfis(cIDCenario) - obtém os códigos dos perfis
Método que obtém os códigos dos perfis Produto, Participante e Origem Destino.
Parâmetros
Param | tipo | descrição |
---|---|---|
cIDCenario | String | Código do cenário |
Retorno
Param | tipo | descrição |
---|---|---|
oPerfil | Objeto | Objeto Json com as informações dos perfis Produto, Participante e Origem Destino |
gravaPerfOperacao(cCodNatOper,cFinalidade,cDescOper) - grava o Perfil de Operação
Método para gravar o perfil de operação baseado no código de Finalidade e código de natureza de operação.
Parâmetros
Param | tipo | descrição |
---|---|---|
cCodNatOper | String | Código da natureza de Operação |
cFinalidade | String | Código de finalidade |
cDescOper | String | Descrição do Perfil de Operação |
Retorno
Param | tipo | descrição |
---|---|---|
cCodPerfOper | String | Código do perfil de operação criado |
FISGetPerfOper(cDescOper,lExit) - Verifica o perfil de operação
Método para verificar o perfil de operação.
Parâmetros
Param | tipo | descrição |
---|---|---|
cDescOper | String | Descrição do Perfil de Operação |
lExit | Lógico | Retorna se existe ou não o cadastro de perfil de operação |
Retorno
Param | tipo | descrição |
---|---|---|
cCodigo | String | Código do perfil de operação criado |
Objetivo e escopo: Esta rotina tem como objetivo verificar os parametros "USERNAMEDEFAULT" e "SENHADEFAULT" estão preenchidos na tabela CJE e metodo para cadastro dos parametros caso estejam em branco.
Classes:
FISVerificaAcesso - Contém todos os métodos para efetuar a busca dos participantes cadastrados na Filial
Métodos:
GetUserSenha( ) - Método para verificar o usuario e senha default do classificador
Este método tem como objetivo, verificar se o usuário e senha default está preenchido na tabela de parametros do classificador (CJE).
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetUserSenha") |
GravaUserSenha( ) - Método para gravar o usuario e senha default do classificador
Este método tem como objetivo, cadastrar o usuário e senha default na tabela de parametros do classificador (CJE).
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
usuario | Usuario coletado na tela de usuário e senha | Recebe o usuário e senha da tela inicial | http://localhost:9995/rest/GravaUserSenha?usuario=totvs_teste&senha=totvs@21teste |
senha | Senha coletada na tela de usuário e senha | Recebe o usuário e senha da tela inicial | http://localhost:9995/rest/GravaUserSenha?usuario=totvs_teste&senha=totvs@21teste |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Post("/GravaUserSenha") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados dos participantes da Filial logada no classificador Fiscal, e entregá-los para serem visualizados na aplicação
Classes:
FISGetParticipante - Contém todos os métodos para efetuar a busca dos participantes cadastrados na Filial
Métodos:
GetParticipante( ) - Método para obter os participantes
Este método tem como objetivo, reunir as informações dos participantes em um Json para ser entregue a requisição.
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Código da filial logada em sistema | Utilizar a filial no filtro de participantes da Query | http://10.173.7.57:9995/rest/GetParticipante?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetParticipante") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados de enquadramento fiscal, seja de Fornecedor ou Cliente
Classes:
FisGetEnquadramento - Contém todos os métodos para efetuar a busca dos enquadramentos disponíveis em sistema.
Métodos:
GetEnquadramento( ) - Método para obter os enquadramentos
Este método tem como objetivo, reunir as informações dos enquadramentos em um Json para ser entregue a requisição.
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
tipo | Tipo de busca a ser realizada 2 -> Cliente | Utilizar a o tipo de busca no filtro de participantes da Query | http://localhost:9995/rest/GetEnquadramento?tipo=1 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetEnquadramento") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados de perfis de produtos.
Classes:
FisGetProduto - Contém todos os métodos para efetuar a busca dos perfis de produtos disponiveis no sistema.
Métodos:
GetProduto( ) - Método para obter os perfis de produtos
Este método tem como objetivo, reunir as informações dos perfis de produtos em um Json para ser entregue a requisição.
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caracter | Utilizar a filial para a busca no filtro de perfis de produtos da Query | http://localhost:9995/rest/GetProduto?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetProduto") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados dos perfis de origem e destino.
Classes:
FisGetOrigemDestino - Contém todos os métodos para efetuar a busca dos perfis de origem e destino disponíveis no sistema.
Métodos:
GetOrigemDestino( ) - Método para obter os perfis de origem e destino
Este método tem como objetivo, reunir as informações dos perfis de origem e destino em um Json para ser entregue a requisição.
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caracter | Utilizar a filial para a busca no filtro de perfis de origem e destino da Query | http://localhost:8095/rest/GetOrigemDestino?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetOrigemDestino") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados da tela de seleção de perfis - aba operação.
Classes:
FisGetPerfilOperacoes - Contém todos os métodos para efetuar a busca das operações disponíveis para a tela de Perfis.
Métodos:
GetPerfilOperacoes( ) - Método para obter as operações da tela de Perfis
Este método tem como objetivo, reunir as informações das operações da tela de Perfis em um Json para ser entregue a requisição.
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caracter | Utilizar a filial para a busca no filtro de perfis de origem e destino da Query | http://localhost:8095/rest/GetPerfilOperacoes?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(oJBody)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetPerfilOperacoes") |
Objetivo e escopo: Esta rotina tem como objetivo obter todos os dados do status dos cenários enviados, ou dos cenários salvos e não enviados
Classes:
FisGetMonitorCenario - Contém todos os métodos para efetuar a busca do status dos cenários enviados.
Métodos:
GetMonitorCenario( ) - Método para obter os dados do status dos cenários enviados e/ou salvos no sistema
Este método tem como objetivo, reunir as informações dos cenários salvos e/ou enviados a Systax
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caracter | Utilizar a filial para a busca no filtro dos controle de cenários | http://localhost:9995/rest/GetMonitorCenario?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Este método é chamado através da nova tecnologia TLPP, Annotation @Get("/GetMonitorCenario") |
Objetivo e escopo: Esta rotina tem como objetivo obter e/ou alterar os parâmetros de configuração de integração de regras
Classes:
FisGetMonitorCenario - Contém todos os métodos para efetuar a busca e/ou alteração dos parâmetros de configuração de integração de regras
Métodos:
GetConfiguraRegra( ) - Método para obter o status do parâmetro de configuração
Este método tem como objetivo, obter o status atual do parâmetro de configuração passado via QueryParam
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
param | Caractere | Utilizar o parâmetro para a busca na tabela de configurações do classificador | http://localhost:9995/rest/GetConfiguraRegra |
PutConfiguraRegra( ) - Método para alterar o status do parâmetro de configuração
Este método tem como objetivo, alterar o status atual do parâmetro de configuração passado via Json de Body
Parâmetros via Body:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
{ | Json | Utilizar o Json para a realizar a alteração do parâmetro desejado | http://localhost:9995/rest/PutConfiguraRegra |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(cJson)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Estes métodos são chamados através da nova tecnologia TLPP, Annotation @Get("/GetConfiguraRegra") @Put("/PutConfiguraRegra") |
Objetivo e escopo: Esta rotina tem como objetivo enviar os cenários do classificador.
Classes:
EnviaCenarioClassificador - Contém todos os métodos para efetuar o envio dos cenários do classificador
Métodos:
PostEnviaCenario( ) - Método para receber as informações, valida-las e enviar os cenários
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caractere | Utilizar a filial para consulta de produtos enviados | http://localhost:9995/rest/PostEnviaCenario?filial=XIFIS26 |
Parâmetros via Body:
{ "cenarios": [ { "status":"ENVIAR", "cod_produto": "", "origem_produto": "", "perfil_produto": "", "entrada_saida":"", "empresa":"", "participante": [ { "perfil_participante": "", "tipo_participante":"", "codigo": "", "loja": "" } ], "origem_destino": [ { "codigo": "" } ], "natureza_operacao": [ { "codigo_natur":"", "tipo":"" } ], "finalidade": [ { "codigo_final": "", "tipo":"" } ] } ] } |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(oJretorno)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Estes métodos são chamados através da nova tecnologia TLPP, Annotation @Post("/PostEnviaCenario") |
Objetivo e escopo: Esta rotina tem como objetivo integrar as regras retornadas pela Systax com o Protheus
Classes:
EnviaCenarioClassificador - Contém todos os métodos para efetuar a integração das Regras
Métodos:
GetRegras( ) - Método para Ler as regras já obtidas e apresenta-las no Front
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caractere | Utilizar a filial para consulta de regras | http://localhost:9995/rest/GetRegras?filial=XIFIS26 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(oJretorno)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
GetRegrasDif( ) - Método para Ler as regras já obtidas e com atualizações para serem comparadas e apresentadas no Front
Parâmetros via QueryParam:
Parâmetro | Valor | Objetivo | Exemplo de chamada |
---|---|---|---|
filial | Caractere | Utilizar a filial para consulta de regras | http://localhost:9995/rest/GetRegrasDif?filial=XIFIS26&cenario=2319211&produto=PA0000000000000000000000000002&origem=0 |
cenario | Caractere | Utiliza o cenário para obter a regra específica | http://localhost:9995/rest/GetRegrasDif?filial=XIFIS26&cenario=2319211&produto=PA0000000000000000000000000002&origem=0 |
produto | Caractere | Utiliza o produto para obter a regra específica | http://localhost:9995/rest/GetRegrasDif?filial=XIFIS26&cenario=2319211&produto=PA0000000000000000000000000002&origem=0 |
origem | Caractere | Utiliza a origem para obter a regra específica | http://localhost:9995/rest/GetRegrasDif?filial=XIFIS26&cenario=2319211&produto=PA0000000000000000000000000002&origem=0 |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(oJretorno)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
IntegraRegras( ) - Método para integrar com o Configurador de Tributos, todas as regras obtidas do parceiro Systax, bem como atualizar o status da regra desejada
Parâmetros via Body
{ "empresa":"T1", "filial":"XIFIS26", "produto":"PA0000000000000000000000000002", "cenario": "2319211", "origem": "0", "status":"AP" } |
Status de regras
Status | Descrição |
---|---|
R | Regra Recusada |
I | Regra Inativa |
S | Regra Suspensa |
AP | Regra Aprovada |
AA | Regra Aguardando Aprovação |
Retorno:
Parâmetro | Tipo | Descrição |
---|---|---|
oRest:setResponse(oJretorno)) | Objeto | Responsável por inserir o conteúdo do corpo da mensagem na resposta da requisição HTTP. É possível executar mais de uma vez esse método, mas é importante saber que, a cada execução o conteúdo recebido no parâmetro será concatenado. |
Estes métodos são chamados através da nova tecnologia TLPP, Annotation @GET("/GetRegras") |