Totali Middleware

Definição de Métodos criados para atender geração de arquivos e processos impostos pelo PAFECF.

Métodos serão publicados em TPAFAPI.

Cada função é será responsável para geração de um arquivo ou execução de processo.

Arquivos gerados será retornado em Base64 reduzindo o conteúdo de transferência e aumentando a segurança das informações retornadas.

Exemplo:

• Método "RegistrosPAFECF" - Registros do PAF-ECF. (Requisito VI Item 17)

Definição dos Métodos

RegistrosPAFECF

Objetivo

Gera arquivo eletrônico para contemplar requisito VII item 17 conforme leiaute estabelecido no Anexo IV.

• O arquivo é gerado imediatamente após emissão da redução Z.
• O arquivo pode ser gerado pelo menu fiscal na opção "Registros do PAF-ECF".

Assinatura

(** * Gerar arquivo de Registros do PAF-ECF * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumeroECF":"<Número do ECF>", * "DataInicial":"", * "DataFinal":"<Data do Final>", * "ReducaoZ":"<Indicador de Geração na Redução Z?>", * "NomeAplicativo":"<Nome Comercial do Aplicativo PAF-ECF>", * "VersaoAplicativo":"<Versão Comercial do Aplicativo PAF-ECF>", * "MD5ArquivoAutenticacao":"<MD5 do Arquivo de Autenticação>", * "ListaProdutos":[ * { * "__comment__":"<Lista de Produtos>", * "Filmat":"<Nome do Arquivo>", * "Codmat":"<MD5 do Arquivo>", * "Codcor":"<MD5 do Arquivo>", * "Codtam":"<MD5 do Arquivo>" * } * ], * "EvidenciaTabelasDAV":"<Evidência Inclusão/Exclusão das tabelas de DAV quando informato Lista de Orcamentos>", * "ListaOrcamentos":[ * { * "__comment__":"<Lista de Orçamentos>", * "Filial":"<Código da Filial>", * "TipoPedido":"<Tipo do Pedido (O - DAV, S - DAV-OS)>", * "NumeroDAV":"<Número do DAV>", * "DataPedido":"<Data do Pedido>", * "Cliente": { * "__comment__":"<Cliente do DAV>", * "RazaoSocial":"<Nome/Razao Social>", * "NomeFantasia":"<Sobrenome/Nome Fantasia>", * "Documento":"<Número do Documento>", * "TipoPessoa":"<Tipo de Pessoa (0 - Física, 1 - Jurídica, 2 - Entidade, 3 - Especial, 4 - M.E., 5 - Filial)>" * }, * "ECFImpressao": { * "__comment__":"<ECF de Impressão do DAV>", * "Filial":"<Filial do ECF>", * "Numero":"<Número do ECF>", * "NumeroFabricacao":"<Nº de fabricação do ECF>", * "Modelo":"<Modelo do ECF>", * "Marca":"<Marca do ECF>", * "Tipo":"<Tipo do ECF>", * "MFAdicional":"<Letra indicativa de MF adicional>" * }, * "COOImpressaoDAV":"<COO de Impressão do DAV>", * "ValorTotal":"<Valor Total>", * "COOVendaDAV":"<COO do documento fiscal vinculado>", * "NumeroECFVendaDAV":"<Número do ECF emissor do documento fiscal vinculado>", * "RegistroValido":"<Registro Válido?>", * "Itens":[ * { * "__comment__":"<Lista de Itens>", * "NumeroItem":"<Número do item>", * "ProdutoServico": { * "__comment__":"<Produto>", * "CodigoFiscal":"<Código Fiscal>", * "Desmat":"<Descrição>", * "TipoTributacao":"<Tipo de Tributação (0 - Tributado, 1 - Não Tributado, 2 - Isento, 3 - Substituído, 4 - Isento no Estado)>", * "CodFps":"<Finalidade>", * "__comment_Finalidade_1__":"<00 – Mercadoria para Revenda, 01 - Matéria-Prima, 02 – Embalagem, 03 – Produto em Processo, 04 – Produto Acabado>", * "__comment_Finalidade_2__":"<05 – Subproduto, 06 – Produto Intermediário, 07 – Material de Uso e Consumo, 08 – Ativo Imobilizado>", * "__comment_Finalidade_3__":"<09 – Serviços, 10 – Outros Insumos, 99 – Outras)>", * "PerIcm":"<Percentual de ICMS/ISS>", * "Medida": { * "__comment__":"<Unidade de medida>", * "UniMed":"<Unidade de medida>" * }, * }, * "QtdItem":"<Quantidade>", * "vUnitario":"<Valor Unitário>", * "vDesconto":"<Valor do Desconto>", * "vAcrescimo":"<Valor do Acréscimo>", * "vTotalSemDesc":"<Valor Total>", * "SituacaoItemOrcamentoPAF":"<Situação (C - Cancelado, O - Concluído, A - Em aberto, T - Em andamento, E - Faturado/Vendido, R - Reservado)>", * "CasasDecimaisQuantidade":"<Casas decimais utilizadas na Quantidade>", * "CasasDecimaisValor":"<Casas decimais utilizadas no Valor>", * "RegistroValido":"<Registro Válido?>" * } * ], * "Alteracoes":[ * { * "__comment__":"<Lista de Alterações>", * "NumeroItem":"<Número do item>", * "ProdutoServico": { * "__comment__":"<Produto>", * "CodigoFiscal":"<Código Fiscal>", * "Desmat":"<Descrição>", * "TipoTributacao":"<Tipo de Tributação (0 - Tributado, 1 - Não Tributado, 2 - Isento, 3 - Substituído, 4 - Isento no Estado)>", * "CodFps":"<Finalidade>", * "__comment_Finalidade_1__":"<00 – Mercadoria para Revenda, 01 - Matéria-Prima, 02 – Embalagem, 03 – Produto em Processo, 04 – Produto Acabado>", * "__comment_Finalidade_2__":"<05 – Subproduto, 06 – Produto Intermediário, 07 – Material de Uso e Consumo, 08 – Ativo Imobilizado>", * "__comment_Finalidade_3__":"<09 – Serviços, 10 – Outros Insumos, 99 – Outras)>", * "PerIcm":"<Percentual de ICMS/ISS>", * "Medida": { * "__comment__":"<Unidade de medida>", * "UniMed":"<Unidade de medida>" * } * }, * "Data":"<Data do Log>", * "TipoLog":"<Tipo do Log (I - Inclusão, A - Alteração, E - Exclusao)>", * "Quantidade":"<Quantidade>", * "ValorUnitario":"<Valor Unitário>", * "ValorDesconto":"<Valor do Desconto>", * "ValorAcrescimo":"<Valor do Acréscimo>", * "ValorTotal":"<Valor Total>", * "Cancelado":"<Indicador de Cancelamento>", * "CasasDecimaisQuantidade":"<Casas decimais utilizadas na Quantidade>", * "CasasDecimaisValor":"<Casas decimais utilizadas no Valor>", * "RegistroValido":"<Registro Válido?>" * } * ] * } * ], * "GeraBlocoP":"<Indicador de Geração do Bloco P?>", * "GeraBlocoE":"<Indicador de Geração do Bloco E?>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>" * } * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function RegistrosPAFECF(const pParametros: TJSONObject): TJSONObject; stdcall;

IdentificacaoPAFECF

Objetivo

Gerar impressão, pelo ECF, de Relatório Gerencial, denominado IDENTIFICAÇÃO DO PAF-ECF.

Assinatura

(** * Gerar arquivo de Identificação do PAF-ECF * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NomeAplicativo":"<Nome Comercial do Aplicativo PAF-ECF>", * "VersaoAplicativo":"<Versão Comercial do Aplicativo PAF-ECF>", * "NomePrincipalExecutavel":"<Nome do Principal Executável do Aplicativo PAF-ECF>", * "MD5PrincipalExecutavel":"<MD5 do Principal Executável do Aplicativo PAF-ECF>", * "NumeroLaudo":"<Número do Laudo>", * "DataLaudo":"<Data do Laudo>", * "NomeArquivoAutenticacao":"<Nome do Arquivo de Autenticação>", * "MD5ArquivoAutenticacao":"<MD5 do Arquivo de Autenticação>", * "ListaArquivo":[ * { * "__comment__":"<Lista de Arquivos executáveis do PAF-ECF>" * }, * { * "Nome":"<Nome do Arquivo>", * "MD5":"<MD5 do Arquivo>" * } * ], * "ListaNumeroSerie":[ * { * "__comment__":"<Lista de Número de Série dos ECF utilizados no Estabelecimento>" * }, * { * "NumeroFabricacao":"<Número de Série da Fabricação>" * } * ], * "NumeroColunas":"<Número de Colunas (opcional - Padrão 48)>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function IdentificacaoPAFECF(const pParametros: TJSONObject): TJSONObject; stdcall;

TabelaIndiceTecnicoProducao

Objetivo

Gera arquivo com a tabela de índices técnicos de produção (Requisito VII, alínea 20)

Assinatura

(** * Gerar arquivo de Tabela de Índice Técnico de Produção * * @param pParametros string JSON com a seguinte estrutura: * {"ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function TabelaIndiceTecnicoProducao(const pParametros: TJSONObject): TJSONObject; stdcall;

ParametrosConfiguracao

Objetivo

Gerar o relatório de parâmetros de Configuração conforme requisito VII, item 21.

Assinatura

(** * Gerar arquivo de Parâmetros de Configurações * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function ParametrosConfiguracao(const pParametros: TJSONObject): TJSONObject; stdcall;

ImprimeDAV

Objetivo

Gerar impressão de DAV em um arquivo texto para que o Checkout e o Order possam imprimí-lo em um ECF.
Quem utiliza esse método fica responsável por gravar o COO da impressão no campo TT_ORC.COOORC.

Assinatura

(** * Gerar arquivo de Impressão de DAV * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "Tipo":"<Tipo de Orçamento - Opções(O - DAV, S - DAV-OS)>", * "NumeroPedido":"<Número do DAV)>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function ImprimeDAV(const pParametros: TJSONObject): TJSONObject; stdcall;

DAVEmitidos

Objetivo

Gerar o relatório gerencial de Dav Emitidos com base no requisito VI item 6 ou Gerar o relatório gerencial de Dav-Os Emitidos com base no requisito XLI Item 1.

Assinatura

(** * Gerar arquivo de Impressão com Relação de DAVs Emitidos * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "DataInicial":"<Data Inicial>", * "DataFinal":"<Data Final>", * "Tipo":"<Tipo de Orçamento (opcional) - Opções(O - DAV, S - DAV-OS)>", * "NumeroColunas":"<Número de Colunas (opcional - Padrão 40)>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function DAVEmitidos(const pParametros: TJSONObject): TJSONObject; stdcall;

VendasIdentificadas

Objetivo

Gera arquivo eletrônico para contemplar o requisito VII, item 22 conforme leiaute estabelecido no anexo VI.

Assinatura

(** * Gerar arquivo de Vendas Identificaxas BlocoZ * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NomePAFECF":"<Nome do PAF-ECF>", * "VersaoPAFECF":"<Versão do PAF-ECF>", * "NumeroLaudo":"<Número do Laudo>", * "Mes":"<Mes da Venda>", * "Ano":"<Ano da Venda>", * "Documento":"<Documento da Venda (opcional)>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function VendasIdentificadas(const pParametros: TJSONObject): TJSONObject; stdcall;

ConsultarPerfilEstado

Objetivo

Verificar aplicação para funcionalidade no perfil do Estado no PAF-ECF.
A documentação da tabela completa dos perfis tratados pode ser consultada em Tabela de Perfil por UF.

Assinatura

(** * Retorna se funcionalidade é obrigatória para o Estado * * @param pParametros string JSON com a seguinte estrutura: * {"Funcionalidade":"<Funcionalidade>", * "Estado":"<Estado>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON indicando se exige a funcionalidade>, * "str":"<String JSON>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function ConsultarPerfilEstado(const pParametros: TJSONObject): TJSONObject; stdcall;

PermiteGeracaoFiscoReducaoZ

Objetivo

Verificar permissão de geração para arquivos de Redução Z do Bloco X.

Assinatura

(** * Obtém autorização para geração do arquivo Fisco Redução Z * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>", * "NumCRZ":<Contador de Redução Z>, * "NumCRO":<Contador de Reinicio de Operação>} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON com indicação se permite geração do arquivo>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function PermiteGeracaoFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

GeraXML_BlocoX_ReducaoZ

Objetivo

Gera arquivo eletrônico para contemplar requisito LVIII conforme leiaute estabelecido.

• O arquivo é gerado imediatamente após emissão da redução Z.

Assinatura

(** * Geração arquivo de Redução Z do Bloco X * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>", * "NumCRZ":<Contador de Redução Z>, * "NumCRO":<Contador de Reinicio de Operação>, * "NomePAFECF":"<Nome do PAF-ECF>", * "VersaoPAFECF":"<Versão do PAF-ECF>", * "CredenciamentoPAFECF":"<Número do Credenciamento do PAF-ECF>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function GeracaoFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

InclusaoFiscoReducaoZ

Objetivo

Realiza inclusão do arquivo Fisco Redução Z do Bloco X na Base do Middleware.

Assinatura

(** * Realiza inclusão do arquivo Fisco Redução Z * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>", * "NumCRZ":<Contador de Redução Z>, * "NumCRO":<Contador de Reinicio de Operação>, * "DTMovRZ":"<Data Movimento da Redução Z>", * "XML":"<Conteudo Arquivo XML Redução Z>", * "XMLCodificado":"<Identifica que XML foi enviado com codificação em Base64>" * } * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function InclusaoFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

TransmissaoFiscoReducaoZ

Objetivo

Realiza transmissão do arquivo Fisco Redução Z do Bloco X.

Assinatura

(** * Realiza transmissão do arquivo Fisco Redução Z * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>, * {"recibos":[ * {"Numero":"<String JSON do Número do Recibo>", * "Codigo":"<Integer JSON do Código de Retorno da Transmissão>", * "Mensagem":"<String JSON da Mensagem de Retorno da Transmissão>", * "XML":"<String JSON do XML de Retorno da Transmissão>", * "Filial":"<String JSON do Código da Filial>", * "NumeroECF":"<String JSON do Número do ECF", * "ContadorReducaoZ":<Integer JSON do Contador de Redução Z>, * "ContadorReinicioOperacao":<Integer JSON do Contador de Reinicio de Operação>}, * {...} * ]} * }} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function TransmissaoFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

UltimoRegistroFiscoReducaoZ

Objetivo

Retorna última registro do arquivo Fisco Redução Z do Bloco X.

Assinatura

(** * Retorna última registro do arquivo Fisco Redução Z * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com Contador de Redução Z>, * "date":"<Data JSON com Data Movimento da Redução Z>", * "curr":<Currency JSON>, * {"fiscoreducaoz": * {"Filial":"<String JSON do Código da Filial>", * "NumeroECF":"<String JSON do Número do ECF", * "ContadorReducaoZ":<Integer JSON do Contador de Redução Z>, * "ContadorReinicioOperacao":<Integer JSON do Contador de Reinicio de Operação>, * "DataMovimentoReducaoZ":"<Data JSON da Data do Movimento da Redução Z>", * "DataEnvio":"<Data JSON da Data de Envio>", * {"recibo": * {"Numero":"<String JSON do Número do Recibo>"}} * }} * }} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function UltimoRegistroFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

MensagemPendenciasFiscoReducaoZ

Objetivo

Retorna mensagem de pedências de transmissão do arquivo Fisco Redução Z do Bloco X.

Assinatura

(** * Retorna mensagem de pedências de transmissão do arquivo Fisco Redução Z * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "NumECF":"<Número do ECF>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function MensagemPendenciasFiscoReducaoZ(const pParametros: TJSONObject): TJSONObject; stdcall;

PermiteGeracaoFiscoEstoque

Objetivo

Verificar permissão de geração para arquivos de Estoque do Bloco X.

Assinatura

(** * Obtém autorização para geração do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "DataEstoque":"<Data do Estoque>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON com indicação se permite geração do arquivo>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function PermiteGeracaoFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

GeracaoFiscoEstoque

Objetivo

Gera arquivo eletrônico para contemplar requisito LIX conforme leiaute estabelecido.

• O arquivo é gerado imediatamente após emissão da redução Z do primeiro ECF na virada do mês, podendo ser gerado até o 5 dia útil após a virada do mês.

Assinatura

(** * Geração arquivo de Estoque do Bloco X * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "DataEstoque":<Data do Estoque (Deve ser informado o último dia do Mês)>, * "NomePAFECF":"<Nome do PAF-ECF>", * "VersaoPAFECF":"<Versão do PAF-ECF>", * "CredenciamentoPAFECF":"<Número do Credenciamento do PAF-ECF>", * "ArquivoCompactado":"<Compacta Arquivo de retorno? (opcional - Padrão True)>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com valor em Base64 do arquivo gerado>", * "int":<Inteiro JSON>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function GeracaoFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

InclusaoFiscoEstoque

Objetivo

Realiza inclusão do arquivo Fisco Estoque do Bloco X.

Assinatura

(** * Realiza inclusão do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>", * "DataEstoque":"<Data do Estoque>", * "XML":"<Conteudo Arquivo XML Redução Z>", * "XMLCodificado":"<Identifica que XML foi enviado com codificação em Base64>" * } * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function InclusaoFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

TransmissaoFiscoEstoque

Objetivo

Realiza transmissão do arquivo Fisco Estoque do Bloco X.

Assinatura

(** * Realiza transmissão do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>, * {"recibos":[ * {"Numero":"<String JSON do Número do Recibo>", * "Codigo":"<Integer JSON do Código de Retorno da Transmissão>", * "Mensagem":"<String JSON da Mensagem de Retorno da Transmissão>", * "XML":"<String JSON do XML de Retorno da Transmissão>", * "Filial":"<String JSON do Código da Filial>", * "DataEstoque":"<Data JSON da Data do Estoque>"}, * {...} * ]} * }} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function TransmissaoFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

UltimaTransmissaoFiscoEstoque

Objetivo

Retorna última transmissão do arquivo Fisco Estoque do Bloco X.

Assinatura

(** * Retorna última transmissão do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON>, * "date":"<Data JSON com Data do Estoque>", * "curr":<Currency JSON>, * {"fiscoestoque": * {"Filial":"<String JSON do Código da Filial>", * "DataEstoque":"<Data JSON da Data do Estoque>", * "DataEnvio":"<Data JSON da Data de Envio>", * {"recibo": * {"Numero":"<String JSON do Número do Recibo>"}}, * }} * }} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function UltimaTransmissaoFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

UltimoRegistroFiscoEstoque

Objetivo

Retorna último registro do arquivo Fisco Estoque do Bloco X.

Assinatura

(** * Retorna último registro do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON>, * "date":"<Data JSON com Data do Estoque>", * "curr":<Currency JSON>, * {"fiscoestoque": * {"Filial":"<String JSON do Código da Filial>", * "DataEstoque":"<Data JSON da Data do Estoque>", * "DataEnvio":"<Data JSON da Data de Envio>", * {"recibo": * {"Numero":"<String JSON do Número do Recibo>"}}, * }} * }} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function UltimoRegistroFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

MensagemPendenciasFiscoEstoque

Objetivo

Retorna mensagem de pedências de transmissão do arquivo Fisco Estoque do Bloco X.

Assinatura

(** * Retorna mensagem de pedências de transmissão do arquivo Fisco Estoque * * @param pParametros string JSON com a seguinte estrutura: * {"Filial":"<Código da Filial>"} * * @return string JSON com resultado da operação. * Se o webservice conseguir tratar a operação retornará da seguinte forma: * * {"result": * {"controle": * {"err":<Boolean JSON>, * "cod":<Integer JSON>, * "msg":"<String JSON>"}}, * {"conteudo": * {"bool":<Boolean JSON>, * "str":"<String JSON com mensagem da operação>", * "int":<Inteiro JSON com quantidade de arquivos pedências de envio>, * "date":"<Data JSON>", * "curr":<Currency JSON>}} * Exemplo de retorno com erro * {"result":"Mensagem de Erro"} * {"error":"Mensagem de Erro"} * *) function MensagemPendenciasFiscoEstoque(const pParametros: TJSONObject): TJSONObject; stdcall;

Alterações

Nessa seção estão relacionadas as alterações que o Middleware sofreu a cada versão. Desta forma, pode-se por aqui verificar quais tratamentos passam a ser necessários ao atualizar a versão mais recente.

Versão 5.3B

Referenciado por: Tabela de Perfil por UF |