Webservice Unificado DFe

Objetivo

Anteriormente a aplicação Suíte Fiscal Estratégica possuía diversos Webservices para integração. Para centralizar a integração e facilitar o desenvolvimento e integração com a aplicação foram feitas alterações que resultaram em um único Webservice.

Este documento tem por objetivo especificar os métodos de integração entre outras aplicações e a aplicação Suíte Fiscal Estratégica via WebService Unificado.

Importante!: Essa funcionalidade somente estará disponível com a aquisição de um plugin de webservice SFE. Também caso necessário como possuímos links em alguns métodos do Webservice(Workflow) efetuamos a liberação da documentação no Sharepoint Becomex em: https://becomex.sharepoint.com/:f:/s/SFE.Sharepoint/Eq6gxFAh0PBEgOCabTDZJbUBwi8VtOjlNzQlytwbyZXTIA?e=PlK01A (Salientamos que esse link é liberado para uso interno na rede Becomex e caso necessário deve ser solicitado a nossa equipe de Projetos, em caso de implantação, ou para nossa equipe de Suporte)

Webservice Unificado

O Webservice Unificado é instalado junto à aplicação, tal webservice se chama “Governanca Webservice”. Exemplo:

Métodos

Este tópico descreve como os métodos e as respectivas requisições/respostas.

CriarToken

Método responsável para gerar o “Token de Acesso” que representa a autenticação do usuário junto ao webservice. O “Token de Acesso” retornado deverá ser utilizado nos outros métodos como autenticação.

Requisição “CriarTokenRequest”

Campo	Tipo	Descrição
Usuario	String	Usuário que pretende autenticar no sistema
Senha	String	Senha do usuário

Resposta “CriarTokenResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
Token	String	Token de autenticação
WsError
Campo	Tipo	Descrição
Msg	String	Mensagem de erro
Code	Int	Código do erro
Ex	Exception	Exceção

ArquivoXMLReceiver

Método responsável por retornar o arquivo XML do documento solicitado conforme parâmetros solicitados, além do XML original ou traduzido este método retorna ao sistema externo informações relacionadas a processos da SFE, por exemplo, situação do manifesto do destinatário, status do documento na Sefaz, situação da conferência comercial entre outras que serão visualizadas no decorrer deste tópico

Requisição “ArquivoXMLReceiverRequest”

Método responsável pelo retorno do conteúdo do arquivo XML de acordo com os parâmetros informados na requisição, respeitando as seguintes diretrizes:

· Quando a chave do documento é informada e o documento é uma NF-e ou CT-e, não é necessário informar o restante dos parâmetros.

· Quando a chave do documento não é informada é obrigatório a preenchimento dos seguintes parâmetros:

· NF-e, CT-e ou CTe-OS: Tipo, Numero, Serie e CNPJEmitente;

· NFS-e: Tipo, Numero, Serie, CNPJEmitente e MesAnoEmissao.

Campo	Tipo	Descrição
Token	String	Token de autenticação
Chave	String	Chave do documento
Tipo	Int	Tipo do documento: NFe = 1 CTe = 2 NFSe = 3 NFCe = 4 CTeOs = 5 CancelNFe = 10 CancelCTe = 11 EventoNFe = 20 EventoCTeOuCTeOS = 21 InutilizacaoNfe = 30 InutilizacaoCte = 31 Indefinido = 99
Numero	String	Número do documento
Serie	String	Série do documento
CNPJEmitente	String	CNPJ do emitente do documento
MesAnoEmissão	String	Mês e ano de emissão do documento
TipoXmlRetorno	Int	Tipo do arquivo XML: Original = 0 ou 1 Traduzido = 2

Resposta “ArquivoXMLReceiverResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
Chave	String	Chave do documento
Numero	String	Número do documento
Serie	Serie	Série do documento
DhrEmissao	DateTime	Data e hora da emissão
Fornecedor	String	Fornecedor
Status	String	Status do documento: 100 – Válido 101 – Cancelado 999 - Outros
Valor	Decimal	Valor do documento
XML	String	XML do documento
StatusRecebimento	Int?	Situação do recebimento: Indefinido = 0 Digitado = 1 Confirmado = 2 Recebido = 3 AlertaIntegracao = 4 AtualizadoNoErp = 5 Eliminado = 6 Bloqueado = 7 PendenteNoErp = 8 AprovacaoMigo = 9 AprovacaoMiro = 10
StatusPortaria	Bool	Indica se passou na portaria
StatusManifestacao	Int?	Situação do recebimento: SEM_MANIFESTACAO = 0 CONFIRMACAO_OPERACAO = 1 CIENCIA_OPERACAO = 2 DESCONHECIMENTO_OPERACAO = 3 OPERACAO_NAO_REALIZADA = 4 CTE_PRESTACAO_SERVICO_DESACORDO = 5
StatusConferenciaComercial	String	Situação da Conferência Comercial: Não se aplica = “N.A.” Sucesso = “Sim” Sem sucesso = “Não”
StatusConferencialFiscal	String	Situação da conferência Fiscal: Não se aplica = “N.A.” Sucesso = “Sim” Sem sucesso = “Não”

IntegrarXmlErp

Método responsável por disponibilizar o XML para integração com o ERP. Este método pode ser utilizado para que sistemas externos a SFE possam disparar a geração do XML traduzido na pasta de integração para que o ERP possa realizar a integração do documento. Um exemplo prático de utilização deste método se dá quando existe um gatilho externo a SFE que dispare a integração, por exemplo, um processo de contagem que quando OK envie um sinal a SFE que o documento fiscal deve ser enviado ao ERP.

Cabe lembrar que este método não realiza a integração definitiva com o ERP, ele apenas disponibiliza o XML para integração e é a camada de integração com o ERP tem que a responsabilidade de integrar o documento ao sistema de recebimento.

Requisição “ArquivoXMLReceiverRequest”

Método responsável por disponibilizar o XML para a integração com o ERP, de acordo com a parametrização do sistema (via Web Service, RFC, Diretório ou FTP). Após a chamada do método, o sistema verifica se o XML existe ou não na base e realiza a tentativa de disponibilização do XML para integração conforme os parâmetros:

· Quando a chave do documento é informada e o documento é uma NF-e ou CT-e, não é necessário informar o restante dos parâmetros.

· Quando a chave do documento não é informada é obrigatório a preenchimento dos seguintes parâmetros:

· NF-e, CT-e ou CTe-OS: Tipo, Numero, Serie e CNPJEmitente;

· NFS-e: Tipo, Numero, Serie, CNPJEmitente e MesAnoEmissao.

Para efetivar a entrega do XML para a integração, a aplicação realiza as mesmas consistências efetuadas quando acionado o botão receber na tela do monitor de documentos da SFE. Ou seja, este método realiza uma simulação de um usuário acionando o botão receber do monitor de documentos.

Campo	Tipo	Descrição
Token	String	Token de autenticação
Chave	String	Chave do documento
Tipo	Int	Tipo do documento: NFe = 1 CTe = 2 NFSe = 3 NFCe = 4 CTeOs = 5 CancelNFe = 10 CancelCTe = 11 EventoNFe = 20 EventoCTeOuCTeOS = 21 InutilizacaoNfe = 30 InutilizacaoCte = 31 Indefinido = 99
Numero	String	Número do documento
Serie	String	Série do documento
CNPJEmitente	String	CNPJ do emitente do documento
MesAnoEmissão	String	Mês e ano de emissão do documento

Resposta “IntegrarXmlErpResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
XmlEnviadoErp	Boolean	Indica se o XML foi integrado ou não

AtualizaItemSemDePara

Método responsável por atualizar itens sem “De Para” na tradução.

Requisição “AtualizaItemSemDeParaRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
Itens	ItemSemDePara[]	Itens a serem atualizados
ItemSemDePara
Campo	Tipo	Descrição
CodEmpresa	Decimal	Código da empresa
CodFornecedor	String	Código do fornecedor
CodItemFornec	String	Código do item do fornecedor
CodUnidMedidaFornec	String	Código da UN do fornecedor
CodItemInterno	String	Código do item internamente
DesItemInterno	String	Descrição do item internamente
CodUnidMedida	String	Código da UN
TipoItem	String	Tipo do item: MERCADORIA_PARA_REVENDA = 00 MATERIA_PRIMA = 01 EMBALAGEM = 02 PRODUTO_EM_PROCESSO = 03 PRODUTO_ACABADO = 04 SUBPRODUTO = 05 PRODUTO_INTERMEDIARIO = 06 MATERIAL_DE_USO_E_CONSUMO = 07 ATIVO_IMOBILIZADO = 08 SERVICOS = 09 OUTROS_INSUMOS = 10 OUTRAS = 99 INVALIDO = 999

Resposta “AtualizaItemSemDeParaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

AtualizaSituacaoContagem

Método responsável por atualizar a situação de contagem dos itens da NF-e.

Requisição “AtualizaSituacaoContagemRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
Documentos	Documento[]	Documentos a serem atualizados
Documento
Campo	Tipo	Descrição
CodEmpresa	String	Código da empresa
CodEstabelecimento	String	Código do estabelecimento
ChvNf	String	Chave do documento
Itens	ItemDoc[]	Itens do documento
ItemDoc
Campo	Tipo	Descrição
NfItemSequencia	Int	Sequência do item no documento
NfItemCodigo	String	Código do item no documento
IndContagem	Int	Indicador de contagem: PENDENTECONTAGEM = 1 NAONECESSITACONTAGEM = 2 PENDENTECONTAGEMEXTERNA = 3 CONTAGEMREALIZADA = 4

Resposta “AtualizaSituacaoContagemResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

BuscaDadosInteligenciaFiscal

Método responsável por buscar os dados da Inteligência Fiscal.

Requisição “BuscaDadosInteligenciaFiscalRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
DataUltimaConsulta	DateTime	Data da última consulta

Resposta “BuscaDadosInteligenciaFiscalResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
MatrizIcmsResult	MatrizIcms[]	Matrizes de ICMS
MatrizIcmsStResult	MatrizIcmsSt[]	Matrizes de ICMS ST
MatrizIpiResult	MatrizIpi[]	Matrizes de IPI
MatrizIiResult	MatrizIi[]	Matrizes de II
MatrizPisCofinsResult	MatrizPisCofins[]	Matrizes de PIS/COFINS
MatrizDifalResult	MatrizDifal[]	Matrizes de DIFAL
MatrizIcms
Campo	Tipo	Descrição
IdAliquotaInterestadual	Int	Id da alíquota interestadual
UfOrigem	Int	UF origem
UfDestino	Int	UF destino
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
Aliquota	Decimal	Alíquota
Observação	String	Observação
MatrizIcmsSt
Campo	Tipo	Descrição
IdMatrizIcmsSt	Int	Id da matriz
UfOrigem	Int	UF origem
UfDestino	Int	UF destino
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
CodNcm	String	Código do NCM
Cest	String	Código CEST
MvaOriginal	Decimal	MVA original
MvaAjustado	Decimal	MVA ajustado
MvaAjustado4Pct	Decimal	MVA ajustado 4 pct
Protocolo	String	Protocolo
Alerta	String	Alerta
Responsabilidade	String	Responsabilidade
TipoCalculo	Int	Tipo de cálculo: CALCULO_MVA = 1 CALCULO_PAUTA = 2
ValPauta	Decimal	Valor da pauta
DataAtualizacao	DateTime	Data da atualização
StatusMonitoramento	Int	Status do monitoramento: CARGA_LOCAL = 0 CARGA_WS_PENDENTE_ATUALIZACAO = 1 CARGA_WS_ATUALIZADO = 2
MatrizIpi
Campo	Tipo	Descrição
IdIpi	Int	Id da matriz
CodNcm	String	Código do NCM
CodExIpi	Int	Código ex IPI
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
Aliquota	Decimal	Alíquota
CodDecreto	String	Código do decreto
Obsercavao	String	Observação
DataAtualizacao	DateTime	Data da atualização
StatusMonitoramento	Int	Status do monitoramento: CARGA_LOCAL = 0 CARGA_WS_PENDENTE_ATUALIZACAO = 1 CARGA_WS_ATUALIZADO = 2
MatrizIi
Campo	Tipo	Descrição
IdTec	Int	Id da matriz
CodNcm	String	Código do NCM
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
Aliquota	Decimal	Alíquota
Obsercavao	String	Observação
DataAtualizacao	DateTime	Data da atualização
StatusMonitoramento	Int	Status do monitoramento: CARGA_LOCAL = 0 CARGA_WS_PENDENTE_ATUALIZACAO = 1 CARGA_WS_ATUALIZADO = 2
MatrizPisCofins
Campo	Tipo	Descrição
IdMatrizPisCofins	Int	Id da matriz
UfOrigem	Int	UF origem
UfDestino	Int	UF destino
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
CodNcm	String	Código do NCM
AliqPis	Decimal	Alíquota do PIS
AliqCofins	Decimal	Alíquota de COFINS
TipoIncidencia	Int	Tipo de incidência NORMAL = 0 MONOFASICA = 1
Complemento	String	Complemento
DataAtualizacao	DateTime	Data da atualização
StatusMonitoramento	Int	Status do monitoramento: CARGA_LOCAL = 0 CARGA_WS_PENDENTE_ATUALIZACAO = 1 CARGA_WS_ATUALIZADO = 2
MatrizDifal
Campo	Tipo	Descrição
IdDifal	Int	Id da matriz
UfOrigem	Int	UF origem
UfDestino	Int	UF destino
Cfop	String	CFOP
DataInicioValidade	DateTime	Data de início
DataFimValidade	DateTime	Data de fim
AliquotaDifal	Decimal	Alíquota DIFAL
AliqFundoPobreza	Decimal	Alíquota do Fundo de Pobreza
PctPartOrigem	Decimal	Pct Part Origem
PctPartDestino	Decimal	Pct Part Destino
Observação	String	Observação
DataAtualizacao	DateTime	Data da atualização
StatusMonitoramento	Int	Status do monitoramento: CARGA_LOCAL = 0 CARGA_WS_PENDENTE_ATUALIZACAO = 1 CARGA_WS_ATUALIZADO = 2

CadastraAuditoria

Método responsável por cadastrar uma auditoria.

Requisição “CadastraAuditoriaRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
Email	String	Email
FileName	String	Nome do arquivo
FileExtension	String	Extensão do arquivo
FileBytes	Byte[]	Arquivo em bytes

Resposta “CadastraAuditoriaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
CodAuditoria	Decimal	Código da auditoria cadastrada
CnpjArquivo	String	CNPJ do arquivo
RazaoSocial	String	Razão social do arquivo
DataInclusão	DateTime	Data de inclusão
PeriodoArquivo	String	Período do arquivo
TipoAuditoria	String	Tipo da auditoria: EFD_FISCAL = 1 EFD_CONTRIBUICOES = 2 ECD = 3 FCONT = 4 CONCILIACAO_EFDCONTRIB_DACON = 5 CONCILIACAO_EFDCONTRIB_SPEDFISCAL = 6 CONCILIACAO_EFDCONTRIBFISCAL_XMLNFECTE = 7 CONCILIACAO_SPEDFISCAL_GIA_SP = 8 CONCILIACAO_SPEDFISCAL_DAPI = 9 CONCILIACAO_SPEDFISCAL_ADUANEIRA = 10 CONCILIACAO_SPEDFISCAL_SINTEGRA = 11 CONCILIACAO_FISCAL_ERP_FISCAL = 12 CONCILIACAO_SPEDFISCAL_DIME = 13 CONCILIACAO_SPEDFISCAL_DIEF = 14 CONCILIACAO_SPEDFISCAL_GIA_RS = 15 CONCILIACAO_SPEDFISCAL_GIA_PR = 16 CONCILIACAO_DACON_DCTF = 17 CONCILIACAO_DIPJ_DCTF = 18 CONCILIACAO_DIRF_DCTF = 19 CONCILIACAO_DCTF_PERDCOMP = 20 CONCILIACAO_DIPJ_PERDCOMP = 21 CONCILIACAO_DIPJ_DIRF = 22 CONCILIACAO_DIPJ_ECD = 23 CONCILIACAO_DIPJ_FCONT = 24 CONCILIACAO_FISCAL_BPM = 25 CONCILIACAO_FISCAL_CONTABIL = 26 CONCILIACAO_SPEDFISCAL_DMA_BA = 27 CONCILIACAO_SPEDFISCAL_GIAM_RO = 28 MACROFERTIL = 30 DETALHE_ENTRADA_SAIDA_SPED = 29 CONCILIACAO_SPEDFISCAL_GIA_RJ = 31 CONCILIACAO_FISCAL_ERP_FISCAL_SERVICOS = 32 MACROFERTIL_SERVICOS = 33 CONCILIACAO_FISCAL_BPM_SERVICOS = 34 ECF = 35 CONCILIACAO_ECF_FCONT = 37 AUDITORIA_DIARIA = 38 CONCILIACAO_AUDITOR_RECEIVER = 39 CONCILIACAO_ECF_DCTF = 40 CONCILIACAO_ECF_SPEDFISCAL = 41 CONCILIACAO_ECF_EFDCONTRIB = 42 CONCILIACAO_ECF_ECD = 43 CONCILIACAO_ECF_DIRF = 44 AUDITORIA_DIARIA_SERVICOS = 45 CONCILIACAO_BLOCO_K_BLOCO_H = 46 SINTEGRA = 47 CONCILIACAO_SPEDFISCAL_CONTABIL = 48 CONCILIACAO_SPEDFISCAL_MASTERCONNECT = 49 XML = 50 EFD_REINF = 51 INVALIDA = 99

CadastraEmpresa

Método responsável por cadastrar uma empresa.

Requisição “CadastraEmpresaRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
CodEmpresa	String	Código da empresa
CNPJ	String	CNPJ da empresa
RazaoSocial	String	Razão social da empresa
InscEstadual	String	Inscrição estadual da empresa
Email	String	E-mail responsável

Resposta “CadastraEmpresaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

CadastraEstabelecimento

Método responsável por cadastrar um estabelecimento.

Requisição “CadastraEstabelecimentoRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
CodEmpresaBase	String	Código da empresa base
CodEstabBase	String	Código do estabelecimento base
CodEmpresa	String	Código da empresa
CodEstabIntegra	String	Código do estabelecimento
CNPJ	String	CNPJ
RazaoSocial	String	Razão social
InscEstadual	String	Inscrição estadual
InsMunicipal	String	Inscrição municipal
CnpjMatriz	String	CNPJ da matriz
Logradouro	String	Logradouro
Numero	String	Número
Complemento	String	Complemento
Bairro	String	Bairro
UF	String	UF
Municipio	String	Município
CEP	String	CEP
Telefone	String	Telefone
Fax	String	Fax
Email	String	E-mail

Resposta “CadastraEstabelecimentoResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

ConsultaChavesByDataEmissao

Método responsável por consultar as chaves dos documentos de acordo com a data de emissão.

Requisição “ConsultaChavesByDataEmissaoRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
CnpjEmpresaReceiver	String	CNPJ da empresa
DataReferenciaInicial	DateTime	Data inicial
DataReferenciaFinal	DateTime	Data final
CodTipoDocumento	Int	Tipo do documento: NFe = 1 CTe = 2 NFSe = 3 NFCe = 4 CTeOs = 5 CancelNFe = 10 CancelCTe = 11 EventoNFe = 20 EventoCTeOuCTeOS = 21 InutilizacaoNfe = 30 InutilizacaoCte = 31 Indefinido = 99

Resposta “ConsultaChavesByDataEmissaoResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
ChavesEncontradas	String[]	Chaves encontradas

ConsultaDocInconsist

Método responsável por consultar os documentos com inconsistência.

Requisição “ConsultaDocInconsistRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
DataInicio	DateTime	Data inicial
DataFim	DateTime	Data final
CodEmitenteIni	String	Código emitente inicial
CodEmitenteFim	String	Código emitente final
CNPJEstab	String	CNPJ estabelecimento
NumDocumento	Decimal	Número do documento
CodItem	String	Código do item
FluxoDocumento	String	Fluxo do documento
TipInfo	String	Tipo informação: Analítica = “A” Sintética = “”
Reprocessar	Int	Reprocessar: Sim = 1 Não = 2

Resposta “ConsultaDocInconsistResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DocInconsist	DocInconsist[]	Documentos com inconsistência
ResumoInconsist	ResumoInconsist	Resumo das inconsistências
DocInconsist
Campo	Tipo	Descrição
CodEstabelecimento	Decimal	Código do estabelecimento
ChaveDocumento	String	Chave do documento
CnpjEmitente	String	CNPJ do emitente
RazaoSocialEmitente	String	Razão social do emitente
CodTipoDocumento	Int	Tipo do documento: NFe = 1 CTe = 2 NFSe = 3 NFCe = 4 CTeOs = 5 CancelNFe = 10 CancelCTe = 11 EventoNFe = 20 EventoCTeOuCTeOS = 21 InutilizacaoNfe = 30 InutilizacaoCte = 31 Indefinido = 99
NumeroDocumento	Decimal	Número do documento
SerieDocumento	String	Série do documento
DataEmissãoDocumento	DateTime	Data emissão do documento
CodProduto	String	Código do produto
DesProduto	String	Descrição do produto
CodItemInterno	String	Código interna do item
DesItemInterno	String	Descrição interna do item
MsgInconsist	String	Mensagem inconsistência
CodInconsist	String	Código inconsistência
FlgAtivo	String	Ativo
FluxoDocumento	String	Fluxo do documento: Ambos = 1 Entrada = 2 Saida = 3
NfeProdutoIcons	NfeProdutoIncons	Produto com inconsistência
NfeProdutoIncons
Campo	Tipo	Descrição
CodEmpresa	Decimal	Código da empresa
CodEstabelecimento	Decimal	Código do estabelecimento
SeqDocumento	Decimal	Sequência do documento
SeqProduto	Decimal	Sequência do produto
CodProduto	String	Código do produto
NroEan	String	Número EAN
DesProduto	String	Descrição do produto
CodNcm	String	Código NCM
ExTipi	String	Ex IPI
CodFop	String	Código FOP
CodFopEntrada	String	Código FOP entrada
UndComercial	String	Unidade comercial
QtdComercial	Decimal	Quantidade comercial
VlrUnitComercial	Decimal	Valor unitário comercial
VlrTotalBruto	Decimal	Valor total bruto
NroEanTrib	String	Número EAN tributado
UndTributavel	String	Unidade tributável
QtdTributavel	Decimal	Quantidade tributável
VlrUnitTributacao	Decimal	Valor unitário tributação
VlrFreteTotal	Decimal	Valor total do frete
VlrSeguroTotal	Decimal	Valor total do seguro
VlrDesconto	Decimal	Valor do desconto
VlrOutrasDespesas	Decimal	Valor das outras despesas
FlgValorItem	Decimal	Valor do item
NroPedido	String	Número do pedido
NroItemPedido	String	Número do item do pedido
NroContaContabil	String	Número da conta contábil
NroFci	String	Número do FCI
NroRecopi	String	Número RECOPI
CodGrupoIcms	String	Código grupo ICMS
OrgMercadoriaIcms	Unit	Origem mercadoria
NroCst	Unit	Número do CST
CodModDetermIcms	Unit	Código modelo determinação ICMS
VlrBcIcms	Decimal	Valor base de cálculo ICMS
PctIcms	Decimal	Percentual ICMS
VlrIcms	Decimal	Valor ICMS
VlrIcmsDeson	Decimal	Valor ICMS desonerado
MotDesIcms	Decimal	Motivo desoneração ICMS
VlrIcmsOp	Decimal	Valor ICMS op
VlrIcmsDif	Decimal	Valor ICMS dif
PDifIcms	Decimal	??
CodModDetBc	Decimal	??
PctMargemAdic	Decimal	Percentual base adicional
PctReducaoBc	Decimal	Percentual redução base de cálculo
PctReducaoBcSt	Decimal	Percentual redução base de cálculo
VlrBcStIcms	Decimal	Valor base de cálculo ICMS ST
PctIcmsSt	Decimal	Percentual ICMS ST
VlrIcmsSt	Decimal	Valor ICMS ST
CodModDesonIcms	Unit	Código modelo desoneração ICMS
VlrBcStRetido	Decimal	Valor base de cálculo ICMS retido
PctBcPropria	Decimal	Percentual base de cálculo própria
SigUfIcms	String	UF
VlrIcmsBcStDestino	Decimal	Valor base de cálculo ICMS ST destino
SigUfIcmsDest	String	UF destino
VlrIcmsDest	Decimal	Valor ICMS destino
CodSituacaoOpe	Unit	Código situação operação
PctCreditoSimpNac	Decimal	Percentual de crédito simples nacional
VlrCreditoSimpNac	Decimal	Valor crédito simples nacional
ClasseEnquadramentoIpi	String	Classe enquadramento IPI
NroCnpjIpiProd	String	Número CNPJ IPI produtor
CodSelo	String	Código do selo
QtdSelo	Decimal	Quantidade selo
CodEnquadramento	String	Código enquadramento
CodSituacaoIpi	String	Código situação IPI
VlrBcIpi	Decimal	Valor base de cálculo IPI
PcpIpi	Decimal	Percentual IPI
QtdTotUndTribIpi	Decimal	Quantidade total unidade tributada IPI
VlrUndTribIpi	Decimal	Valor unidade tributada IPI
VlrIpi	Decimal	Valor IPI
CodSituacaoTribIpi	String	Código situação tributária IPI
VlrBcIi	Decimal	Valor base de cálculo II
VlrDespAduan	Decimal	Valor despesa aduaneira
VlrIi	Decimal	Valor II
VlrOf	Decimal	Valor OF
CstPis	Unit	CST PIS
CstPisAliq	Unit	CST PIS alíquota
CstPisQtde	Unit	CST PIS quantidade
CstPisNt	Unit	CST PIS não tributado
CstPisOutr	Unit	CST PIS outros
VlrBcPis	Decimal	Valor base de cálculo PIS
VlrBcPisAliq	Decimal	Valor base de cálculo PIS alíquota
PctPis	Decimal	Percentual PIS
PctPisQtde	Decimal	Percentual PIS quantidade
PctPisOutr	Decimal	Percentual PIS outros
PctPisAliqOutr	Decimal	Percentual PIS alíquota
VlrPis	Decimal	Valor PIS
VlrPisQtde	Decimal	Valor PIS quantidade
VlrPisOutr	Decimal	Valor PIS outros
QtdVendidaPis	Decimal	Quantidade vendida PIS
QtdVendidaPisOutr	Decimal	Quantidade vendida PIS outros
VlrIpiDevol	Decimal	Valor IPI devolução
PIpiDevol	Decimal	Percentual IPI devolução
VlrBcPisSt	Decimal	Base de cálculo PIS ST
PctPisSt	Decimal	Percentual PIS ST
QtdVendidaPisSt	Decimal	Quantidade vendida PIS ST
VlrPctPisSt	Decimal	Valor percentual PIS ST
VlrPisSt	Decimal	Valor PIS ST
CstCofins	Unit	CST COFINS
CstCofinsAliq	Unit	CST COFINS alíquota
CstCofinsQtde	Unit	CST COFINS quantidade
CstCofinsNt	Unit	CST COFINS não tributado
VlrBcCofins	Decimal	Base de cálculo COFINS
VlrBcCofinsAliq	Decimal	Base de cálculo COFINS alíquota
PctCofins	Decimal	Percentual COFINS
PctCofinsAliq	Decimal	Percentual COFINS alíquota
VlrCofins	Decimal	Valor COFINS
VlrCofinsAliq	Decimal	Valor COFINS alíquota
VlrCofinsQtde	Decimal	Valor COFINS quantidade
QtdVendidaCofins	Decimal	Quantidade vendida COFINS
QtdVendidaCofinsQtde	Decimal	Quantidade vendida COFINS quantidade
VlrAliqCofins	Decimal	Valor alíquota COFINS
VlrAliqCofinsQtde	Decimal	Valor alíquota COFINS quantidade
VlrBcCofinsSt	Decimal	Base de cálculo COFINS ST
PctCofinsSt	Decimal	Percentual COFINS ST
QtdVendidaCofinsSt	Decimal	Quantidade vendida COFINS ST
VlrPctCofinsSt	Decimal	Percentual COFINS ST
VlrCofinsSt	Decimal	Valor COFINS ST
VlrBcIssqn	Decimal	Base de cálculo ISSQN
PcIssqn	Decimal	Percentual ISSQN
VlrIssqn	Decimal	Valor ISSQN
CodMunicipIssqn	Decimal	Código município ISSQN
CodItemLista	Decimal	Código item lista
CodItemListaString	String	Código item lista
CstIssqn	String	CST ISSQN
InfAdicProduto	String	Informação adicional produto
Evento	Int	Evento
Parcela	Int	Parcela
EncerraParcela	Int	Encerra parcela
NroOrdemProd	Int	Número ordem do produto
NroDeposito	String	Número do depósito
CodItemInterno	String	Código interno do item
DesItemInterno	String	Descrição interna do item
VlrFatorConversao	Decimal	Fator de conversão
NumCasasDecimais	Int	Número casas decimais
CodUnidMedida	String	Código unidade de medida
CodFamiliaItem	String	Código família do item
ResumoInconsist
Campo	Tipo	Descrição
NroTotalItens	Int	Número total de itens
NroItensErro	Int	Número de itens com erro
ValTotalItens	Decimal	Valor total dos itens
ValItensErro	Decimal	Valor total dos itens com erro
ValIpiCreditado	Decimal	Valor IPI creditado
ValIpiCorreto	Decimal	Valor IPI correto

ConsultaDocSefaz

Método responsável por consultar documentos de acordo com a data de emissão e CNPJ.

Requisição “ConsultaDocSefazRequest”

Campo	Tipo	Descrição
Token	String	Token de autenticação
DataInicio	DateTime	Data inicial
DataFim	DateTime	Data final
CodEmitenteIni	String	Código emitente inicial
CodEmitenteFim	String	Código emitente final
CNPJCliente	String	CNPJ do cliente

Resposta “ConsultaDocSefazResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DocSefaz	DocSefaz[]	Documentos com inconsistência
DocSefaz
Campo	Tipo	Descrição
CodEstabelecimento	Decimal	Código do estabelecimento
CnpjFornecedorMascara	String	CNPJ do fornecedor
RazaoSocialFornecedor	String	Razão social do fornecedor
Tipo	Int	Tipo
NumDocumento	Decimal	Número do documento
Serie	String	Série do documento
DataEmissao	DateTime	Data de emissão do documento
ValorTotalNota	Decimal	Valor total da nota
CodChaveAcesso	String	Chave de acesso
ExisteSefaz	Int	Existe no SEFAZ: Não = 0 Sim = 1
ExisteXML	Int	Existe XML: Não = 0 Sim = 1
ExistePortaria	Int	Existe portaria: Não = 0 Sim = 1
ExisteERP	Int	Existe no ERP: Não = 0 Sim = 1
SituacaoManifestacao	Int	Situação da manifestação: SEM_MANIFESTACAO = 0, CONFIRMACAO_OPERACAO = 1, CIENCIA_OPERACAO = 2, DESCONHECIMENTO_OPERACAO = 3, OPERACAO_NAO_REALIZADA = 4, CTE_PRESTACAO_SERVICO_DESACORDO = 5

GeraTokenGovCadastrosOnDatabase

Método responsável por gerar o “Token de Acesso” para o método ConsultaGovCadastrosOnDatabase.

Requisição “GeraTokenGovCadastrosRequest”

Campo	Tipo	Descrição
Usuario	String	Usuário para autenticação
Senha	String	Senha do usuário
CnpjConsultante	String	CNPJ do consultante
ChaveLicenca	String	Chave da licença

Resposta “GeraTokenGovCadastrosOnDatabaseResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
Token	String	Token de acesso

ConsultaGovCadastrosOnDatabase

Método responsável por consultar os cadastros governamentais no banco de dados.

Requisição “ConsultaGovCadastrosRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso gerado pelo método 3.12.GeraTokenGovCadastrosOnDatabase
NroDiasValidConsulta	Int	Número de dias validade consulta
IndConsulta	Int	Indicador consulta: RECEITA_FEDERAL_CPF = 1 RECEITA_FEDERAL_CNPJ = 2 SIMPLES_NACIONAL = 3 SINTEGRA = 4 SUFRAMA = 5 TODOS = 6
Cgc	String	CGC
DtNascimento	DateTime	Data de nascimento
InscrEstadual	String	Inscrição estadual
SiglaUf	String	UF
IndTodosEstados	Int	Indicador todos os estados: Não = 0 Sim = 1
InscrSuframa	String	Inscrição Suframa

Resposta “ConsultaGovCadastrosResponse[]”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DatConsulta	DateTime	Data da consulta
ArqRecibo	Byte[]	Arquivo de recibo
Consulta	Consulta	Consulta
ReceitaFeeral	ReceitaFederal	Receita Federal
SimplesNacional	SimplesNacional	Simples Nacional
Sintegra	Sintegra	Sintegra
Suframa	Suframa	Suframa
ConsultaGeral	ConsultaGeral	Consulta geral
Consulta
Campo	Tipo	Descrição
IndConsulta	Int	Indicador consulta: RECEITA_FEDERAL_CPF = 1 RECEITA_FEDERAL_CNPJ = 2 SIMPLES_NACIONAL = 3 SINTEGRA = 4 SUFRAMA = 5 TODOS = 6
Cgc	String	CGC
DtNascimento	DateTime	Data de nascimento
InscrEstadual	String	Inscrição estadual
InscrSuframa	String	Inscrição suframa
Uf	String	UF
IndTodosEstado	Int	Indicador todos os estados: Não = 0 Sim = 1
ReceitaFederal
Campo	Tipo	Descrição
IdReceiaFederal	Int	Indicador da Receita Federal
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscricao	Int	Indicador da inscrição: CPF = 1 CNPJ = 2
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
DtNascimento	DateTime	Data de nascimento
DataAbertura	DateTime	Data de abertura
InscrEstadual	String	Inscrição estadual
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSegundaria	String	Código descritivo da atividade secundária
CodDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Municipio	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
SitEspecial	String	Situação especial
DtSitEspecial	String	Data situação especial
FlgCadastro	String	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
SimplesNacional
Campo	Tipo	Descrição
IdSimplesNacional	Int	Indicador do Simples Nacional
IdConsultaCadastral	Int	Indicador da consulta cadastral
Cnpj	String	CNPJ
RazaoSocial	String	Razão social
SitSimples	String	Situação
SitSimei	String	Situação Simei
SitSimplesAnterior	String	Situação simples anterior
SitSimeiAnterior	String	Situação Simei anterior
FlgCadastro	String	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
Sintegra
Campo	Tipo	Descrição
IdSintegra	Int	Indicador do Sintegra
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscrição	Int	Indicador da inscrição: CPF = 1 CNPJ = 2
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
DataAbertura	DateTime	Data abertura
InscrEstadual	String	Inscrição estadual
CodDescrAtivEconomica	String	Código descritivo da atividade econômica
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSecundaria	String	Código descritivo da atividade secundária
CidDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Município	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
RegimeApuracao	String	Regime de apuração
RegimeFiscal	String	Regime fiscal
IndObrigNfe	Int	Indicador de obrigatoriedade Nfe
DtInscricao	DateTime	Data de inscrição
DtIniFuncionamento	DateTime	Data de início de funcionamento
DtiniEstabelecimento	DateTime	Data de início do estabelecimento
DtUltimaAtualizacao	DateTime	Data última atualização
FlgCadastro	Int	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
Suframa
Campo	Tipo	Descrição
IdSuframa	Int	Indicador do Suframa
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscrição	Int	Indicador da inscrição: CPF = 1 CNPJ = 2
Cgc	String	CGC
Nome	String	Nome
InscrSuframa	String	Inscrição Suframa
CodDescrAtivEconomica	String	Código descritivo da atividade econômica
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSecundaria	String	Código descritivo da atividade secundária
Uf	String	UF
Município	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
FlgCadastro	Int	Cadastro: Suspenso = 0 Ativo = 1
DescrSitCadastro	String	Descrição situação cadastro
ConsultaGeral
Campo	Tipo	Descrição
CodEmpresa	String	Código empresa
IndInscricao	Int	Indicador da inscrição: CPF = 1 CNPJ = 2
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
InscrEstadual	String	Inscrição estadual
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSegundaria	String	Código descritivo da atividade secundária
CodDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Municipio	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
IdRf	String	Indicador da Receita Federal
IdConsultRf	String	Indicador da consulta cadastral RF
DatConsultRf	String	Data consulta RF
StatusConsultRf	DateTime	Status consulta RF
RetornoConsultRf	String	Retorno consulta RF
DtNascimentoRf	String	Data de nascimento RF
DataAberturaRf	DateTime	Data de abertura RF
SitEspecialRf	String	Situação especial RF
DtSitEspecialRf	DateTime	Data situação especial RF
FlgCadRf	String	Cadastro RF
DtSitCadRf	DateTime	Data situação cadastro RF
DescrSitCadRf	String	Descrição situação cadastro RF
IdSn	String	Indicador do Simples Nacional
IdConsultSn	String	Indicador da consulta cadastral SN
DatConsultSn	DateTime	Data consulta SN
StatusConsultSn	String	Status consulta SN
RetornoConsultSn	String	Retorno consulta SN
SitSimplesSn	String	Situação SN
SitSimeiSn	String	Situação Simei SN
SitSimplesAnteriorSn	String	Situação anterior SN
SitSimeiAnteriorSn	String	Situação Simei anterior SN
FlgCadSn	String	Cadastro SN
DtSitCadSn	DateTime	Data situação cadastro SN
DescrSitCadSn	String	Descrição situação cadastro SN
IdSin	String	Indicador do Sintegra
IdConsultSin	String	Indicador consulta SIN
DatConsultSin	DateTime	Data consulta SIN
StatusConsultSin	String	Status consulta SIN
RetornoConsultSin	String	Retorno consulta SIN
DataAberturaSin	DateTime	Data abertura SIN
RegimeApuracaoSin	String	Regime apuração SIN
RegimeFiscalSin	String	Regime fiscal SIN
IndObrigNfeSin	String	Indicador obrigação Nfe SIN
DtObrigNfeSin	DateTime	Data obrigação Nfe SIN
IndObrigEfdSin	String	Indicador obrigação EFD SIN
DtInscricaoSin	DateTime	Data inscrição SIN
DtIniFuncionamentoSin	DateTime	Data início funcionamento SIN
DtIniEstabelecimentoSin	DateTime	Data início estabelecimento SIN
DtUltimaAtualizacaoSin	DateTime	Data última atualização SIN
FlgCadSin	String	Cadastro SIN
DtSitCadSin	DateTime	Data situação cadastro SIN
DescrSitCadSin	String	Descrição situação cadastro SIN
IdSuf	String	Indicador do Suframa
IdConsultSuf	String	Indicador consulta SUF
DatConsultSuf	DateTime	Data consulta SUF
StatusConsultSuf	String	Status consulta SUF
RetornoConsultSuf	String	Retorno consulta SUF
InscrSuf	String	Inscrição SUF
FlgCadSuf	String	Cadastro SUF
DescrSitCadSuf	String	Descrição situação cadastro SUF

GeraTokenGovCadastrosOnSatelite

Método responsável por gerar o “Token de Acesso” para o método ConsultaGovCadastrosOnSatelite.

Requisição “GeraTokenGovCadastrosRequest”

Campo	Tipo	Descrição
Usuario	String	Usuário para autenticação
Senha	String	Senha do usuário
CnpjConsultante	String	CNPJ do consultante
ChaveLicenca	String	Chave da licença

Resposta “GeraTokenGovCadastrosOnSateliteResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
Token	String	Token de acesso

GeraTokenGovCadastrosOnSatelite

Método responsável por consultar os cadastros governamentais no “satélite”.

Requisição “ConsultaGovCadastrosRequestRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso gerado pelo método 3.14.GeraTokenGovCadastrosOnSatelite
NroDiasValidConsulta	Int	Número de dias validade consulta
IndConsulta	Int	Indicador consulta
Cgc	String	CGC
DtNascimento	DateTime	Data de nascimento
InscrEstadual	String	Inscrição estadual
SiglaUf	String	UF
IndTodosEstados	Int	Indicador todos os estados
InscrSuframa	String	Inscrição Suframa

Resposta “ConsultaGovCadastrosResponse[]”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DatConsulta	DateTime	Data da consulta
ArqRecibo	Byte[]	Arquivo de recibo
Consulta	Consulta	Consulta
ReceitaFeeral	ReceitaFederal	Receita Federal
SimplesNacional	SimplesNacional	Simples Nacional
Sintegra	Sintegra	Sintegra
Suframa	Suframa	Suframa
ConsultaGeral	ConsultaGeral	Consulta geral
Consulta
Campo	Tipo	Descrição
IndConsulta	Int	Indicador da consulta
Cgc	String	CGC
DtNascimento	DateTime	Data de nascimento
InscrEstadual	String	Inscrição estadual
InscrSuframa	String	Inscrição suframa
Uf	String	UF
IndTodosEstado	Int	Indicador de todos os UF’s
ReceitaFederal
Campo	Tipo	Descrição
IdReceiaFederal	Int	Indicador da Receita Federal
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscricao	Int	Indicador da inscrição
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
DtNascimento	DateTime	Data de nascimento
DataAbertura	DateTime	Data de abertura
InscrEstadual	String	Inscrição estadual
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSegundaria	String	Código descritivo da atividade secundária
CodDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Municipio	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
SitEspecial	String	Situação especial
DtSitEspecial	String	Data situação especial
FlgCadastro	String	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
SimplesNacional
Campo	Tipo	Descrição
IdSimplesNacional	Int	Indicador do Simples Nacional
IdConsultaCadastral	Int	Indicador da consulta cadastral
Cnpj	String	CNPJ
RazaoSocial	String	Razão social
SitSimples	String	Situação
SitSimei	String	Situação Simei
SitSimplesAnterior	String	Situação simples anterior
SitSimeiAnterior	String	Situação Simei anterior
FlgCadastro	String	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
Sintegra
Campo	Tipo	Descrição
IdSintegra	Int	Indicador do Sintegra
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscrição	Int	Indicador da inscrição
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
DataAbertura	DateTime	Data abertura
InscrEstadual	String	Inscrição estadual
CodDescrAtivEconomica	String	Código descritivo da atividade econômica
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSecundaria	String	Código descritivo da atividade secundária
CidDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Município	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
RegimeApuracao	String	Regime de apuração
RegimeFiscal	String	Regime fiscal
IndObrigNfe	Int	Indicador de obrigatoriedade Nfe
DtInscricao	DateTime	Data de inscrição
DtIniFuncionamento	DateTime	Data de início de funcionamento
DtiniEstabelecimento	DateTime	Data de início do estabelecimento
DtUltimaAtualizacao	DateTime	Data última atualização
FlgCadastro	Int	Cadastro: Suspenso = 0 Ativo = 1
DtSitCadastro	DateTime	Data situação cadastro
DescrSitCadastro	String	Descrição situação cadastro
Suframa
Campo	Tipo	Descrição
IdSuframa	Int	Indicador do Suframa
IdConsultaCadastral	Int	Indicador da consulta cadastral
IndInscrição	Int	Indicador da inscrição
Cgc	String	CGC
Nome	String	Nome
InscrSuframa	String	Inscrição Suframa
CodDescrAtivEconomica	String	Código descritivo da atividade econômica
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSecundaria	String	Código descritivo da atividade secundária
Uf	String	UF
Município	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
FlgCadastro	Int	Cadastro: Suspenso = 0 Ativo = 1
DescrSitCadastro	String	Descrição situação cadastro
ConsultaGeral
Campo	Tipo	Descrição
CodEmpresa	String	Código empresa
IndInscricao	Int	Indicador da inscrição
Cgc	String	CGC
Nome	String	Nome
NomeFantasia	String	Nome fantasia
InscrEstadual	String	Inscrição estadual
CodDescrAtivPrincipal	String	Código descritivo da atividade principal
CodDescrAtivSegundaria	String	Código descritivo da atividade secundária
CodDescrNatJuridica	String	Código descritivo da natureza jurídica
Uf	String	UF
Municipio	String	Município
Bairro	String	Bairro
Cep	String	CEP
Logradouro	String	Logradouro
TipoLogradouro	String	Tipo logradouro
LogradouroSemTipo	String	Logradouro sem tipo
Numero	String	Número
Complemento	String	Complemento
Email	String	E-mail
Telefone	String	Telefone
IdRf	String	Indicador da Receita Federal
IdConsultRf	String	Indicador da consulta cadastral RF
DatConsultRf	String	Data consulta RF
StatusConsultRf	DateTime	Status consulta RF
RetornoConsultRf	String	Retorno consulta RF
DtNascimentoRf	String	Data de nascimento RF
DataAberturaRf	DateTime	Data de abertura RF
SitEspecialRf	String	Situação especial RF
DtSitEspecialRf	DateTime	Data situação especial RF
FlgCadRf	String	Cadastro RF
DtSitCadRf	DateTime	Data situação cadastro RF
DescrSitCadRf	String	Descrição situação cadastro RF
IdSn	String	Indicador do Simples Nacional
IdConsultSn	String	Indicador da consulta cadastral SN
DatConsultSn	DateTime	Data consulta SN
StatusConsultSn	String	Status consulta SN
RetornoConsultSn	String	Retorno consulta SN
SitSimplesSn	String	Situação SN
SitSimeiSn	String	Situação Simei SN
SitSimplesAnteriorSn	String	Situação anterior SN
SitSimeiAnteriorSn	String	Situação Simei anterior SN
FlgCadSn	String	Cadastro SN
DtSitCadSn	DateTime	Data situação cadastro SN
DescrSitCadSn	String	Descrição situação cadastro SN
IdSin	String	Indicador do Sintegra
IdConsultSin	String	Indicador consulta SIN
DatConsultSin	DateTime	Data consulta SIN
StatusConsultSin	String	Status consulta SIN
RetornoConsultSin	String	Retorno consulta SIN
DataAberturaSin	DateTime	Data abertura SIN
RegimeApuracaoSin	String	Regime apuração SIN
RegimeFiscalSin	String	Regime fiscal SIN
IndObrigNfeSin	String	Indicador obrigação Nfe SIN
DtObrigNfeSin	DateTime	Data obrigação Nfe SIN
IndObrigEfdSin	String	Indicador obrigação EFD SIN
DtInscricaoSin	DateTime	Data inscrição SIN
DtIniFuncionamentoSin	DateTime	Data início funcionamento SIN
DtIniEstabelecimentoSin	DateTime	Data início estabelecimento SIN
DtUltimaAtualizacaoSin	DateTime	Data última atualização SIN
FlgCadSin	String	Cadastro SIN
DtSitCadSin	DateTime	Data situação cadastro SIN
DescrSitCadSin	String	Descrição situação cadastro SIN
IdSuf	String	Indicador do Suframa
IdConsultSuf	String	Indicador consulta SUF
DatConsultSuf	DateTime	Data consulta SUF
StatusConsultSuf	String	Status consulta SUF
RetornoConsultSuf	String	Retorno consulta SUF
InscrSuf	String	Inscrição SUF
FlgCadSuf	String	Cadastro SUF
DescrSitCadSuf	String	Descrição situação cadastro SUF

ConsultaItemSemDePara

Método responsável por consultar os itens sem “De Para” de acordo com o CNPJ.

Requisição “ConsultaItemSemDeParaRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
CNPJEmpresa	String	CNPJ empresa

Resposta “ConsultaItemSemDeParaResponse[]”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
ItemSemDePara	ItemSemDePara[]	Data da consulta
ItemSemDePara
Campo	Tipo	Descrição
CodEmpresa	Decimal	Código da empresa
CodFornecedor	String	Código do fornecedor
CodItemFornec	String	Código do item do fornecedor
CodUnidMedidaFornec	String	Código da UN do fornecedor
CodItemInterno	String	Código do item internamente
DesItemInterno	String	Descrição do item internamente
CodUnidMedida	String	Código da UN
TipoItem	String	Tipo do item: MERCADORIA_PARA_REVENDA = 00 MATERIA_PRIMA = 01 EMBALAGEM = 02 PRODUTO_EM_PROCESSO = 03 PRODUTO_ACABADO = 04 SUBPRODUTO = 05 PRODUTO_INTERMEDIARIO = 06 MATERIAL_DE_USO_E_CONSUMO = 07 ATIVO_IMOBILIZADO = 08 SERVICOS = 09 OUTROS_INSUMOS = 10 OUTRAS = 99 INVALIDO = 999

ControleFTS

Método responsável pelo armazenamento de dados de comunicação entre Midas e SFE.

Requisição “ControleFTSRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
ControleFTSVO	ControleFTSVO	Controle FTS
ControleFTSVO
Campo	Tipo	Descrição
SeqControleFTS	Decimal	Identificador de controle FTS
NumPedido	Int	Número do pedido
DataEnvio	DateTime	Data do envio
DataRecebimento	DateTime	Data do recebimento
CnpjEmpresa	String	CNPJ da empresa
CnpjEstabelecimento	String	CNPJ do estabelecimento
StatusIntegracao	String	Status da integração
Contratado	String	Contratado
TipoProcessamento	String	Tipo de processamento: Automático = “A” Manual = “M”
Remetente	String	E-mail do remetente
Assunto	String	Assunto do e-mail
Arquivo	String	Nome do arquivo
Extensao	String	Extensão do arquivo
ArquivoBin	Byte[]	Arquivo em bytes
Link	String	Link
DataEmail	DateTime	Data do e-mail
hashMailID	String	Hash do email
CodeFile	String	MD5 do arquivo
Documento	String	Documento FTS
Prestador	String	CNPJ do prestador
RazaoSocialPrestador	String	Razão social do prestador
MunicipioPrestador	String	Município do prestador
UFPrestador	String	UF
DataOcorIni	DateTime	Data ocorrência inicial
DataOcorFim	DateTime	Data ocorrência final
StatusOcorrencia	String	Status da ocorrência: Aguardando = 1 Sucesso = 2 Invalido = 3 Duplicado = 4 RemBloq = 5 EstabInvalido = 6 TimeOut = 7
MensagemOcorrencia	String	Mensagem da ocorrência
FlgWebservice	Int	Enviado webservice
UsuarioFTS	String	Usuário FTS
CnpjEmpresaReceiver	String	CNPJ empresa receiver
RazaoSocialEmpresaReceiver	String	Razão social empresa receiver

Resposta “ControleFTSResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

DeleteDocSync

Método responsável por deleção de documentos.

Requisição “DocSyncRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
Docs	DocSync[]	Documentos
DocSync
Campo	Tipo	Descrição
File	FileObject	Arquivo
CnpjEmpresa	String	CNPJ da empresa
CgcEstab	String	CGC do estabelecimento
ChaveDocumento	String	Chave do documento
CnpjEmpresaExclusao	String	CNPJ da empresa exclusão
LoginExclusao	String	Login exclusão
SituacaoDocumento	String	Situação documento

Resposta “DocSyncResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

DocSync

Método responsável por processamento de documentos.

Requisição “DocSyncRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
Docs	DocSync[]	Documentos
DocSync
Campo	Tipo	Descrição
File	FileObject	Arquivo
CnpjEmpresa	String	CNPJ da empresa
CgcEstab	String	CGC do estabelecimento
ChaveDocumento	String	Chave do documento
CnpjEmpresaExclusao	String	CNPJ da empresa exclusão
LoginExclusao	String	Login exclusão
SituacaoDocumento	String	Situação documento
FileObject
Campo	Tipo	Descrição
FileBytes	Byte[]	Arquivo em bytes
FileType	String	Tipo do arquivo
FileExtension	String	Extensão do arquivo
FileName	String	Nome do arquivo

Resposta “DocSyncResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

DocSyncLight

Método responsável por processar arquivo.

Requisição “DocSyncLightRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
File	FileObject	Documentos
FileObject
Campo	Tipo	Descrição
FileBytes	Byte[]	Arquivo em bytes
FileType	String	Tipo do arquivo
FileExtension	String	Extensão do arquivo
FileName	String	Nome do arquivo

Resposta “DocSyncLightResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

EmitSync

Método responsável por atualizar informações de tradução do emitente.

Requisição “EmitSyncRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
EmitenteTrad	EmitenteTraducaoWS[]	Emitentes
Delete	Boolean	Deletar
EmitenteTraducaoWS
Campo	Tipo	Descrição
CnpjEmpresa	String	CNPJ da empresa
NroCNPJ	String	Número CNPJ
Sequencia	String	Sequência
CodEmitente	String	Código do emitente
NomeEmitente	String	Nome do emitente
NroIe	String	Inscrição estadual
FlgSincronizado	String	Sincronizado

Resposta “EmitSyncResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

ProcessaContagemExterna

Método responsável por verificar a contagem de itens do documento.

Requisição “ProcessaContagemExternaRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
CodEmpresa	String	Código da empresa
CodEstabelecimento	String	Código do estabelecimento
ChvNf	String	Chave do documento
CodNf	String	Código do documento
CodFornec	String	Código do fornecedor
NfAno	Int	Ano do documento
NfDataEmissao	DateTime	Data de emissão do documento
NfEntrada	String	Entrada
Det	Item[]	Itens
Item
Campo	Tipo	Descrição
OrdemCompra	String	Ordem de compra
NfItemSequencia	Int	Sequencia do item no documento
NfItemCodigo	String	Código do item no documento
QuantItemContagem	Decimal	Quantidade do item contagem
Serie	String	Serie
Lote	Lote[]	Lote
IndSituacao	Int	Indicador da situação: PENDENTECONTAGEM = 1 NAONECESSITACONTAGEM = 2 PENDENTECONTAGEMEXTERNA = 3 CONTAGEMREALIZADA = 4
xMensagem	String[]	Mensagens
Lote
Campo	Tipo	Descrição
NroSerieLote	String	Número de série do lote
QtdLote	Decimal	Quantidade do lote
DatValidadeLote	DateTime	Data de validade do lote
NroDeposito	String	Número do depósito
CodLocalizacao	String	Código de localização

Resposta “ProcessaContagemExternaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro

ReceiveDocEventLote

Método responsável por processar lote de eventos de documentos.

Requisição “ReceiveDocEventLoteRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
RecEvento	RecEventRequest[]	Eventos
RecEventRequest
Campo	Tipo	Descrição
User	String	Usuário
Ide	Ide	Identificação
Event	Event	Evento
Ide
Campo	Tipo	Descrição
Serie	String	Série do documento
Nnfe	String	Número do documento
CGC	String	CGC do emitente
DoctoType	Int	Tipo do documento: NFe = 1 CTe = 2
ChaveDocumento	String	Chave do documento
CodEmpresa	String	Código da empresa
CodEstIntegracao	String	Código do estabelecimento
Event
Campo	Tipo	Descrição
DateEv	DateTime	Data do evento
Msg	String	Descrição do evento
EventType	Int	Tipo do evento: Information = 1 Warning = 2 Error = 3
AllowModifyType	Int	Permite modificação após evento: Sim = 1 Não = 2
RecSituation	Int	Situação do recebimento: Digitado = 1 Confirmado = 2 Recebido = 3 Alerta Integração = 4 Atualizado no ERP = 5
DataTransacao	String	Data da transação
IntegracaoAutomatica	Int	Integração automática (Não utilizado)

Resposta “ReceiveDocEventLoteResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
RecEventResult	RecEventRespose[]
RecEventResponse
Campo	Tipo	Descrição
DoctIde	Ide	Identificação
Ide
Campo	Tipo	Descrição
Serie	String	Série do documento
Nnfe	String	Número do documento
CGC	String	CGC do emitente
DoctoType	Int	Tipo do documento: NFe = 1 CTe = 2
ChaveDocumento	String	Chave do documento
CodEmpresa	String	Código da empresa
CodEstIntegracao	String	Código do estabelecimento

ReceiveDocEvento

Método responsável por processar um evento de documento em formato XML (NFe ou CTe). No item Exemplos – Tipo de Retorno deste documento detalhamos o formato do XML de Evento.

Requisição “ReceiveDocEventoRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
RecXML	String	Evento

Resposta “ReceiveDocEventLoteResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DoctoIde	Ide	Documento
Ide
Campo	Tipo	Descrição
Serie	String	Série do documento
Nnfe	String	Número do documento
CGC	String	CGC do emitente
DoctoType	Int	Tipo do documento: NFe = 1 CTe = 2
ChaveDocumento	String	Chave do documento
CodEmpresa	String	Código da empresa
CodEstIntegracao	String	Código do estabelecimento

ReceiveDocEventUnico

Método responsável por processar um evento de um documento (NFe ou CTe). Este método pode ser utilizado para desenvolvedores que não queiram antecipadamente gerar o XML de evento, e apenas desejam criar o objeto com os dados necessários para comunicação.

Requisição “RecEventRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
User	String	Usuário
Ide	Ide	Identificação
Event	Event	Evento
Ide
Campo	Tipo	Descrição
Serie	String	Série do documento
Nnfe	String	Número do documento
CGC	String	CGC do emitente
DoctoType	Int	Tipo do documento: NFe = 1 CTe = 2
ChaveDocumento	String	Chave do documento
CodEmpresa	String	Código da empresa
CodEstIntegracao	String	Código do estabelecimento
Event
Campo	Tipo	Descrição
DateEv	DateTime	Data do evento
Msg	String	Descrição do evento
EventType	Int	Tipo do evento: Information = 1 Warning = 2 Error = 3
AllowModifyType	Int	Permite modificação após evento: Sim = 1 Não = 2
RecSituation	Int	Situação do recebimento: Digitado = 1 Confirmado = 2 Recebido = 3 Alerta Integração = 4 Atualizado no ERP = 5
DataTransacao	String	Data da transação
IntegracaoAutomatica	Int	Integração automática (Não utilizado)

Resposta “RecEventResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DoctoIde	Ide	Documento
Ide
Campo	Tipo	Descrição
Serie	String	Série do documento
Nnfe	String	Número do documento
CGC	String	CGC do emitente
DoctoType	Int	Tipo do documento: NFe = 1 CTe = 2
ChaveDocumento	String	Chave do coumento
CodEmpresa	String	Código da empresa
CodEstIntegracao	String	Código do estabelecimento

RetornaDanfe

Método responsável por retornar o DANFE de determinado documento.

Requisição “RetornaDanfeRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
ChaveDocumento	String	Chave do documento

Resposta “RetornaDanfeResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
PdfDanfe	PdfDanfe
PdfDanfe
Campo	Tipo	Descrição
FileBytes	Byte[]	Arquivo em bytes
FileExtension	String	Extensão do arquivo
FileName	String	Nome do arquivo

UploadPackageSucess

Método responsável por confirmar upload do atualizador SFE.

Requisição “UploadPackageSucessRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso
PackageKey	String	Chave do pacote
UpdateStatus	Int	Status do pacote

Resposta “UploadPackageSucessResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
MessageRelease	String	Mensagem da release

VerificaPendContagem

Método responsável por retornar os documentos que possuem pendência na contagem.

Requisição “VerificaPendContagemRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso

Resposta “VerificaPendContagemResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DocumentoPendencias	DocumentoPendencia[]	Mensagem da release
DocumentoPendencia
Campo	Tipo	Descrição
CodEmpresa	String	Código da empresa
CodEstabelecimento	String	Código do estabelecimento
ChvNf	String	Chave do documento
CodNf	String	Código do documento
CodFornec	String	Código do fornecedor
NfDataEmissao	DateTime	Data de emissão
Itens	ItemDocPendencia[]	Itens do documento
ItemDocPendencia
Campo	Tipo	Descrição
OrdemCompra	String	Ordem de compra
NfItemSequencia	Int	Sequência do item
NfItemCodigo	String	Código do item
DescricaoItem	String	Descrição do item
QtdItemNota	Decimal	Quantidade do item
Lote	Lote[]	Lista de lotes
UnidMedida	String	Unidade de medida
Lote
Campo	Tipo	Descrição
NroSerieLote	String	Número de série
QtdLote	Decimal	Quantidade
DatValidadeLote	DateTime	Data de vlidade
NroDeposito	String	Número do depósito
CodLocalizacao	String	Código de localização

ConsultaObrigacoes

Método responsável por consultar as obrigações no módulo Workflow.

Requisição “ConsultaObrigacaoRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
CnpjEmpresa	String	CNPJ da empresa relacionada à obrigação
CnpjEstabelecimento	String	CNPJ do estabelecimento relacionado à obrigação
CodObrigacao	Int	Código da obrigação
AnoCompetencia	Int?	Ano de Competência da Obrigação (se houver)
MesCompetencia	Int?	Mês de Competência da Obrigação (se houver)
DataInicioVencimento	DateTime?	Filtro inicial por data de vencimento (quando não for informada a Competência)
DataFimVencimento	DateTime?	Filtro final por data de vencimento (quando não for informada a Competência)

Resposta “ConsultaObrigacaoResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
Obrigacoes	ObrigacaoResponse[]	Lista de obrigações
Obrigacoes
Campo	Tipo	Descrição
CodEmpresa	Decimal	Código da empresa
CodEstabelecimento	Decimal	Código do estabelecimento
RazaoSocialEstabelecimento	String	Razão Social do estabelecimento
CodigoObrigacao	String	Código da obrigação
DescricaoObrigacao	String	Descrição da obrigação
TipoObrigacao	String	Tipo da obrigação
ResponsavelObrigacao	String	Responsável da obrigação
IniciaEm	DateTime	Data de início da obrigação
TerminaEm	DateTime	Data de término da obrigação
DataVencimento	DateTime	Data de vencimento do evento
IdObrigacaoEvento	Int	Código do evento
SituacaoEvento	String	Situação do evento
Tarefa	String	Código da tarefa
SeqTarefa	Int	Sequência da tarefa
ResponsavelTarefa	String	Responsável da tarefa
DataPrazo	DateTime	Data prazo para conclusão da tarefa
PrazoTarefa	Int?	Dias pendentes para conclusão da tarefa
SituacaoTarefa	String	Situação da tarefa
DataConclusao	DateTime?	Data de conclusão da tarefa
PeriodoCompetencia	String	Competência da tarefa
Observação	String	Observação de encerramento da tarefa
TiposArquivos	TipoArquivoObricacao[]	Tipos de arquivos que podem ser vinculados à obrigação.
ArquivosObrigacao	ArquivoObrigacao[]	Arquivos já vinculados à obrigação
TipoArquivoObrigacao
Campo	Tipo	Descrição
CodArquivo	String	Código do arquivo
TipoArquivo	String	Tipo do arquivo
ArquivoObrigacao
Campo	Tipo	Descrição
CodArquivo	String	Código do arquivo
NomeArquivo	String	Nome do arquivo
BytesArquivo	Byte[]	Bytes do arquivo

EncerraTarefa

Método responsável por encerrar tarefas no módulo Workflow.

Requisição “EncerraTarefaRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
CodEmpresa	Decimal	Código da empresa relacionada à obrigação. (Verifique o link para identificar a origem do dado)
CodEstabelecimento	Decimal	Código do estabelecimento relacionado à obrigação. (Verifique o link para identificar a origem do dado)
CodObrigacao	Int	Código da obrigação a ser encerrada. (Verifique o link para identificar a origem do dado)
IdObrigacaoEvento	Int	Id do evento a ser encerrado. (Verifique o link para identificar a origem do dado)
SeqTarefa	Int	Sequência da tarefa a ser encerrada. (Verifique o link para identificar a origem do dado)
ObservacaoEncerramento	String	Observação que será vinculada à tarefa no encerramento
ArquivosObrigacao	ArquivoObrigacao[]	Arquivos que serão vinculados ao evento no encerramento
ArquivoObrigacao
Campo	Tipo	Descrição
CodArquivo	String	Código do arquivo. (Verifique o link para identificar a origem do dado)
NomeArquivo	String	Nome do arquivo
BytesArquivo	Byte[]	Bytes do arquivo

Resposta “EncerraTarefaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
CodEmpresa	Decimal?	Código da empresa relacionada à obrigação
CodEstabelecimento	Decimal?	Código do estabelecimento relacionado à obrigação
CodObrigacao	Int?	Código da obrigação encerrada
IdObrigacaoEvento	Int?	Código do evento encerrado
SeqTarefa	Int?	Sequência da tarefa encerrada

ReabreTarefa

Método responsável por encerrar tarefas no módulo Workflow.

Requisição “ReabreTarefaRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
CodEmpresa	Decimal	Código da empresa relacionada à obrigação. (Verifique o link para identificar a origem do dado)
CodEstabelecimento	Decimal	Código do estabelecimento relacionado à obrigação. (Verifique o link para identificar a origem do dado)
CodObrigacao	Int	Código da obrigação a ser reaberta. (Verifique o link para identificar a origem do dado)
IdObrigacaoEvento	Int	Id do evento a ser reaberta. (Verifique o link para identificar a origem do dado)
SeqTarefa	Int	Sequência da tarefa a ser reaberta. (Verifique o link para identificar a origem do dado)
ObservacaoReabertura	String	Observação que será vinculada à tarefa na reabertura

Resposta “ReabreTarefaResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
CodEmpresa	Decimal?	Código da empresa relacionada à obrigação
CodEstabelecimento	Decimal?	Código do estabelecimento relacionado à obrigação
CodObrigacao	Int?	Código da obrigação reaberta
IdObrigacaoEvento	Int?	Código do evento reaberta
SeqTarefa	Int?	Sequência da tarefa reaberta

BuscaDocumentoFiscal

Método responsável por buscar o Documento Fiscal que é enviado à auditoria de Regimes Especiais.

Requisição “DocumentoFiscalRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
ChaveDocumento	String	Chave completa do documento a ser consultado

Resposta “DocumentoFiscalResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
DocumentoFiscal	DocumentoFiscal	XML do documento convertido no objeto de negócio compartilhado com a auditoria de Regimes Especiais

AuditarXml

Método responsável por auditar o Documento Fiscal. (A função relacionada a esses métodos foi liberada na versão 3.11 da SFE)

Requisição “AuditarXmlRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
Documento	DocumentoFiscalDto	Documento Fiscal a ser auditado
DocumentoFiscalDto
Campo	Tipo	Descrição
Chave	String	Chave Eletrônica
CodMod	String	Modelo
CodSit	String	Situação
DtDoc	DateTime	Data de Emissão
DtES	DateTime	Data de Entrada/Saída
Empresa	EmpresaDto	Empresa da Operação
IndEmit	Short	Indicador de Emissão 0 – Própria 1 – Terceiros
IndFrt	Short	Indicador do Tipo de Frete 0 – Por Conta de Terceiros 1 – Por Conta do Emitente 2 – Por Conta do Destinatário 9 – Sem Cobrança de Frete
IndOper	Short	Indicador da Operação 1 – Entrada 2 – Saída
IndPgto	Short	Indicador do Tipo de Pagamento 0 – À vista 1 – A prazo 2 – Outros
Itens	ItemDocumentoFiscalDto[]	Itens do Documento
NroDoc	Int	Número do Documento
Participante	ParticipanteDto	Participante da Operação
Ser	String	Série do Documento
VlrAbatNt	Decimal	Abatimento não Tributado e Não Comercial
VlrBcIcms	Decimal	Valor da Base de Cálculo do ICMS
VlrBcIcmsSt	Decimal	Valor da Base de Cálculo do ICMS Substituição Tributária
VlrCofins	Decimal	Valor total da COFINS
VlrCofinsSt	Decimal	Valor Total da COFINS Retido por Substituição Tributária
VlrDesc	Decimal	Valor Total do Desconto
VlrDoc	Decimal	Valor Total do Documento
VlrFrt	Decimal	Valor do Frete Indicado no Documento
VlrIcms	Decimal	Valor do ICMS
VlrIcmsDifal	Decimal	Valor ICMS Diferencial de Alíquota
VlrIpi	Decimal	Valor Total do IPI
VlrMerc	Decimal	Valor Total das Mercadorias e Serviços
VlrOutDa	Decimal	Valor de Outras Despesas Acessórias
VlrPis	Decimal	Valor Total do PIS
VlrPisSt	Decimal	Valor Total do PIS Retido por Substituição Tributária
VlrSeg	Decimal	Valor do Seguro Indicado no Documento
EmpresaDto
Campo	Tipo	Descrição
Cnpj	String	CNPJ da Empresa da Operação
CodMunicipio	String	Código do Município conforme Tabela do IBGE
Estabelecimento	EstabelecimentoDto	Dados do Estabelecimento
IE	String	Inscrição Estadual da Empresa
Uf	String	Sigla para Unidade da Federação
EstabelecimentoDto
Campo	Tipo	Descrição
Cnpj	String	Cnpj do Estabelecimento da Operação
Codigo	String	Código Interno do Estabelecimento no ERP
IE	String	Inscrição Estadual do Estabelecimento
ItemDocumentoFiscalDto
Campo	Tipo	Descrição
AliqCofins	Decimal	Alíquota da COFINS (em reais)
AliqCofinsPerc	Decimal	Alíquota da COFINS (em percentual)
AliqIcms	Decimal	Alíquota do ICMS
AliqIpi	Decimal	Alíquota do IPI
AliqPis	Decimal	Alíquota do PIS (em reais)
AliqPisPerc	Decimal	Alíquota do PIS (em percentual)
AliqSt	Decimal	Alíquota do ICMS da Substituição Tributária na Unidade de Federação de Destino
Cfop	String	Código Fiscal da Operação e Prestação
CodBarra	String	Representação Alfanumérica do Código de Barras do Produto, se existir
CodCta	String	Código da Conta Analítica Contábil Debitada/Creditada
CodEnq	String	Código de Enquadramento Legal do IPI
CodGen	String	Código do Gênero do Item
CodItem	String	Código do item
CodItemfornec	String	Código do Item do Fornecedor. Utilizado para busca mais apurada da relação do Item x Emitente
CodLst	String	Código do Serviço
CodNat	String	Código da Natureza da Operação
CodNcm	String	Código da Nomenclatura Comum do Mercosul
CstCofins	String	Código da Situação Tributária referente ao COFINS
CstIcms	String	Código da Situação Tributária referente ao ICMS
CstIpi	String	Código da Situação Tributária referente ao IPI
CstPis	String	Código de Situação Tributária referente ao PIS
DescrCompl	String	Descrição Complementar do Item
DescrItem	String	Descrição do Item
ExIpi	String	Código EX, conforme a TIPI
IndApur	Short	Indicador de Período de Apuração de IPI 0 – Mensal 1 – Decendial
IndMov	Short	Movimentação Física do Item 0 – Sim 1 – Não
NroItem	Int	Número Sequencial do Item
Qtd	Decimal	Quantidade do item
QuantBcCofins	Decimal	Quantidade – Base de Cálculo COFINS
QuantBcPis	Decimal	Quantidade – Base de Cálculo PIS
SeqItem	Int	Sequência do Item na Escrituração da Nota Fiscal
TipoItem	String	Tipo do Item 00 – Mercadoria para Revenda 01 – Matéria-Prima 02 – Embalagem 03 – Produto em Processo 04 – Produto Acabado 05 – Subproduto 06 – Produto Intermediário 07 – Material de Uso e Consumo 08 – Ativo Imobilizado 09 – Serviços 10 – Outros Insumos 99 – Outras
Unid	String	Unidade do Item
UnidFornec	String	Unidade de Medida Utilizada pelo Fornecedor do Item. Utilizada para a realização de uma busca mais apurada na relação de Item x Emitente
UnidInv	String	Unidade de Medida Utilizada na Quantificação de Estoques
ValidaVlrCofins	Boolean	Determina se a SFE deverá realizar a validação do valor de COFINS para o Item da Nota Fiscal
ValidaVlrIcms	Boolean	Determina se a SFE deverá realizar a validação do valor de ICMS para o Item da Nota Fiscal
ValidaVlrIcmsSt	Boolean	Determina se a SFE deverá realizar a validação do valor de ICMS ST para o Item da Nota Fiscal
ValidaVlrIpi	Boolean	Determina se a SFE deverá realizar a validação do valor de IPI para o Item da Nota Fiscal
ValidaVlrPis	Boolean	Determina se a SFE deverá realizar a validação do valor de PIS para o Item da Nota Fiscal
VlrBcCofins	Decimal	Valor da Base de Cálculo da COFINS
VlrBcIcms	Decimal	Valor da Base de Cálculo do ICMS
VlrBcIcmsSt	Decimal	Valor da Base de Cálculo referente à Substituição Tributária
VlrBcIpi	Decimal	Valor da Base de Cálculo do IPI
VlrBcPis	Decimal	Valor da Base de Cálculo do PIS
VlrCofins	Decimal	Valor da COFINS
VlrDesc	Decimal	Valor do Desconto Comercial
VlrIcms	Decimal	Valor do ICMS Creditado/Debitado
VlrIcmsSt	Decimal	Valor do ICMS referente à Substituição Tributária
VlrIpi	Decimal	Valor do IPI Creditado/Debitado
VlrItem	Decimal	Valor Total do Item
VlrPis	Decimal	Valor do PIS
ParticipanteDto
Campo	Tipo	Descrição
Bairro	String	Bairro em que o imóvel está situado
CnpjCpf	String	CNPJ ou CPF
CodMun	Int	Código do Município do Endereço, conforme o IBGE
CodPais	String	Código do País
Codigo	String	Código de Identificação do Participante no ERP
Complemento	String	Dados Complementares do endereço
Endereco	String	Logradouro e Endereço do Imóvel
IE	String	Inscrição Estadual
Numero	String	Número do Imóvel
RazaoSocial	String	Nome Pessoal ou Empresa no ERP
Suframa	String	Número de Inscrição do Participante na Suframa

Resposta “AuditarXmlResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
CnpjEmpresa	String	CNPJ da Empresa da Operação
CnpjEstabelecimento	String	CNPJ do Estabelecimento da Operação
CodAuditoria	Decimal	Identificador Sequencial Único da Auditoria na SFE
DataFim	DateTime	Data e Hora da finalização da Auditoria na SFE
DataInicio	DateTime	Data e Hora da inclusão da Auditoria na SFE
Documento	DocumentoAuditoriaDto	Documento auditado
StatusAuditoria	Short	Indicador da Situação da Auditoria 1 - Aguardando 2 - Em Processamento 3 - Processado 4 - Erro
DocumentoAuditoriaDto - AuditarXml
Campo	Tipo	Descrição
Chave	String	Chave Eletrônica
CodMod	String	Código do Modelo
CodPart	String	Código de Identificação do Participante
Inconsistencias	InconsistenciaDto[]	Lista de Inconsistências
IndOper	String	Indicador do Tipo de Operação 0 – Entrada 1 – Saída
IntEmit	String	Indicador de Emissão 0 – Própria 1 – Terceiros
NroDoc	Decimal	Número do Documento Fiscal
Ser	String	Série do Documento Fiscal
StatusAuditoriaDocumento	Short	Indicador da situação do documento na auditoria 1 – Documento Fiscal com Erro(s) 2 – Documento Fiscal sem Erro(s)
InconsistenciaDto - AuditarXml
Campo	Tipo	Descrição
AgrupadorValidacao	String	Agrupador Interno da SFE para classificação do tipo de validação
Codigo	String	Código Único da inconsistência na aplicação
DadosAnalise	String	Dados utilizados para realização da consistência
DescrAnalise	String	Descrição da mensagem que indica a inconsistência ocorrida
DetalheDescricao	String	JSON contendo as descrições do detalhamento da validação
DetalheValor	String	JSON contendo os valores do detalhamento da validação
PropostaSolucao	String	Proposta com a possível solução para a inconsistência encontrada
SeqItem	Int	Sequência de escrituração do Item na Nota Fiscal, será utilizado para indicar qual o item da nota no caso de validações no nível dos itens.

AuditarLoteXml

Método responsável por auditar um lote de Documentos Fiscais.

Requisição “AuditarLoteXmlRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
Documentos	DocumentoFiscalDto[]	Documentos Fiscais a serem auditado
DocumentoFiscalDto
Campo	Tipo	Descrição
Chave	String	Chave Eletrônica
CodMod	String	Modelo
CodSit	String	Situação
DtDoc	DateTime	Data de Emissão
DtES	DateTime	Data de Entrada/Saída
Empresa	EmpresaDto	Empresa da Operação
IndEmit	Short	Indicador de Emissão 0 – Própria 1 – Terceiros
IndFrt	Short	Indicador do Tipo de Frete 0 – Por Conta de Terceiros 1 – Por Conta do Emitente 2 – Por Conta do Destinatário 9 – Sem Cobrança de Frete
IndOper	Short	Indicador da Operação 1 – Entrada 2 – Saída
IndPgto	Short	Indicador do Tipo de Pagamento 0 – À vista 1 – A prazo 2 – Outros
Itens	ItemDocumentoFiscalDto[]	Itens do Documento
NroDoc	Int	Número do Documento
Participante	ParticipanteDto	Participante da Operação
Ser	String	Série do Documento
VlrAbatNt	Decimal	Abatimento não Tributado e Não Comercial
VlrBcIcms	Decimal	Valor da Base de Cálculo do ICMS
VlrBcIcmsSt	Decimal	Valor da Base de Cálculo do ICMS Substituição Tributária
VlrCofins	Decimal	Valor total da COFINS
VlrCofinsSt	Decimal	Valor Total da COFINS Retido por Substituição Tributária
VlrDesc	Decimal	Valor Total do Desconto
VlrDoc	Decimal	Valor Total do Documento
VlrFrt	Decimal	Valor do Frete Indicado no Documento
VlrIcms	Decimal	Valor do ICMS
VlrIcmsDifal	Decimal	Valor ICMS Diferencial de Alíquota
VlrIpi	Decimal	Valor Total do IPI
VlrMerc	Decimal	Valor Total das Mercadorias e Serviços
VlrOutDa	Decimal	Valor de Outras Despesas Acessórias
VlrPis	Decimal	Valor Total do PIS
VlrPisSt	Decimal	Valor Total do PIS Retido por Substituição Tributária
VlrSeg	Decimal	Valor do Seguro Indicado no Documento
EmpresaDto
Campo	Tipo	Descrição
Cnpj	String	CNPJ da Empresa da Operação
CodMunicipio	String	Código do Município conforme Tabela do IBGE
Estabelecimento	EstabelecimentoDto	Dados do Estabelecimento
IE	String	Inscrição Estadual da Empresa
Uf	String	Sigla para Unidade da Federação
EstabelecimentoDto
Campo	Tipo	Descrição
Cnpj	String	Cnpj do Estabelecimento da Operação
Codigo	String	Código Interno do Estabelecimento no ERP
IE	String	Inscrição Estadual do Estabelecimento
ItemDocumentoFiscalDto
Campo	Tipo	Descrição
AliqCofins	Decimal	Alíquota da COFINS (em reais)
AliqCofinsPerc	Decimal	Alíquota da COFINS (em percentual)
AliqIcms	Decimal	Alíquota do ICMS
AliqIpi	Decimal	Alíquota do IPI
AliqPis	Decimal	Alíquota do PIS (em reais)
AliqPisPerc	Decimal	Alíquota do PIS (em percentual)
AliqSt	Decimal	Alíquota do ICMS da Substituição Tributária na Unidade de Federação de Destino
Cfop	String	Código Fiscal da Operação e Prestação
CodBarra	String	Representação Alfanumérica do Código de Barras do Produto, se existir
CodCta	String	Código da Conta Analítica Contábil Debitada/Creditada
CodEnq	String	Código de Enquadramento Legal do IPI
CodGen	String	Código do Gênero do Item
CodItem	String	Código do item
CodItemfornec	String	Código do Item do Fornecedor. Utilizado para busca mais apurada da relação do Item x Emitente
CodLst	String	Código do Serviço
CodNat	String	Código da Natureza da Operação
CodNcm	String	Código da Nomenclatura Comum do Mercosul
CstCofins	String	Código da Situação Tributária referente ao COFINS
CstIcms	String	Código da Situação Tributária referente ao ICMS
CstIpi	String	Código da Situação Tributária referente ao IPI
CstPis	String	Código de Situação Tributária referente ao PIS
DescrCompl	String	Descrição Complementar do Item
DescrItem	String	Descrição do Item
ExIpi	String	Código EX, conforme a TIPI
IndApur	Short	Indicador de Período de Apuração de IPI 0 – Mensal 1 – Decendial
IndMov	Short	Movimentação Física do Item 0 – Sim 1 – Não
NroItem	Int	Número Sequencial do Item
Qtd	Decimal	Quantidade do item
QuantBcCofins	Decimal	Quantidade – Base de Cálculo COFINS
QuantBcPis	Decimal	Quantidade – Base de Cálculo PIS
SeqItem	Int	Sequência do Item na Escrituração da Nota Fiscal
TipoItem	String	Tipo do Item 00 – Mercadoria para Revenda 01 – Matéria-Prima 02 – Embalagem 03 – Produto em Processo 04 – Produto Acabado 05 – Subproduto 06 – Produto Intermediário 07 – Material de Uso e Consumo 08 – Ativo Imobilizado 09 – Serviços 10 – Outros Insumos 99 – Outras
Unid	String	Unidade do Item
UnidFornec	String	Unidade de Medida Utilizada pelo Fornecedor do Item. Utilizada para a realização de uma busca mais apurada na relação de Item x Emitente
UnidInv	String	Unidade de Medida Utilizada na Quantificação de Estoques
ValidaVlrCofins	Boolean	Determina se a SFE deverá realizar a validação do valor de COFINS para o Item da Nota Fiscal
ValidaVlrIcms	Boolean	Determina se a SFE deverá realizar a validação do valor de ICMS para o Item da Nota Fiscal
ValidaVlrIcmsSt	Boolean	Determina se a SFE deverá realizar a validação do valor de ICMS ST para o Item da Nota Fiscal
ValidaVlrIpi	Boolean	Determina se a SFE deverá realizar a validação do valor de IPI para o Item da Nota Fiscal
ValidaVlrPis	Boolean	Determina se a SFE deverá realizar a validação do valor de PIS para o Item da Nota Fiscal
VlrBcCofins	Decimal	Valor da Base de Cálculo da COFINS
VlrBcIcms	Decimal	Valor da Base de Cálculo do ICMS
VlrBcIcmsSt	Decimal	Valor da Base de Cálculo referente à Substituição Tributária
VlrBcIpi	Decimal	Valor da Base de Cálculo do IPI
VlrBcPis	Decimal	Valor da Base de Cálculo do PIS
VlrCofins	Decimal	Valor da COFINS
VlrDesc	Decimal	Valor do Desconto Comercial
VlrIcms	Decimal	Valor do ICMS Creditado/Debitado
VlrIcmsSt	Decimal	Valor do ICMS referente à Substituição Tributária
VlrIpi	Decimal	Valor do IPI Creditado/Debitado
VlrItem	Decimal	Valor Total do Item
VlrPis	Decimal	Valor do PIS
ParticipanteDto
Campo	Tipo	Descrição
Bairro	String	Bairro em que o imóvel está situado
CnpjCpf	String	CNPJ ou CPF
CodMun	Int	Código do Município do Endereço, conforme o IBGE
CodPais	String	Código do País
Codigo	String	Código de Identificação do Participante no ERP
Complemento	String	Dados Complementares do endereço
Endereco	String	Logradouro e Endereço do Imóvel
IE	String	Inscrição Estadual
Numero	String	Número do Imóvel
RazaoSocial	String	Nome Pessoal ou Empresa no ERP
Suframa	String	Número de Inscrição do Participante na Suframa

Resposta “AuditarLoteXmlResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
IdAuditoria	Decimal?	Id da auditoria cadastrada, em caso de sucesso
DataHoraIni	DateTime?	Data e hora da auditoria cadastrada, em caso de sucesso

ConsultarAuditoriaXml

Método responsável pela consulta da auditoria do Documento Fiscal.

Requisição “ConsultarAuditoriaXmlRequest”

Campo	Tipo	Descrição
Token	String	Token de acesso. (Verifique o link para identificar a origem do dado)
IdAuditoria	Decimal	Identificador Sequencial Único da Auditoria na SFE

Resposta “ConsultarAuditoriaXmlResponse”

Campo	Tipo	Descrição
Sucesso	Boolean	Sucesso ou não no processamento
WsError	WsError[]	Mensagens de erro
CnpjEmpresa	String	CNPJ da Empresa da Operação
CnpjEstabelecimento	String	CNPJ do Estabelecimento da Operação
CodAuditoria	Decimal	Identificador Sequencial Único da Auditoria na SFE
DataFim	DateTime	Data e Hora da finalização da Auditoria na SFE
DataInicio	DateTime	Data e Hora da inclusão da Auditoria na SFE
Documentos	DocumentoAuditoriaDto[]	Documento(s) auditado(s)
StatusAuditoria	Short	Indicador da Situação da Auditoria 1 – Aguardando 2 – Em Processamento 3 – Processado 4 – Erro
DocumentoAuditoriaDto - ConsultarAuditoriaXml
Campo	Tipo	Descrição
Chave	String	Chave Eletrônica
CodMod	String	Código do Modelo
CodPart	String	Código de Identificação do Participante
Inconsistencias	InconsistenciaDto[]	Lista de Inconsistências
IndOper	String	Indicador do Tipo de Operação 0 – Entrada 1 – Saída
IntEmit	String	Indicador de Emissão 0 – Própria 1 – Terceiros
NroDoc	Decimal	Número do Documento Fiscal
Ser	String	Série do Documento Fiscal
StatusAuditoriaDocumento	Short	Indicador da situação do documento na auditoria 1 – Documento Fiscal com Erro(s) 2 – Documento Fiscal sem Erro(s)
InconsistenciaDto - ConsultarAuditoriaXml
Campo	Tipo	Descrição
AgrupadorValidacao	String	Agrupador Interno da SFE para classificação do tipo de validação
Codigo	String	Código Único da inconsistência na aplicação
DadosAnalise	String	Dados utilizados para realização da consistência
DescrAnalise	String	Descrição da mensagem que indica a inconsistência ocorrida
DetalheDescricao	String	JSON contendo as descrições do detalhamento da validação
DetalheValor	String	JSON contendo os valores do detalhamento da validação
PropostaSolucao	String	Proposta com a possível solução para a inconsistência encontrada
SeqItem	Int	Sequência de escrituração do Item na Nota Fiscal, será utilizado para indicar qual o item da nota no caso de validações no nível dos itens.