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

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
Linha 2 607: Linha 2 607:
&nbsp;&nbsp;&nbsp; <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>
&nbsp;&nbsp;&nbsp; <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>


== ListarId ==
== ListarPendentes ==
== ListarPendentes ==
== LiberarPendentes ==
<p align=“justify”><i>
</i></p>
 
*<b>Parâmetros:</b><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/>
<b>Retorno:</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/>
<b>Retorno:</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>
 
== ListarNotasFiscais ==
== ListarNotasFiscais ==
<p align=“justify”><i>
</i></p>
*<b>Parâmetros:</b><br>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 3 811: Linha 3 875:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/>


== ListarId ==
== LiberarPendentes ==
== ListarNotasFiscaisPaf ==
== ListarNotasFiscaisPaf ==
== ListasNFsMultiplasFormasPagamento ==
== ListasNFsMultiplasFormasPagamento ==
== ListarComissoesPorRepresentante ==
== ListarComissoesPorRepresentante ==

Edição das 17h24min de 17 de fevereiro de 2022

Voltar

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:


  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:


  • Parâmetros para o elemento lancamentoNf:


  • Parâmetros para o elemento cheque:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


Retorno:
   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.

ListarNotasFiscaisInutilizadas

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

  • Parâmetros:


  • Exemplo de Retorno XML:


  • Exemplo de Retorno JSON:

RegistrarNotaFiscalInutilizada

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

  • Parâmetros:


Retorno:
   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.

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>

ListarPendentes

  • Parâmetros:


Retorno:
    Se sucesso:


Retorno:
   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.

ListarNotasFiscais

  • Parâmetros:


Retorno:
   Se sucesso:

  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


   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.

ListarId

LiberarPendentes

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante