# Planejando sua integração

Source: https://developer.avalara.com/invoice_goods_pt/como_comecar/planejando_sua_integracao/

# Planejando sua integração

Esta seção fornece uma visão geral dos requisitos do selo **Mensageria de Mercadorias** necessário para se tornar um parceiro certificado. Revise esta seção para ajudá-lo a planejar sua integração.

**Aviso:** Antes de iniciar a sua integração, é importante definir o tipo de operação principal e o tipo de uso coberto durante o programa de certificação.

Telas administrativas e melhores práticas

A tabela abaixo apresenta uma lista de requisitos que abrangem, desde a experiência do usuário, até as melhores práticas recomendadas da aplicação.

**Obrigatório/ Sugerido**

**Requerimentos**

**Notas**

**Nível**

Obrigatório

Tela de configuração

De acordo com as melhores práticas, é desejável ter uma tela de configurações para as credenciais, conforme listado abaixo:

-   Token ID do cliente
-   Secret Token

UI

Obrigatório

Teste de autenticação de conexão - Serviço Health (PING)

Existe um método disponível para verificação de estabilidade do serviço/PING

UI

Obrigatório

Habilitar/Desabilitar a utilização dos serviços

O usuário poderá habilitar/desabilitar os serviços AvaTax a qualquer momento. É indicada a criação de uma flag para operacionalizar isso

UI

Obrigatório

Serviços de Log Compreensivos

Dado que todas as transações são baseadas em solicitação e resposta de JSON, os parceiros deverão providenciar logs dessas transações, caso seja necessário a verificação de dados ou cálculos. Fica a critério do parceiro definir o tempo de permanência desses dados no sistema

UI

Obrigatório

Selecionar opções de ambiente

Fornecer opção de ambiente para permitir que o usuário-chave possa alternar entre os ambientes de sandbox e ambiente de produção

UI

Sugerido

Painel de Controle de Nota Fiscal Eletronica

Disponibilizar um cockpit de controle de emissão de nota fiscal eletrônica, que permita ao cliente consultar se a nota fiscal eletrônica foi autorizada, ou rejeitada, e ainda, cancelar, realizar carta de correção, ou inutilizar números, quando necessário. Este painel de controle deve fornecer qualquer outra funcionalidade que seja exigida pelo FISCO no que tange à funcionalidades de mensageria.

UI

Obrigatório

Verificação de ambiente

Disponibilizar evidências que demonstrem em qual ambiente (produção ou sandBox) o cliente/parceiro está operando.

UI

Sugerido

Configuração de Tempo de Expiração da Chamada

Configurar um tempo de expiração para cada chamada realizada pela API (timeout)

Configuração oculta

Obrigatório

API base URL

As URLs devem ser configuráveis

Configuração oculta

Obrigatório

Versão

Informar a compatibilidade da versão do ERP com o conector

Documentação

Obrigatório

Arquitetura

Fornecer informações sobre a arquitetura do conector, bem como os pré-requisitos necessários para seu funcionamento

Documentação

Transações de Nota Fiscal Eletronica (NF-e)

A tabela abaixo apresenta uma lista com as transações de Nota Fiscal Eletrônica (NF-e). 

**Obrigatório / Sugerido**

**Cenários**

**Transações**

**Ponto de Atenção**

Sugerido 

Exportação de Mercadoria

Venda

Obrigatório 

Carta de Correção

Venda

Sugerido 

Devolução de venda de um produto de produção do próprio  estabelimento

Devolução de venda

\- Marcação específica com motivo e justificativa para a devolução do IPI

\- Nota fiscal eletrônica de referência

Obrigatório 

Casos de venda para um orgão público estadual.

Venda

Marcação específica com motivo e justificativa para a desoneração do ICMS

Obrigatório 

Venda de produção do estabelecimento com mercadoria que esteja sujeita a ST pelo modelo de Pauta

Venda

Preço de varejo estatutário MVA

Obrigatório 

Contingência

Venda

Verificar a chave de acesso que muda em caso de contingência

Obrigatório 

Operação de Cancelamento

Venda

Obrigatório 

Nota Fiscal Complementar de Venda

Venda

Fatura Eletrônica de Referência

Obrigatório 

Inutilização de Números

Venda

Sugerido 

Venda interestadual para não contribuinte

Venda

Dados de objetos específicos relacionados ao DIFAL (Diferencial de Alíquota do ICMS)

Sugerido 

Compra de um ativo fixo para apoio a manufatura

Venda

Atenção ao campo com a isenção de ICMS

Sugerido 

Importação de Mercadoria

Compra

\- Unidade de medida COMEX

\- Atributos específicos para DI (Declaração de Importação)

\- Identificação do fornecedor do Exterior

[Anterior](/invoice_goods_pt/como_comecar/sobre_o_programa)

[Próxima](/invoice_goods_pt/como_comecar/recursos/recursos_adicionais/doc_api)