Cloud - Importação

POST - /npm{MODULO}/ProcessoExecutar

Permite importar dados para os cadastros do sistema.

Requisição: http://{servidor}/npm{MODULO}/ProcessoExecutar

Parâmetros Body

Parâmetro	Obrigatório	Tipo do Parâmetro	Descrição	Valores Válidos
MODULO	Sim	Texto	Informar o módulo do sistema que executará a importação na requisição.	"nArq", "nCtb", "nCtr", "nFis", "nFpa", "nGem", "nInv" Ex.: http://{servidor}/npm{MODULO}/ProcessoExecutar
CLASS	Sim	Texto	Nome interno da rotina para importação dos dados.	"TnDMPowerParamImportarDados"
PLEIAUTE	Lista dos leiautes que serão utilizados na importação.
PLEIAUTE.data	Sim	Texto	Dados do leiaute utilizado na importação formatado em Base 64.	"b2JqZWN0IFRuSXRlbUltcG9ydGFjYW8KICBEZWxpbWl0YWRvciA 9ICMwCiAgRE1DbGFzc05hbWUgPSAnVG5DdGJE..."
PLEIAUTE.filename	Sim	Texto	Informar o nome e extensão para o importador salvar os dados do leiaute.	Ex.: "LctoFisSai.nli"
PARQUIVO	Informações e dados que serão importados.
PARQUIVO.data	Sim	Texto	Conteúdo do arquivo que será importado formatado em base 64.	"IDAwMDFJbmdsw6pzICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIDAwMDJFc3B hbmhvbCAgICAgICAgICAgICAgICAgIC..."
PARQUIVO.filename	Sim	Texto	Informar o nome e extensão para o importador salvar os dados do arquivo a ser importado.	Ex.: "DadosLctoFisSai.txt" ; "DadosLctoFisSai.csv"
PGERARBACKUP	Sim	Texto	Gera uma cópia de segurança do arquivo que está endo importado.	"0" para Não "1" para Sim
PPODEALTERARDADOS	Sim	Texto	Não é recomendado deixar como SIM, pois impacta diretamente na performance, para as importação em geral deve ser deixado como NÃO. Se informado SIM, o sistema irá atualizar os dados da tabela, informada no arquivo de configuração do leiaute, conforme os dados que constam no arquivo importado, utilizando como referencia o campo informado na variável IgnorarSeDuplicado. Caso o sistema encontre um registro com essa informação do campo IgnorarSeDuplicado, no banco e no arquivo, será atualizado os dados, caso contrário irá inserir esse registro. Caso não seja utilizado a variável IgnorarSeDuplicado, o sistema faz a pesquisa considerando a chave primária da tabela.	"0" para Não "1" para Sim
PVALIDARIMPORTACAO	Sim	Texto	É uma opção que quando informada com sim realiza validações no conjunto dos dados que estão sendo importados. Exemplo: Na importação de lançamentos contábeis valida se existem diferenças de débito/crédito no arquivo. Quando houveram diferenças não importa os dados.	"0" para Não "1" para Sim
PFILTRO	Não	Texto	Utilizado para realizar algum filtro durante a importação.	Ex.: "CodigoEmpresa=5;CodigoEstab=1;DatalctoFis=01/01/2021..31/12/2021" Neste exemplo vai importar apenas os dados da empresa 5, filial 1 e movimento entre 01/01/2021 e 31/12/2021

O body deve ser composto conforme especificação dos parâmetros acima, um JSON contendo a lista de leiautes e dados que serão utilizados na importação.

Assim como no importador do tributário, pode-se informar mais de um leiaute a ser importado do mesmo arquivo, basta informar mais de um leiaute na propriedade "PLEIAUTE".

Possibilita informar um filtro de dados na propriedade "PFILTRO", este filtro será aplicado nos dados que serão imporgados. As informações que não corresponderem ao filtro serão ignoradas.

Possibilita informar se o processo pode alterar os dados (para registros já existentes no banco de dados) ou não, através da propriedade "PPODEALTERARDADOS".

Possibilita informar se o processo de realizar uma validação final ao importar os dados através da propriedade "PVALIDARIMPORTACAO". Estas validações são regras específicas direcionadas aos lançamentos contábeis.

O formato dos leiautes e dados podem ser enviados como um texto formatado em Base 64. Exemplo:

{
"Class": "TnDMPowerParamImportarDados",

"PLEIAUTE": {
"data": "ARQUIVOLEIAUTEEMBASE64",
"filename": "nomearquivo.extensao"
},

"PARQUIVO": {
"data": "ARQUIVODADOEMBASE64",
"filename": "nomearquivo.extensao"
},

"PGERARBACKUP": "1",
"PPODEALTERARDADOS": "0",
"PVALIDARIMPORTACAO": "0",
"PFILTRO": ""
}

Respostas

Resposta Conteúdo

200

Retorna um JSON contendo os datamodules utilizados na importação bem como informações sobre as chaves utilizados na importação de cada linha ou o erro encontrado na importação da linha. Ex:

{
"resultados": [
{
"datamodule": "TnCtbDMIdioma",
"linhas": [
{
"linha": "1",
"chave": "CODIGOIDIOMA: 1"
},
{
"linha": "2",
"erro": "Violação da chave primária. Ocorreu duplicação da chave primáriana tabela: IDIOMA \r\nProblematic\r\n\r\n[FireDAC][Phys][FB]violation of PRIMARY or UNIQUE KEY constraint \"PKIDIOMA\" on table \"IDIOMA\"\r\nProblematic key value is (\"CODIGOIDIOMA\" = 2)"
}
]
}
]
}

401

Acontece quando a base possui um token de validação que não foi repassado através do parâmetro "tokenapi" ou está incorreto. Ex:

{

"errorCode": 401,

"errorText": "Acesso negado, verifique o to ken informado."

}