IN Faturamento: mudanças entre as edições

De CIGAM WIKI
Linha 77: Linha 77:
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</br>
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</br>


<center><table width="700" border="1" cellspacing="1" cellpadding="2" style="margin-bottom:0.5cm;margin-bottom:.0001pt;line-height:normal;font-size:10.0pt">
<center><table width="700" border="1" cellspacing="0" cellpadding="7" style="margin-bottom:0.5cm;margin-bottom:.0001pt;line-height:normal;font-size:10.0pt">
     <tr>
     <tr>
         <td width="30%" style="background:#d9d9d9;text-align:center"><strong>Par&acirc;metro</strong></td>
         <td width="30%" style="background:#d9d9d9;text-align:center"><strong>Par&acirc;metro</strong></td>
Linha 91: Linha 91:
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*statusRegistro:</p></td>
         <td>*statusRegistro:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>1A</p></td>
         <td>1A</td>
         <td><p>L=Liberado, P=Pendente</p></td>
         <td>L=Liberado, P=Pendente</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*codigoUnidadeNegocio:</p></td>
         <td>*codigoUnidadeNegocio:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>3A</p></td>
         <td>3A</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*nf:</p></td>
         <td>*nf:</td>
         <td><p>num&eacute;rico</p></td>
         <td>num&eacute;rico</td>
         <td><p>10</p></td>
         <td>10</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*serie</p></td>
         <td>*serie</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>5A</p></td>
         <td>5A</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*codigoRetorno:</p></td>
         <td>*codigoRetorno:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>3A</p></td>
         <td>3A</td>
         <td><p>Retorno informado em cStat</p></td>
         <td>Retorno informado em cStat</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*descricaoRetorno:</p></td>
         <td>*descricaoRetorno:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>255A</p></td>
         <td>255A</td>
         <td><p>Retorno informado em xMotivo</p></td>
         <td>Retorno informado em xMotivo</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*dataRecibo:</p></td>
         <td>*dataRecibo:</td>
         <td><p>Date</p></td>
         <td>Date</td>
         <td><p>##/##/##A</p></td>
         <td>##/##/##A</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*horaRecibo:</p></td>
         <td>*horaRecibo:</td>
         <td><p>Time</p></td>
         <td>Time</td>
         <td><p>HH:MM:SS</p></td>
         <td>HH:MM:SS</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*numeroProtocolo:</p></td>
         <td>*numeroProtocolo:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>15A</p></td>
         <td>15A</td>
         <td><p>Retorno informado em nProt</p></td>
         <td>Retorno informado em nProt</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*xmlEnvio:</p></td>
         <td>*xmlEnvio:</td>
         <td><p>Blob</p></td>
         <td>Blob</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
         <td><p>Xml de Envio</p></td>
         <td>Xml de Envio</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*xmlRetorno:</p></td>
         <td>*xmlRetorno:</td>
         <td><p>Blob</p></td>
         <td>Blob</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
         <td><p>XML de Retorno</p></td>
         <td>XML de Retorno</td>
       </tr>
       </tr>
       <tr>
       <tr>
         <td><p>*chaveAcesso:</p></td>
         <td>*chaveAcesso:</td>
         <td><p>String</p></td>
         <td>String</td>
         <td><p>41A</p></td>
         <td>41A</td>
         <td><p>&nbsp;</p></td>
         <td>&nbsp;</td>
     </tr>
     </tr>
</table></center>
</table></center>

Edição das 17h10min de 28 de maio de 2020

Cadastrar

ListarId

ListarPendentes

LiberarPendentes

ListarNotasFiscais

ListarNotasFiscaisInutilizadas

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

Parâmetros:

 • pin: Obrigatório, Tipo: String
 • nf: Tipo: numerico
 • serie: Tipo: String
 • codigoUnidadeNegocio: Tipo: String


Exemplo de Retorno XML:
<Retorno>
  <fagernfe>
    <reg>
      <nf>0000687623</nf>
      <serie>NFE</serie>
      <codigoUnidadeNegocio>2</codigoUnidadeNegocio>
      <codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
      <descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
      <dataNota>DD/MM/AAAA</dataNota>
      <dataEnvio>DD/MM/AAAA</dataEnvio>
      <dataRetorno>DD/MM/AAAA</dataRetorno>
      <horaRetorno>HHMMSS</horaRetorno>
      <status>6</status>
      <numeroProtocolo>143170000292574</numeroProtocolo>
      <tipoAmbiente>2</tipoAmbiente>
      <especieNota>S</especieNota>
      <xmlEnvio>..........</xmlEnvio>
      <xmlRetorno>........</xmlRetorno>
    </reg>
  </fagernfe>
</Retorno>

Exemplo de Retorno JSON:
 [
   {
      "nf": "0000687623",
      "serie": "NFE",
      "codigoUnidadeNegocio": "2",
      "codigoRetornoInutilizacao": "102",
      "descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
      "dataNota": "DD/MM/AAAA",
      "dataEnvio": "DD/MM/AAAA",
      "dataRetorno": "DD/MM/AAAA",
      "horaRetorno": "HHMMSS",
      "status": "6",
      "numeroProtocolo": "143170000292574",
      "tipoAmbiente": "2",
      "especieNota": "S",
      "xmlEnvio": "............",
      "xmlRetorno": "..........."
   }
 ]

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante

CadastrarNotasFiscais

RegistrarNotaFiscalInutilizada

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

Parâmetro Tipo Máscara Observação

 *pin:

String

20A

 

*statusRegistro: String 1A L=Liberado, P=Pendente
*codigoUnidadeNegocio: String 3A  
*nf: numérico 10  
*serie String 5A  
*codigoRetorno: String 3A Retorno informado em cStat
*descricaoRetorno: String 255A Retorno informado em xMotivo
*dataRecibo: Date ##/##/##A  
*horaRecibo: Time HH:MM:SS  
*numeroProtocolo: String 15A Retorno informado em nProt
*xmlEnvio: Blob   Xml de Envio
*xmlRetorno: Blob   XML de Retorno
*chaveAcesso: String 41A  


Exemplo de Retorno XML:

<Retorno>