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

De CIGAM WIKI
Linha 85: Linha 85:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>&nbsp;*pin:</td>
         <td>&nbsp;&nbsp;&nbsp;*pin:</td>
         <td>String</td>
         <td>String</td>
         <td>20A</td>
         <td>20A</td>
Linha 91: Linha 91:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*statusRegistro:</td>
         <td>&nbsp;&nbsp;&nbsp;*statusRegistro:</td>
         <td>String</td>
         <td>String</td>
         <td>1A</td>
         <td>1A</td>
Linha 97: Linha 97:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*codigoUnidadeNegocio:</td>
         <td>&nbsp;&nbsp;&nbsp;*codigoUnidadeNegocio:</td>
         <td>String</td>
         <td>String</td>
         <td>3A</td>
         <td>3A</td>
Linha 103: Linha 103:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*nf:</td>
         <td>&nbsp;&nbsp;&nbsp;*nf:</td>
         <td>num&eacute;rico</td>
         <td>num&eacute;rico</td>
         <td>10</td>
         <td>10</td>
Linha 109: Linha 109:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*serie</td>
         <td>&nbsp;&nbsp;&nbsp;*serie</td>
         <td>String</td>
         <td>String</td>
         <td>5A</td>
         <td>5A</td>
Linha 115: Linha 115:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*codigoRetorno:</td>
         <td>&nbsp;&nbsp;&nbsp;*codigoRetorno:</td>
         <td>String</td>
         <td>String</td>
         <td>3A</td>
         <td>3A</td>
Linha 127: Linha 127:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*dataRecibo:</td>
         <td>&nbsp;&nbsp;&nbsp;*dataRecibo:</td>
         <td>Date</td>
         <td>Date</td>
         <td>##/##/##A</td>
         <td>##/##/##A</td>
Linha 133: Linha 133:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*horaRecibo:</td>
         <td>&nbsp;&nbsp;&nbsp;*horaRecibo:</td>
         <td>Time</td>
         <td>Time</td>
         <td>HH:MM:SS</td>
         <td>HH:MM:SS</td>
Linha 139: Linha 139:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*numeroProtocolo:</td>
         <td>&nbsp;&nbsp;&nbsp;*numeroProtocolo:</td>
         <td>String</td>
         <td>String</td>
         <td>15A</td>
         <td>15A</td>
Linha 145: Linha 145:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*xmlEnvio:</td>
         <td>&nbsp;&nbsp;&nbsp;*xmlEnvio:</td>
         <td>Blob</td>
         <td>Blob</td>
         <td>&nbsp;</td>
         <td>&nbsp;</td>
Linha 151: Linha 151:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*xmlRetorno:</td>
         <td>&nbsp;&nbsp;&nbsp;*xmlRetorno:</td>
         <td>Blob</td>
         <td>Blob</td>
         <td>&nbsp;</td>
         <td>&nbsp;</td>
Linha 157: Linha 157:
       </tr>
       </tr>
       <tr>
       <tr>
         <td>*chaveAcesso:</td>
         <td>&nbsp;&nbsp;&nbsp;*chaveAcesso:</td>
         <td>String</td>
         <td>String</td>
         <td>41A</td>
         <td>41A</td>

Edição das 17h16min 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>