IN CadastroNotaFiscal.integrador: mudanças entre as edições

De CIGAM WIKI
Sem resumo de edição
 
(86 revisões intermediárias por 5 usuários não estão sendo mostradas)
Linha 1: Linha 1:
*<b>Requisição</b>
{{VoltarPagina}}
**<b>Soap:</b> http://servidor/CadastroNotaFiscal.integrador.asmx
[[Integrador]] >  
**<b>Rest/JSon:</b> http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
[[IN_CIGAM Integrador#Compras|WebServices]] >
**<b>Tipo de registro:</b> CADNF
[[IN CadastroNotaFiscal.integrador]]


==== Cadastrar====
=Requisição=
==== ListarId ====
*<b>Soap:</b> http://servidor/CadastroNotaFiscal.integrador.asmx
==== ListarPendentes ====
*<b>Rest/JSon:</b> http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
==== LiberarPendentes ====
**<b>Tipo de registro:</b> CADNF1
==== ListarNotasFiscais ====
==== ListarNotasFiscaisInutilizadas ====
<p align="justify"><b><i>
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.</br></b></i></p>


*<b>Parâmetros:</b></br>
=Métodos=
<div style="background-color: #f2f2f2">
<!--bgcolor="#5F6B7A"-->
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Obrigatório, Tipo: String 20<br><br>
    <tr>
&nbsp;&nbsp;&nbsp; <b>nf:</b><br>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>CadastrarNotasFiscais</b></font></td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: numerico<br><br>
    </tr>
&nbsp;&nbsp;&nbsp;<b>serie:</b><br>
    <tr>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: String<br><br>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.<br>As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.</p>
&nbsp;&nbsp;&nbsp;<b>codigoUnidadeNegocio:</b><br>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: String<br><br>
{{#tree: minExpandLevel=2 |
  </div>
*pin
</br>
** Obrigatório, Tipo: String 20


<b>Exemplo de Retorno XML:</b></br>
*statusRegistro
<Retorno></br>
** Tipo: String 1
&nbsp;&nbsp;<fagernfe></br>
** L=Liberado, P=Pendente
&nbsp;&nbsp;&nbsp;&nbsp;<reg></br>
** Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<nf>0000687623</nf></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<serie>NFE</serie></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<codigoUnidadeNegocio>2</codigoUnidadeNegocio></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataNota>DD/MM/AAAA</dataNota></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataEnvio>DD/MM/AAAA</dataEnvio></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataRetorno>DD/MM/AAAA</dataRetorno></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<horaRetorno>HHMMSS</horaRetorno></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<status>6</status></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<numeroProtocolo>143170000292574</numeroProtocolo></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tipoAmbiente>2</tipoAmbiente></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<especieNota>S</especieNota></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<xmlEnvio>..........</xmlEnvio></br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<xmlRetorno>........</xmlRetorno></br>
&nbsp;&nbsp;&nbsp;&nbsp;</reg></br>
&nbsp;&nbsp;</fagernfe></br>
</Retorno>
</br>


<b>Exemplo de Retorno JSON:</b></br>
*notaFiscalXml
&nbsp;[</br>
** Tipo: String -
&nbsp;&nbsp;&nbsp;{</br>
** Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nf": "0000687623",</br>
** Obrigatório apenas para requisições SOAP.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serie": "NFE",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"codigoUnidadeNegocio": "2",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"codigoRetornoInutilizacao": "102",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataNota": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataEnvio": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataRetorno": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"horaRetorno": "HHMMSS",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status": "6",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numeroProtocolo": "143170000292574",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tipoAmbiente": "2",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"especieNota": "S",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"xmlEnvio": "............",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"xmlRetorno": "..........."</br>
&nbsp;&nbsp;&nbsp;}</br>
&nbsp;]</br>


==== ListarNotasFiscaisPaf ====
*notaFiscalJson
==== ListasNFsMultiplasFormasPagamento ====
** Tipo: String -
==== ListarComissoesPorRepresentante ====
** Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
 
** Obrigatório apenas para requisições REST/JSON.
==== CadastrarNotasFiscais ====
}}
<p align="justify"><i>
Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os
dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para
requisições REST. Ambos com estrutura específica conforme descrito a seguir.</i>
</p>
 
*<b>Parâmetros:</b></br>
<div style="background-color: #f2f2f2">
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 20<br>
<br>
&nbsp;&nbsp;&nbsp;<b>statusRegistro</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 1<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;L=Liberado, P=Pendente<br>
<br>
&nbsp;&nbsp;&nbsp;<b>notaFiscalXml</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório apenas para requisições SOAP. Tipo: String<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.<br>
<br>
&nbsp;&nbsp;&nbsp;<b>notaFiscalJson:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório apenas para requisições REST/JSON. Tipo: String<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.<br>
  </div>
</br>


*<b>Distribuição das Tags XML:</b>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p><br>
{{#tree:
{{#tree: |
*<cadastroNotaFiscal>
*<cadastroNotaFiscal>
**  <notasFiscais>
**<notasFiscais>
***      <notaFiscal>
***<notaFiscal>
****      <unidadeNegocio/>
****<unidadeNegocio>
****      <nf/>
***** Tipo: String 3
****      <serie/>
****<nf>
****      <valorPISRetencao/>
***** Tipo: Int 10
****      <tipoOperacao/>
****<serie>
****      <CFOP/>
***** Tipo: String 5
****      <dataEmissao/>
****<valorPISRetencao>
****      <viaTransporte/>
***** Tipo: Float 11.2
****      <documentoFiscal/>
****<tipoOperacao>
****      <cliente/>
***** Tipo: String 5
****      <cobranca/>
****<CFOP>
****      <representante/>
***** Tipo: String 6
****      <baseICMS/>
****<dataEmissao>
****      <percentualICMS/>
***** Tipo: Date
****      <valorICMS/>
****<viaTransporte>
****      <ICMSNaoTributado/>
***** Tipo: String 1
****      <ICMSOutros/>
****<documentoFiscal>
****      <baseIPI/>
***** Tipo: String 5
****      <valorIPI/>
****<cliente>
****      <IPINaoTributado/>
***** Tipo: String 6
****      <IPIOutros/>
****<cobranca>
****      <valorISS/>
***** Tipo: String 6
****      <baseISS/>
****<representante>
****      <incidenciaPIS/>
***** Tipo: String 6
****      <incidenciaCOFINS/>
****<baseICMS>
****      <percDescontoAteVencimento/>
***** Tipo: Float 13.2
****      <valorDescDuplicata/>
****<percentualICMS>
****      <percDescontoSugestaoItens/>
***** Tipo: Float 2.4
****      <valorTotalDesconto/>
****<valorICMS>
****      <percGeralOutrasDespAcessorias/>
***** Tipo: Float 11.2
****      <valorTotalFrete/>
****<ICMSNaoTributado>
****      <seguro/>
***** Tipo: Float 11.2
****      <totalMercadorias/>
****<ICMSOutros>
****      <totalNF/>
***** Tipo: Float 11.2
****      <transportadora/>
****<baseIPI>
****      <consignatario/>
***** Tipo: Float 13.2
****      <marca/>
****<valorIPI>
****      <volume/>
***** Tipo: Float 11.2
****      <quantidade/>
****<IPINaoTributado>
****      <especie/>
***** Tipo: Float 11.2
****      <pesoLiquido/>
****<IPIOutros>
****      <pesoBruto/>
***** Tipo: Float 11.2
****      <conta/>
****<valorISS>
****      <portador/>
***** Tipo: Float 11.2
****      <fatura/>
****<baseISS>
****      <cobrarPauta/>
***** Tipo: Float 13.2
****      <remessa/>
****<incidenciaPIS>
****      <pedido/>
***** Tipo: String 1
****      <dataSaida/>
****<incidenciaCOFINS>
****      <horaSaida/>
***** Tipo: String 1
****      <percGeralEncargosFinanceiros/>
****<percDescontoAteVencimento>
****      <gerouLancamentos/>
***** Tipo: Float 3.2
****      <itemsNaNota/>
****<valorDescDuplicata>
****      <tipoFrete/>
***** Tipo: Float 11.2
****      <uf/>
****<percDescontoSugestaoItens>
****      <percentualComissao/>
***** Tipo: Float 3.2
****      <placa/>
****<valorTotalDesconto>
****      <valorIRRF/>
***** Tipo: Float 11.2
****      <especieNota/>
****<percGeralOutrasDespAcessorias>
****      <subtotalizar/>
***** Tipo: Float 3.2
****      <incidenciaISS/
****<valorTotalFrete>
***** Tipo: Float 11.2
****<seguro>
***** Tipo: Float 11.2
****<totalMercadorias>
***** Tipo: Float 13.2
****<totalNF>
***** Tipo: Float 13.2
****<transportadora>
***** Tipo: String 6
****<consignatario>
***** Tipo: String 6
****<marca>
***** Tipo: String 12
****<volume>
***** Tipo: String 15
****<quantidade>
***** Tipo: String 6
****<especie>
***** Tipo: String 16
****<pesoLiquido>
***** Tipo: Float 8.2
****<pesoBruto>
***** Tipo: Float 8.2
****<conta>
***** Tipo: String 6
****<portador>
***** Tipo: String 3
****<fatura>
***** Tipo: Int 10
****<cobrarPauta>
***** Tipo: String 1
***** S=Sim;
***** N=Não
****<remessa>
***** Tipo: String 3
****<pedido>
***** Tipo: String 12
****<dataSaida>
***** Tipo: Date
****<horaSaida>
***** Tipo: Int 8
****<percGeralEncargosFinanceiros>
***** Tipo: Float 2.3
****<gerouLancamentos>
***** Tipo: Bool
****<itemsNaNota>
***** Tipo: Int 5
****<tipoFrete>
***** Tipo: String 1
***** 1 = Emitente (CIF);
***** 2 = Destinatario (FOB);
***** 3 = EXW;
***** 4 = FCA;
***** 5 = FAZ;
***** 6 = CFR;
***** 7 = CPT;
***** 8 = CIP;
***** 9 = DAF;
***** A = DES;
***** B = DEQ;
***** C = DDU;
***** D = DDP;
***** E = Terceiros;
***** F = Sem frete;
***** G = Próprio(CIF);
***** H = Próprio (FOB)
****<uf>
***** Tipo: String 2
****<percentualComissao>
***** Tipo: Float 3.2
****<placa>
***** Tipo: String 8
****<valorIRRF>
***** Tipo: Float 11.2
****<especieNota>
***** Tipo: String 1
***** E=Entrada;
***** S=Saída;
***** N=Nula
****<subtotalizar>
***** Tipo: Bool
****<incidenciaISS>
***** Tipo: String 1
****<ateNota>
***** Tipo: Int 10
****<totalFaturado>
***** Tipo: Float 13.2
****<totalServico>
***** Tipo:
*</cadastroNotaFiscal>
*</cadastroNotaFiscal>
}}
}}


*<b>Distribuição das Tags Json:</b>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p><br>
 
{{#tree:
{{#tree:
*{
*{
**    "notasFiscais": "",
**"notasFiscais": "",
***      [{
*** [{
****      "unidadeNegocio": "",
****"unidadeNegocio": "",
****      "nf": "",
***** Tipo: String 3
****      "serie": "",
****"nf": "",
****      "valorPISRetencao": "",
***** Tipo: Int 10
****      "tipoOperacao": "",
****"serie": "",
****      "CFOP": "",
***** Tipo: String 5
****      "dataEmissao": "",
****"valorPISRetencao": "",
****      "viaTransporte": "",
***** Tipo: Float 11.2
****      "documentoFiscal": "",
****"tipoOperacao": "",
****      "cliente": "",
***** Tipo: String 5
****      "cobranca": "",
****"CFOP": "",
****      "representante": "",
***** Tipo: String 6
****      "baseICMS": "",
****"dataEmissao": "",
****      "percentualICMS": "",
***** Tipo: Date
****      "valorICMS": "",
****"viaTransporte": "",
****      "ICMSNaoTributado": "",
***** Tipo: String 1
****      "ICMSOutros": "",
****"documentoFiscal": "",
****      "baseIPI": "",
***** Tipo: String 5
****      "valorIPI": "",
****"cliente": "",
****      "IPINaoTributado": "",
***** Tipo: String 6
****      "IPIOutros": "",
****"cobranca": "",
****      "valorISS": "",
***** Tipo: String 6
****      "baseISS": "",
****"representante": "",
****      "incidenciaPIS": "",
***** Tipo: String 6
****      "incidenciaCOFINS": "",
****"baseICMS": "",
****      "percDescontoAteVencimento": "",
***** Tipo: Float 13.2
****      "valorDescDuplicata": "",
****"percentualICMS": "",
****      "percDescontoSugestaoItens": "",
***** Tipo: Float 2.4
****      "valorTotalDesconto": "",
****"valorICMS": "",
****      "percGeralOutrasDespAcessorias": "",
***** Tipo: Float 11.2
****      "valorTotalFrete": "",
****"ICMSNaoTributado": "",
****      "seguro": "",
***** Tipo: Float 11.2
****      "totalMercadorias": "",
****"ICMSOutros": "",
****      "totalNF": "",
***** Tipo: Float 11.2
****      "transportadora": "",
****"baseIPI": "",
****      "consignatario": "",
***** Tipo: Float 13.2
****      "marca": "",
****"valorIPI": "",
****      "volume": "",
***** Tipo: Float 11.2
****      "quantidade": "",
****"IPINaoTributado": "",
****      "especie": "",
***** Tipo: Float 11.2
****      "pesoLiquido": "",
****"IPIOutros": "",
****      "pesoBruto": "",
***** Tipo: Float 11.2
****      "conta": "",
****"valorISS": "",
****      "portador": "",
***** Tipo: Float 11.2
****      "fatura": "",
****"baseISS": "",
****      "cobrarPauta": "
***** Tipo: Float 13.2
****"incidenciaPIS": "",
***** Tipo: String 1
****"incidenciaCOFINS": "",
***** Tipo: String 1
****"percDescontoAteVencimento": "",
***** Tipo: Float 3.2
****"valorDescDuplicata": "",
***** Tipo: Float 11.2
****"percDescontoSugestaoItens": "",
***** Tipo: Float 3.2
****"valorTotalDesconto": "",
***** Tipo: Float 11.2
****"percGeralOutrasDespAcessorias": "",
***** Tipo: Float 3.2
****"valorTotalFrete": "",
***** Tipo: Float 11.2
****"seguro": "",
***** Tipo: Float 11.2
****"totalMercadorias": "",
***** Tipo: Float 13.2
****"totalNF": "",
***** Tipo: Float 13.2
****"transportadora": "",
***** Tipo: String 6
****"consignatario": "",
***** Tipo: String 6
****"marca": "",
***** Tipo: String 12
****"volume": "",
***** Tipo: String 15
****"quantidade": "",
***** Tipo: String 6
****"especie": "",
***** Tipo: String 16
****"pesoLiquido": "",
***** Tipo: Float 8.2
****"pesoBruto": "",
***** Tipo: Float 8.2
****"conta": "",
***** Tipo: String 6
****"portador": "",
***** Tipo: String 3
****"fatura": "",
***** Tipo: Int 10
****"cobrarPauta": "",
***** Tipo: String 1
***** S=Sim;
***** N=Não
****"remessa": "",
***** Tipo: String 3
****"pedido": "",
***** Tipo: String 12
****"dataSaida": "",
***** Tipo: Date
****"horaSaida": "",
***** Tipo: Int 8
****"percGeralEncargosFinanceiros": "",
***** Tipo: Float 2.3
****"gerouLancamentos": "",
***** Tipo: Bool
****"itemsNaNota": "",
***** Tipo: Int 5
****"tipoFrete": "",
***** Tipo: String 1
***** 1 = Emitente (CIF);
***** 2 = Destinatario (FOB);
***** 3 = EXW;
***** 4 = FCA;
***** 5 = FAS;
***** 6 = CFR;
***** 7 = CPT;
***** 8 = CIP;
***** 9 = DAF;
***** A = DES;
***** B = DEQ;
***** C = DDU;
***** D = DDP
*}
*}
}}
}}
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;">
<b>Retornos:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
Linha 1 360: Linha 2 902:
<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>
 
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarNotasFiscaisInutilizadas</b></font></td>
    </tr>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
*pin:
** Obrigatório, Tipo: String 20
 
*nf:
**Tipo: numerico
 
*serie:
**Tipo: String


==== RegistrarNotaFiscalInutilizada ====
*codigoUnidadeNegocio:
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;">
**Tipo: String
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</p>
}}


<center><table width="650" border="1" cellspacing="0" cellpadding="7" style="font-size:10.0pt">
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
    <tr>
<b>Retornos:</b><br/>
        <td width="35%" style="background:#d9d9d9;text-align:center"><strong>Par&acirc;metro</strong></td>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
        <td width="15%" style="background:#d9d9d9;text-align:center"><strong>Tipo</strong></td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
        <td width="15%" style="background:#d9d9d9;text-align:center"><strong>M&aacute;scara</strong></td>
{{#tree: minExpandLevel=2 |
        <td width="35%" style="background:#d9d9d9;text-align:center"><strong>Observa&ccedil;&atilde;o</strong></td>
*<Retorno>
      </tr>
**<fagernfe>
      <tr>
***<reg>
        <td>&nbsp;&nbsp;&nbsp;*pin:</td>
****<nf>0000687623</nf>
        <td>String</td>
****<serie>NFE</serie>
        <td>20A</td>
****<codigoUnidadeNegocio>2</codigoUnidadeNegocio>
        <td>&nbsp;</td>
****<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
      </tr>
****<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
      <tr>
****<dataNota>DD/MM/AAAA</dataNota>
        <td>&nbsp;&nbsp;&nbsp;*statusRegistro:</td>
****<dataEnvio>DD/MM/AAAA</dataEnvio>
        <td>String</td>
****<dataRetorno>DD/MM/AAAA</dataRetorno>
        <td>1A</td>
****<horaRetorno>HHMMSS</horaRetorno>
        <td>L=Liberado, P=Pendente</td>
****<status>6</status>
      </tr>
****<numeroProtocolo>143170000292574</numeroProtocolo>
      <tr>
****<tipoAmbiente>2</tipoAmbiente>
        <td>&nbsp;&nbsp;&nbsp;*codigoUnidadeNegocio:</td>
****<especieNota>S</especieNota>
        <td>String</td>
****<xmlEnvio>..........</xmlEnvio>
        <td>3A</td>
****<xmlRetorno>........</xmlRetorno>
        <td>&nbsp;</td>
***</reg>
      </tr>
**</fagernfe>
      <tr>
*</Retorno>
        <td>&nbsp;&nbsp;&nbsp;*nf:</td>
}}
        <td>num&eacute;rico</td>
 
        <td>10</td>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
        <td>&nbsp;</td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
      </tr>
{{#tree: minExpandLevel=2 |
      <tr>
*[
        <td>&nbsp;&nbsp;&nbsp;*serie</td>
**{
        <td>String</td>
***"nf": "0000687623",
        <td>5A</td>
***"serie": "NFE",
        <td>&nbsp;</td>
***"codigoUnidadeNegocio": "2",
      </tr>
***"codigoRetornoInutilizacao": "102",
      <tr>
***"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
        <td>&nbsp;&nbsp;&nbsp;*codigoRetorno:</td>
***"dataNota": "DD/MM/AAAA",
        <td>String</td>
***"dataEnvio": "DD/MM/AAAA",
        <td>3A</td>
***"dataRetorno": "DD/MM/AAAA",
        <td>Retorno informado em cStat</td>
***"horaRetorno": "HHMMSS",
      </tr>
***"status": "6",
      <tr>
***"numeroProtocolo": "143170000292574",
        <td>&nbsp;&nbsp;&nbsp;*descricaoRetorno:</td>
***"tipoAmbiente": "2",
        <td>String</td>
***"especieNota": "S",
        <td>255A</td>
***"xmlEnvio": "............",
        <td>Retorno informado em xMotivo</td>
***"xmlRetorno": "..........."
      </tr>
**}
      <tr>
*]
        <td>&nbsp;&nbsp;&nbsp;*dataRecibo:</td>
}}
        <td>Date</td>
{{VoltarInicio}}</td>
        <td>##/##/##A</td>
    </tr>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*horaRecibo:</td>
        <td>Time</td>
        <td>HH:MM:SS</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*numeroProtocolo:</td>
        <td>String</td>
        <td>15A</td>
        <td>Retorno informado em nProt</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*xmlEnvio:</td>
        <td>Blob</td>
        <td>&nbsp;</td>
        <td>Xml de Envio</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*xmlRetorno:</td>
        <td>Blob</td>
        <td>&nbsp;</td>
        <td>XML de Retorno</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*chaveAcesso:</td>
        <td>String</td>
        <td>41A</td>
        <td>&nbsp;</td>
    </tr>
</table></center>
</table></center>


<center><table width="650" border="0" cellspacing="0" cellpadding="7" style="font-size:8.5pt">
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
    <tr>
        <td colspan=4 valign=top'>&nbsp;&nbsp;&nbsp;<b>(*)</b> Campo obrigatório</td>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>RegistrarNotaFiscalInutilizada </b></font></td>
    </tr>
    </tr>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
*pin</td>
** Obrigatório, Tipo: String 20A
 
*statusRegistro
** Obrigatório, Tipo: String 1A
** L=Liberado, P=Pendente
 
*codigoUnidadeNegocio
** Obrigatório, Tipo: String 3A
 
*nf
** Obrigatório, Tipo: numérico 10
 
*serie
** Obrigatório, Tipo: String 5A
 
*codigoRetorno
** Obrigatório, Tipo: String 3A
** Retorno informado em cStat
 
*descricaoRetorno
** Obrigatório, Tipo: String 255A
** Retorno informado em xMotivo
 
*dataRecibo
** Obrigatório, Tipo: Date
 
*horaRecibo
** Obrigatório, Tipo: Time
 
*numeroProtocolo
** Obrigatório, Tipo: String 15A
** Retorno informado em nProt
 
*xmlEnvio
** Obrigatório, Tipo: Blob
** Xml de Envio
 
*xmlRetorno
** Obrigatório, Tipo: Blob
** XML de Retorno
 
*chaveAcesso
** Obrigatório, Tipo: String 41A
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>
</table></center>
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ExcluirNotaFiscal</b></font></td>
    </tr>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Esse método fará as mesmas validações que ocorrem ao tentar excluir uma NFe manualmente, com a diferença que permitirá a exclusão de notas fiscais confirmadas, visto que o cancelamento na SEFAZ já foi feito através de um sistema de terceiros.<br><br>
Informações obrigatórias para a exclusão da nota: Número, Série e Unidade de Negócio. O sistema faz a validação se a série da nota fiscal está cadastrada para a unidade de negócio informada nos filtro do programa utilizado para integração.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <pin Type="System.String">''001''</pin><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <statusRegistro Type="System.String">''L''</statusRegistro><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <nf Type="System.Int32">''número NF''</nf><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <serie Type="System.String">''série NF''</serie><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>
{{VoltarInicio}}</td>
    </tr>
</table></center>
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td>
    </tr>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*acao
** Tipo: String 1
** C=Cadastrar, E=Excluir
** Se for informado algo diferente de C ou E não será aplicado nenhum filtro
*statusRegistro
** Tipo: String 1
** L=Liberado, P=Pendente
** Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp; Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*idRegistro
** Tipo: Int 14
*acao
** Tipo: String 1
*statusRegistro
** Tipo: String 1
*dataRequisicao
** Tipo: Date
*horaRequisicao
** Tipo: Int 8
*idCorrelato
** Tipo: Int 14
*codigoPedido
** Tipo: String 12
*codigoCliente
** Tipo: Int 8
*codigoTipoOperacao
** Tipo: String 5
*emissao
** Tipo: Date
*situacao
** Tipo: String 1
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>
 
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarNotasFiscais</b></font></td>
    </tr>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
 
*nf
** Tipo: Int 10
 
*serie
** Tipo: String 5
 
*codigoUnidadeNegocio
** Tipo: String 3
 
*tipoOperacao
** Tipo: String 5
 
*codigoCliente
** Tipo: String 6
 
*codigoRepresentante
** Tipo: String 6
 
*tipoNota
** Tipo: String 1
** N=Normal, D=Devolução,T=Transferência,  C=Complementar, I=Importação, S=Sessão de Crédito ICMS, M=Mapa Resumo,
** B=Brinde, F=Frete/Conhecimento, G=Garantia/Troca, E=Entrega Futura, V=Venda a Ordem, R=Remessa, 1=Genérico, 2=Genérico,
** 3=Genérico, 4=Genérico, 5=Genérico, A=Beneficiamento, H=Conserto, J=Consignação, K=Demonstração, O=Remessa 1,
** P=Remessa 2, Q=Remessa 3, U=Correção, 6=Importação Drawback, 7=Normal Drawback, 8=Genérico, 9=Genérico, 0=Genérico,
** W=Genérico, X=Genérico, Y=Genérico, Z=Genérico, L=Genérico
 
*codigoTransportadora
** Tipo: String 6
 
*dataEmissaoInicial
** Tipo: Date


==== ExcluirNotaFiscal ====
*dataEmissaoFinal
Permitirá a exclusão de notas fiscais Confirmadas na SEFAZ.
** Tipo: Date
<P align="justify">
}}
Informações necessárias para a exclusão da nota: Número, Série e Unidade de Negócio. O sistema faz a validação se a série da nota fiscal está cadastrada para a unidade de negócio informada nos filtro do programa utilizado para integração.
 
<br>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<br>
<b>Retornos:</b><br/>
'''Parâmetros'''
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
<br>
{{#tree: minExpandLevel=2 |
  <pin Type="System.String">''001''</pin>
*<cadastrarNotasFiscais>
<br>
**<notasFiscais>
  <statusRegistro Type="System.String">''L''</statusRegistro>
***<notaFiscal>
<br>
****<unidadeNegocio />
  <nf Type="System.Int32">''número NF''</nf>
****<nf>0</nf>
<br>
****<serie />
  <serie Type="System.String">''série NF''</serie>
****<tipoOperacao />
<br>
****<dataEmissao />
  <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>
****<cliente />
****<representante />
****<uf />
****<quantidadeTotal>0</quantidadeTotal>
****<entrega>0</entrega>
****<itensNf>
*****<itemNf>
******<codigoMaterial />
******<centroArmazenagem />
******<grade />
******<quantidade>0</quantidade>
******<precoUnitario>0</precoUnitario>
******<descricao />
******<grades>
*******<gradeItemNf>
********<numeracao />
********<quantidade>0</quantidade>
*******</gradeItemNf>
******</grades>
******<comissoesItem>
*******<comissaoNf>
********<representante />
********<valorBaseComissao>0</valorBaseComissao>
********<percentualComissao>0</percentualComissao>
*******</comissaoNf>
******</comissoesItem>
*****</itemNf>
****</itensNf>
****<comissoesNf>
*****<comissaoNf>
******<representante />
******<valorBaseComissao>0</valorBaseComissao>
******<percentualComissao>0</percentualComissao>
*****</comissaoNf>
****</comissoesNf>
****<parcelasNf>
*****<parcelaNf>
******<vencimento />
******<valorParcela>0</valorParcela>
*****</parcelaNf>
****</parcelasNf>
***</notaFiscal>
**</notasFiscais>
*</cadastrarNotasFiscais>
}}
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
{{#tree: minExpandLevel=2 |
*{
**"notasFiscais": [{
***"notaFiscal": {
****"unidadeNegocio": "",
****"nf": "0",
****"serie": "",
****"tipoOperacao": "",
****"dataEmissao": "",
****"cliente": "",
****"representante": "",
****"uf": "",
****"quantidadeTotal": "0",
****“entrega”: “0”,
****"itensNf": [{
*****"itemNf": {
******"codigoMaterial": "",
******"centroArmazenagem": "",
******"grade": "",
******"quantidade": "0",
******"precoUnitario": "0",
******"descricao": "",
******"grades": [{
*******"gradeItemNf": {
********"numeracao": "",
********"quantidade": "0"
*******}
******}],
******"comissoesItem": [{
*******"comissaoNf": {
********"representante": "",
********"valorBaseComissao": "0",
********"percentualComissao": "0"
*******}
******}]
*****}
****}],
****"comissoesNf": [{
*****"comissaoNf": {
******"representante": "",
******"valorBaseComissao": "0",
******"percentualComissao": "0"
*****}
****}],
****"parcelasNf": [{
*****"parcelaNf": {
******"vencimento": "",
******"valorParcela": "0"
*****}
****}]
***}
**}]
*}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>
<!--
== ListarId ==
== LiberarPendentes ==
== ListarNotasFiscaisPaf ==
== ListasNFsMultiplasFormasPagamento ==
== ListarComissoesPorRepresentante ==
-->

Edição atual tal como às 19h28min de 7 de outubro de 2026

Voltar
Integrador > WebServices > IN CadastroNotaFiscal.integrador

Requisição

Métodos

CadastrarNotasFiscais

Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.
As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.

Parâmetros:



Distribuição das Tags XML:



Distribuição das Tags Json:



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

ListarNotasFiscaisInutilizadas

Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.

Parâmetros:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:

Voltar ao início

RegistrarNotaFiscalInutilizada

Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.

Parâmetros:



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ExcluirNotaFiscal

Esse método fará as mesmas validações que ocorrem ao tentar excluir uma NFe manualmente, com a diferença que permitirá a exclusão de notas fiscais confirmadas, visto que o cancelamento na SEFAZ já foi feito através de um sistema de terceiros.

Informações obrigatórias para a exclusão da nota: Número, Série e Unidade de Negócio. O sistema faz a validação se a série da nota fiscal está cadastrada para a unidade de negócio informada nos filtro do programa utilizado para integração.

Parâmetros:

          <pin Type="System.String">001</pin>
          <statusRegistro Type="System.String">L</statusRegistro>
          <nf Type="System.Int32">número NF</nf>
          <serie Type="System.String">série NF</serie>
          <codigoUnidadeNegocio Type="System.String">UN NEG NF</codigoUnidadeNegocio>

Voltar ao início

ListarPendentes

Parâmetros:



Retornos:
    Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarNotasFiscais

Parâmetros:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início