PHSYS - Wiki

Conceito

A integração com o sistema Domínio (Domínio Sistemas – Thomson Reuters) permite ao usuário do PHERP enviar os documentos fiscais e as baixas de parcelas para o ambiente do contador, reduzindo processos manuais e mantendo a escrita fiscal do contador atualizada.

O envio é feito pela API Onvio da Domínio, usando a autenticação do PHERP e a chave de integração que o contador fornece para o CNPJ de cada filial. As rotinas de seleção, envio, consulta e controle são internas do PHERP.

O envio é sempre manual: o usuário abre a tela Integração Domínio, escolhe o período, marca os documentos e as baixas desejados e aciona o envio. Nada é enviado automaticamente.

Documentos e Baixas Enviados

Documentos

A integração contempla os seguintes documentos:

• Nota Fiscal Eletrônica (NF-e – Modelo 55)
• Nota Fiscal de Consumidor Eletrônica (NFC-e – Modelo 65)
• Nota Fiscal de Serviço (NFS-e – Modelo 3)
• Documentos de Entrada vinculados à NF-e

É enviado o XML do documento, tanto dos emitidos quanto dos cancelados.

Baixas

Além dos documentos, o PHERP envia as baixas de parcelas (recebimentos e pagamentos) dos documentos que geram financeiro, para que o contador também receba o que foi quitado.

Documento e baixa são enviados separadamente: cada um tem o seu registro de integração e a sua situação, e enviar o documento não envia as suas baixas. A ordem recomendada é enviar primeiro o documento e, depois que ele estiver processado, as suas baixas.

Para cada baixa é montado um arquivo com a identificação do documento (CNPJ da filial, espécie, série e número), a data de vencimento e a data de pagamento da parcela, o valor recebido ou pago, juros, multa, desconto, outros valores e o histórico do lançamento.

Critérios de Seleção dos Documentos

Os documentos exibidos para envio devem atender aos seguintes critérios:

• Pertencer à empresa configurada
• Estar com situação Emitido ou Cancelado
• Possuir XML gerado
• Para documentos de entrada, a NF-e deve estar Autorizada ou Cancelada
• Não ter sido enviado anteriormente (documentos com situação Erro podem ser enviados novamente)
• Ter a data de emissão dentro do período da tela (nos cancelados, também vale a data de cancelamento)

Critérios de Seleção das Baixas

As baixas exibidas para envio devem atender aos seguintes critérios:

• Ser baixa de parcela de documento da empresa configurada que gera contas a receber ou contas a pagar
• O tipo do documento deve possuir a relação de venda ou de compra
• O lançamento de tesouraria da baixa deve estar Confirmado
• Não ter sido enviada anteriormente (baixas com situação Erro podem ser enviadas novamente)
• O documento da parcela deve ter sido emitido dentro do período da tela

Atenção: a baixa entra na lista pela data de emissão do documento, e não pela data em que a baixa foi feita. Uma baixa realizada em outubro de uma nota emitida em setembro aparece quando o período de setembro está selecionado. A coluna Data da baixa mostra a data do pagamento.

Parâmetros de Configuração

A integração é configurada por filial, no cadastro Parâmetros Integração Dominio. Cada filial que vai enviar documentos precisa ter o seu parâmetro, porque a chave de integração pertence ao CNPJ da filial.

Campo	Descrição
Filial	Filial a que o parâmetro se refere. Só pode haver um parâmetro por filial
Autenticação	Autenticação de APIs com o Client ID (identificador do sistema ERP fornecido pela Domínio Sistemas – Thomson Reuters) e o Client Secret (chave secreta vinculada ao Client ID), usados para gerar o token de acesso
Integration Key	Chave fornecida pelo contador (X-IntegrationKey), emitida para o CNPJ da filial
BOX-e	Indica se o contador utiliza o serviço BOX-e para armazenamento dos XMLs

Depois da configuração inicial, o PHERP cuida automaticamente do que segue, sem intervenção do usuário:

• Token de acesso: é gerado com o Client ID e o Client Secret, vale 24 horas e fica guardado na autenticação. Um novo é solicitado somente quando o anterior expira.
• Integration Key efetiva: no primeiro envio da filial, o PHERP valida a chave do contador na Domínio (o CNPJ da chave deve ser o da filial) e gera a chave efetiva usada nos envios, que fica guardada no parâmetro. Se o contador informar uma chave nova, a validação e a geração são refeitas no envio seguinte.

Homologação e produção: o endereço da API da Domínio é único e não é configurado no PHERP (o campo Ambiente da autenticação não altera o destino do envio). Quem define se os arquivos vão para homologação ou para produção é a chave de integração fornecida pelo contador.

BOX-e (Domínio Sistemas)

O BOX-e é um serviço opcional oferecido pela Domínio Sistemas – Thomson Reuters, destinado ao armazenamento em nuvem dos arquivos XML de documentos fiscais pelo período legal de até 5 anos.

A utilização do BOX-e não interfere no funcionamento da integração, nem altera o processo de envio ou validação dos documentos fiscais. Seu uso impacta exclusivamente a forma como os XMLs são armazenados após o processamento no ambiente da Domínio.

Quando habilitado, os documentos fiscais enviados pelo PHERP são armazenados no ambiente da Domínio. Caso não esteja habilitado, os XMLs são apenas processados pela Domínio. O painel de cada registro informa se o arquivo foi enviado ao BOX-e.

A definição do uso do BOX-e é realizada conforme contrato do contador com a Domínio Sistemas e refletida no parâmetro BOX-e de cada filial.

Tela Integração Domínio

A tela lista os documentos e as baixas do período escolhido, com a situação de cada um, e é a partir dela que o usuário envia e acompanha a integração.

Período

O período fica no canto esquerdo do cabeçalho. Por padrão é o mês atual, e pode ser trocado por Este mês, Mês anterior, Últimos 7 dias, Hoje, Tudo ou por um intervalo escolhido no calendário (clicando no primeiro e no último dia). O calendário marca os dias que têm registros e os dias com erro.

O período define apenas o que aparece na lista, não o que é enviado. Cada período lista até 2.000 documentos e 2.000 baixas.

Lista

A lista mostra todos os documentos e baixas que podem ser integrados no período, inclusive os que ainda não foram enviados. As colunas são:

• Situação: em que ponto está a integração do registro
• Tipo: Nota (Entrada ou Saída) ou Baixa (Recebimento ou Pagamento)
• Documento: sigla e número do documento e, nas baixas, o número da parcela
• Filial e Pessoa (cliente ou fornecedor)
• Data: emissão do documento ou, nas baixas, data do pagamento
• Valor
• Enviado em: data e hora do envio
• Retorno da Domínio: último retorno recebido

Envio

Somente o que está marcado é enviado. Os registros são marcados pelas caixas de seleção (a caixa do cabeçalho marca todos os da lista e Shift + clique marca um intervalo). Ao marcar, a barra inferior mostra a quantidade de marcados, quantas notas e baixas, o valor total, quantos serão enviados e os botões Limpar, Consultar situação e Enviar.

• Podem ser enviados os registros A enviar e os que estão com Erro (reenvio). Registros já enviados não são enviados novamente: ficam de fora do envio e só podem ser consultados.
• Registros de uma filial que ainda não tem a chave do contador e a autenticação configuradas também ficam de fora. Nesse caso a tela exibe um aviso com o botão Abrir parâmetros.
• O envio é feito registro a registro e pode levar alguns minutos, conforme a quantidade. Ao final, a tela informa quantos registros foram enviados, quantos tiveram erro e a mensagem de cada erro.

Painel do registro

Ao clicar em uma linha, abre à direita o painel do registro, com a situação, a data de emissão (ou de pagamento, nas baixas), a filial, o valor (e os juros, nas baixas), a identificação do lote na Domínio, o usuário que enviou, se o arquivo foi enviado ao BOX-e, o histórico com as mensagens recebidas da Domínio (com data e hora) e o arquivo que foi, ou será, enviado. Pelo painel também é possível Enviar ou Reenviar, Consultar situação e Baixar XML do registro.

Situações da Integração

Situação	Significado
A enviar	Documento ou baixa elegível que ainda não foi enviado
Aguardando a Domínio	Arquivo recebido pela Domínio e aguardando processamento. Use Consultar situação para atualizar
Processado	Arquivo importado na escrita fiscal
Armazenado na API	Arquivo armazenado pela API da Domínio, que ainda vai importá-lo
Processado (fora do BOX-e)	Arquivo importado, mas que não será enviado ao BOX-e
Erro	Falha no envio ou rejeição pela Domínio. A mensagem fica no histórico e o registro pode ser enviado novamente

Consulta da situação

Depois do envio, a Domínio processa o arquivo e o registro pode ficar Aguardando a Domínio. O botão Consultar situação (na barra inferior ou no painel do registro) consulta o retorno da Domínio e atualiza a situação e o histórico dos registros marcados. Podem ser consultados os registros Aguardando a Domínio, Armazenado na API e Processado.

Fluxo de Processamento

Para cada documento ou baixa marcado, o PHERP executa o seguinte fluxo:

1. Inicia uma transação
2. Cria o registro de controle da integração (no reenvio de um registro com erro, o registro e o histórico existentes são reaproveitados)
3. Prepara a autenticação da filial: token de acesso e Integration Key efetiva
4. Envia o arquivo (XML do documento ou XML da baixa) à Domínio
5. Grava o retorno: situação, identificação do lote na Domínio e BOX-e
6. Registra no histórico a mensagem de sucesso ou de erro
7. Confirma a transação, gravando também o erro, quando houver

Cada registro é tratado de forma individual.

Auditoria e Controle

Todas as integrações realizadas ficam registradas, permitindo:

• Identificação do documento ou da baixa integrados
• Data e hora do envio e usuário que enviou
• Situação da integração e identificação do lote na Domínio
• Histórico de mensagens e erros, com data e hora de cada retorno
• Arquivo enviado, que pode ser visualizado e baixado (XML)

Esses dados garantem total rastreabilidade do processo.

Execução da Integração

A execução da integração com o Domínio é realizada exclusivamente de forma manual, mediante ação do usuário autorizado na tela Integração Domínio.

O envio é sempre feito pelos registros marcados: o período serve apenas para escolher o que aparece na lista e não existe envio por período. Para enviar tudo o que está na lista, basta marcar todos pela caixa do cabeçalho.

A cada execução, os registros são avaliados individualmente, respeitando os critérios de seleção e evitando o reenvio de documentos e baixas já integrados.

Dúvidas Frequentes

A baixa não aparece na lista. Confira se o documento gera contas a receber ou a pagar, se o tipo do documento é de venda ou de compra, se o lançamento de tesouraria está confirmado e se o período da tela inclui a data de emissão do documento (e não a da baixa).

Posso enviar a baixa de um documento que já foi enviado? Sim. Documento e baixa são envios independentes, e a baixa deve ser enviada depois do documento.

Posso enviar de novo um registro já processado? Não. Somente os registros A enviar ou com Erro podem ser enviados.

Uma filial aparece sem poder enviar. Cadastre ou complete o parâmetro da filial, informando a autenticação e a Integration Key do contador.

Assuntos Relacionados

Integrações

PHSYS API

Servidor de Aplicação