IN Faturamento

De CIGAM WIKI
Revisão de 21h44min de 6 de outubro de 2020 por Elizama.Dias (discussão | contribs)

Integrador > Serviços WebServices > Faturamento

CancelamentoNotaFiscal.integrador

CadastroCondicaoPagamento.integrador

CadastroControlePedido.integrador

CadastroGradePedido.integrador

CadastroItensPedido.integrador

CadastroMapaResumo.integrador

CadastroNotaFiscal.integrador

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

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.


  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   statusRegistro
      Obrigatório, Tipo: String 1
      L=Liberado, P=Pendente
      Se for informado algo diferente de P ou L não será aplicado nenhum filtro.

   notaFiscalXml
      Obrigatório apenas para requisições SOAP. Tipo: String
      Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.

   notaFiscalJson:
      Obrigatório apenas para requisições REST/JSON. Tipo: String
      Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.


  • Distribuição das Tags XML:

  • Distribuição das Tags Json:

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  
   (*) Campo obrigatório


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.

CadastroPedidos.integrador

CadastroPrazoPagamento.integrador