Serviços Eletrónicos (APIs)
A Plataforma Eletrónica suporta vários serviços eletrónicos que permitam aos sistemas dos contribuintes interagirem com a plataforma. Os endpoints dos serviços seguem o seguinte formato:
https://services.efatura.cv/version/resource
Onde version (exemplo: v1) é a versão do endpoint e resource o nome do recurso que o sistema cliente pretende interagir com. Todos os endpoints são implementados de acordo com a tecnologias REST em HTTP.
Lista de Serviços Eletrónicos| Resource | Descrição |
|---|---|
| dfes | Recurso para pesquisar/emitir DFEs. |
| leds | Recurso para pesquisar/registar/editar DFEs. |
Emissão de DFEs
Para emitir DFEs, o sistema do contribuinte deve gerar os ficheiros XML seguindo as estruturas e regras de cada DFE, incluir os XML num ficheiro ZIP comprimido com o algoritmo Deflate e depois fazer um POST HTTP no endpoint do recurso dfes.
O nome dos ficheiros XML dentro do ZIP deve ser o IUD do DFE.
O diagrama a seguir ilustra o processo de emissão de DFEs.
Resposta do Serviço
Download de DFEs
Este serviço permite o download de DFEs emitidos pelo contribuinte ou que o contribuinte consta como destinatário.
| Parâmetro Query String | Descrição |
|---|---|
| IssueDateStart | Data inicial de emissão de DFEs |
| IssueDateEnd | Data final de emissão de DFEs |
| SupplierTaxID | NIF do emissor de DFEs |
Resposta do Serviço
Se o download for de um DFE único através de um IUD https://services.efatura.cv/v1/dfes/IUD a resposta pode ser negociada para ser um XML ou ZIP.
Se o download for de vários DFEs https://services.efatura.cv/v1/dfes, a resposta será um ficheiro ZIP.