Agendamento de Exportação Recorrente via API

Olá! Neste artigo vamos explicar como configurar uma nova exportação recorrente no InvoiCy, através da comunicação com o Web Service arecepcao.aspx disponibilizado pelo InvoiCy.

– Inclusão da Exportação Recorrente via API SOAP:

Para realizar a inclusão de uma nova exportação recorrente, após consumir o Web Service arecepcao.aspx você deverá enviar toda a estrutura do XML de inclusão, dentro da tag ‘Documentos’ convertido para texto, como demonstra a imagem.

Para obter o layout de envio e retorno do XML de inclusão da exportação recorrente, faça o download do arquivo Inclusão.zip, nele você encontrará também um arquivo XML de exemplo.

– Consulta da exportação recorrente:

É possível consultar a exportação recorrente que foi enviada, permitindo ao usuário ter a certeza de que a exportação agendada foi configurada de forma correta.

Para isso basta enviar a seguinte estrutura de consulta, conforme demonstra a imagem abaixo, informando a ação que deseja efetuar e o CNPJ da empresa.

Acao – Ação que será realizada. Informar ‘C’.

CNPJ – CNPJ da empresa que deseja buscar as informações.

Clique aqui para fazer download do modelo de XML de envio e retorno da consulta da exportação recorrente.

– Alteração da exportação recorrente:

Também poderá ser realizada a alteração de uma exportação recorrente que foi configurada, para isso, será necessário enviar junto aos dados de envio, o código “Identificador” que é retornado na inclusão ou na consulta da exportação recorrente.

Para baixar o layout de envio e retorno de alteração e um exemplo completo do XML clique aqui. 

– Exclusão da exportação recorrente:

Para realizar a exclusão da exportação recorrente, é necessário enviar a estrutura de exclusão, conforme demonstra a próxima imagem, informando a ação, CNPJ da empresa e o código “Identificador”.

Acao – Ação que será realizada. Informar ‘E’. 

CNPJ – CNPJ da empresa que deseja excluir o agendamento da exportação recorrente.

Identificador – Código identificador retornado na inclusão da exportação recorrente ou na consulta do agendamento.

Observação: A exclusão poderá ser realizada por outro CNPJ parceiro caso este CNPJ esteja vinculado à exportação agendada.

Clique aqui para baixar o layout de envio e retorno de exclusão e um exemplo completo do XML.

– Configuração da Exportação Recorrente via API REST:

Para realizar a inclusão, consulta, alteração ou exclusão da exportação recorrente via API Rest, foi criado um novo endpoint “CompaniesExportRecorrences”. 

Acesse aqui a documentação e exemplos de integração REST.