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

De CIGAM WIKI
Linha 403: Linha 403:
***** Tipo: Float 11.2
***** Tipo: Float 11.2
****<tipoPagamento>
****<tipoPagamento>
***** Tipo: String 2
****<naoCalcularFinanceiro>
****<naoCalcularFinanceiro>
***** Tipo: Bool
***** Tipo: Bool
Linha 1 087: Linha 1 088:
******<formaCondicao>
******<formaCondicao>
******<tipoPagamento>
******<tipoPagamento>
******* Tipo: String 2
******<formaPagamento>
******<formaPagamento>
******<empresa>
******<empresa>
Linha 1 507: Linha 1 509:
***** Tipo: Float 11.2
***** Tipo: Float 11.2
****"tipoPagamento": "",
****"tipoPagamento": "",
***** Tipo: String 2
****"naoCalcularFinanceiro": "",
****"naoCalcularFinanceiro": "",
***** Tipo: Bool
***** Tipo: Bool
Linha 2 169: Linha 2 172:
******"formaCondicao": "",
******"formaCondicao": "",
******"tipoPagamento": "",
******"tipoPagamento": "",
******* Tipo: String 2
******"formaPagamento": "",
******"formaPagamento": "",
******"empresa": "",
******"empresa": "",

Edição das 14h34min de 18 de abril 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:


  • 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:

  • 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