O weoInvoice é um sistema de faturação online certificado pela Autoridade Tributária e Aduaneira, utilizado por empresas de diferentes dimensões e setores em Portugal. A weoAPI é a solução que permite a sistemas terceiros — plataformas de e-commerce, ERPs, CRMs ou aplicações desenvolvidas à medida — comunicar diretamente com o weoInvoice, sem intervenção manual.
Através de um webservice com métodos normalizados, a weoAPI disponibiliza, num formato standard, uma plataforma de comunicação bem definida com o weoInvoice, permitindo tanto adicionar como obter informação de qualquer um dos elementos de conta existentes no sistema — clientes, documentos e respetivos pagamentos.
O objetivo desta proposta é apresentar o âmbito funcional, as condições comerciais e contratuais da weoAPI, para que a integração possa avançar de forma clara, segura e alinhada com os requisitos do parceiro.
A weoAPI tem como propósito alargar a utilização do weoInvoice a um âmbito de maior dimensão, permitindo a sua integração em sistemas terceiros e garantindo, acima de tudo, a qualidade e a integridade dos dados transferidos entre plataformas.
Com esta integração, o parceiro passa a poder automatizar a criação e gestão de clientes, a emissão de documentos comerciais e o respetivo processamento de pagamentos diretamente a partir do seu próprio sistema, mantendo toda a informação sincronizada com o weoInvoice em tempo real.
A weoAPI assenta num webservice SOAP, descrito por um documento WSDL público, garantindo compatibilidade com a generalidade das linguagens e plataformas de integração utilizadas pelos parceiros.
| Aspeto | Descrição |
|---|---|
| Protocolo | Webservice SOAP/WSDL, com definição pública dos métodos, parâmetros e tipos de dados. |
| Autenticação | Autenticação própria em cada chamada ao serviço, validando a identidade do parceiro em cada pedido. |
| Endpoint | Endpoint dedicado por parceiro, isolando o tráfego e os dados de cada integração. |
| Versionamento | Métodos e estruturas de dados são versionados, permitindo evoluir a API sem quebrar integrações já em produção. |
| Logging e auditoria | Todos os pedidos e respostas são registados, permitindo auditar e diagnosticar o comportamento da integração. |
A lista completa de códigos de resposta, bem como exemplos de pedidos e respostas para cada método, consta do manual técnico da weoAPI, disponibilizado à parte desta proposta.
A weoAPI consiste num webservice com métodos personalizados, entre os quais se destacam os seguintes:
| Método | Descrição |
|---|---|
| AddClient | Permite adicionar um cliente e toda a sua informação relevante. |
| UpdateClient | Permite alterar a informação relativa a um cliente já existente. |
| AddDocument | Permite adicionar um novo documento, definindo toda a informação nele presente — desde o cliente à informação de rodapé — incluindo produtos, serviços, preços, descontos e taxas de IVA aplicadas. Devolve o caminho para visualizar o documento recém-criado. |
| CancelDocument | Permite anular um documento existente. |
| PayDocument | Permite efetuar o pagamento parcial ou integral de faturas, com a emissão do respetivo recibo. |
| ListDocuments | Permite obter a listagem de documentos gerados com base num conjunto de critérios. |
Existem métodos adicionais que poderão ser disponibilizados, bem como outros que poderão vir a ser desenvolvidos à medida, mediante requisitos definidos pelo parceiro.
A integração é conduzida em fases, de forma a garantir que os dados são transferidos com qualidade e que o parceiro dispõe de tempo para testar a solução antes de a colocar em produção:
A documentação técnica detalhada — incluindo especificação dos métodos, formatos de pedido/resposta e exemplos práticos — é disponibilizada em manual técnico próprio, à parte desta proposta.
Cada conta criada através da weoAPI inclui, sem custo adicional:
Qualquer plano ou serviço adicional do weoInvoice pode ser acrescentado à conta; o respetivo custo, definido em www.weoinvoice.com, é independente do custo de utilização da weoAPI.
O custo de utilização da weoAPI é determinado do seguinte modo:
| Contas API | Custo por Documento Emitido (CDE) | Custo Mensal Mínimo (CMM) |
|---|---|---|
| 1 | 0,02 € | 20,00 € |
Valores sem IVA à taxa legal em vigor. Cada conta poderá ter utilizadores, faturas e volume de negócio ilimitados.
O weoInvoice é certificado pela Autoridade Tributária e Aduaneira, dispondo de mecanismos de comunicação fiscal como a exportação de SAF-T, e aplica os procedimentos de segurança adequados à proteção dos dados transferidos através da weoAPI. Esta base de certificação e conformidade é a mesma que suporta a utilização direta do weoInvoice, estendendo-se de forma consistente à integração realizada através da API.
Para avançar com a integração, ficamos disponíveis para agendar uma reunião de levantamento de requisitos e disponibilizar acesso a um ambiente de demonstração, acompanhado do respetivo manual técnico da weoAPI.
Agradecemos a atenção dispensada a esta proposta e ficamos ao dispor para quaisquer esclarecimentos adicionais.