Integrações ** (Esta aba poderá ter o nome alterado- Aguardando resposta PM - Élcio)
Integrações
De acordo com os Manuais de Contribuintes disponibilizados pelas Prefeituras, para cada operação realizada com o Web Service, existirá uma mensagem de retorno. Esta mensagem contém informações que servirão para acompanhar o processo da solicitação após o envio. A última das mensagens recebidas da Prefeitura terá o status do documento que pode ser Rejeitado ou Autorizado.
A aplicação da NDD está preparada para repassar essa informação para o ERP. Utilizando os conceitos de Interface abstrata, foram implementados métodos que são responsáveis pela execução dessa tarefa.
Para utilizar esses métodos, será necessário referenciar a DLL NDDigital.eForms.NFS-e.ValueObject.dll. Dentro dessa DLL encontra-se a classe de Interface AbstractErpIntegration que contém os seguintes métodos que precisam ser implementados:
RetornoNFS-e (IntegrationData integration): Responsável por enviar ao ERP, o retorno do status do documento enviado para o Web Service da Prefeitura. Nesse retorno, pode ser informada uma mensagem de erro, no caso de um documento rejeitado, ou apenas o retorno do número da NFS-e, no caso da autorização do documento pelo Web Service da prefeitura.
RetornoCancelamentoNFS-e (IntegrationData integration): Responsável por enviar ao ERP, o retorno do status do cancelamento enviando para o Web Service da Prefeitura.
RetornoCancelamentoInvalido(IntegrationData integration, string data): Responsável por enviar ao ERP a mensagem de retorno de um arquivo de cancelamento mal formatado. O parâmetro string data é o arquivo original que foi inserido no sistema.
RetornoLoteInvalido(IntegrationData integration, string data): Responsável por enviar ao ERP a mensagem de retorno de um arquivo de envio mal formatado. O parâmetro string data é o arquivo original que foi inserido no sistema.
Definições do objeto IntegrationData utilizado nos métodos acima
Integração de NFS-e | ||
Nome | Valor | Descrição |
SendReturn | 0 | Este Enum representa um retorno de envio. |
ProtocolReturn | 1 | Este Enum representa um retorno de Protocolo. |
NFS-eReturn | 2 | Este Enum representa um retorno de NFS-e. |
CancelReturn | 3 | Este Enum representa um retorno de cancelamento. |
InvalidSendReturn | 99 | Este Enum representa um retorno de envio inválido. |
InvalidCancelReturn | 100 | Este Enum representa um retorno de cancelamento inválido. |
Lista de Integração de Documentos | ||
Nome | Tipo | Descrição |
NumeroRps | long | Número do RPS informado. |
Serie | string | Série do RPS informado. |
TipoRps | byte | Tipo do RPS informado. |
NumeroNFS-e | long | Número da NFS-e retornado pelo Web Service da prefeitura. |
CodigoVerificacao | String | Código de verificação retornado pelo Web Service da prefeitura. |
DataEmissao | DateTime | Data da emissão do documento. |
Cnpj | string | CNPJ da empresa prestadora do serviço. |
Lista de Mensagens de Erros | ||
Nome | Tipo | Descrição |
Codigo | string | Código do erro retornado pelo Web Service da Prefeitura. |
Mensagem | string | Mensagem de erro retornado pelo Web Service da Prefeitura |
TipoRps | string | Mensagem orientando o usuário de como corrigir o erro informado pelo Web Service da Prefeitura. |
Integrações com erros | ||
Nome | Tipo | Descrição |
FileName | string | Nome do arquivo inserido no sistema. |
InvalidDocumentId | long | ID do documento inválido. |
Messages | String | Mensagens contendo os erros capturados na validação do arquivo. |
documentId | long | ID do documento. |
oldProcessId | long | ID do processo que foi inserido na base de dados. |
Formato de codificação do documento | ||
Nome | Valor | Descrição |
UTF8 | 1 | Formato que depende do Manual da Prefeitura. |
ANSI | 2 | Formato que depende do Manual da Prefeitura. |
ASCII | 3 | Formato que depende do Manual da Prefeitura. |
Diretório de Integração (TXT ou XML): Caminho que será utilizado para gravar o arquivo de integração.
Formato de Integração (TXT ou XML): Parâmetro para a escolha do formato do arquivo de integração(ou XML ou TXT).
Hierarquia de diretórios: Parâmetro para a escolha do uso de Hierarquia de pastas. Esta opção possibilita separar as integrações por diretórios.
List<RPSKeysWithError> rpsKeysWithError | ||
Nome | Tipo | Descrição |
NumeroRps | long | Formato que depende do Manual da Prefeitura. |
Serie | string | Formato que depende do Manual da Prefeitura. |
TipoRps | byte | Formato que depende do Manual da Prefeitura. |
Para que o ERP possa receber os dados referentes aos arquivos de retorno da Prefeitura é necessário ter uma DLL que realize esta operação. Para empresas que desejarem utilizar sua própria DLL, a mesma deverá ser desenvolvida utilizando uma linguagem da família .Net e deverá ter implementados os métodos citados anteriormente. Para aquelas que optarem por não desenvolver sua própria DLL de integração, o aplicativo da NDDigital oferece uma DLL padrão.
{{component-feedback-article}}