Referência

Conformidade e facturação electrónica

O que a lei pede à empresa: a verificação da integridade das assinaturas, o dever de reporte das vendas a grosso e o estado da comunicação dos documentos à AGT (facturação electrónica). A adesão e as séries da facturação electrónica configuram-se só no ecrã, por uma pessoa.

Operação	O que faz
GET `/api/conformidade/integridade`	O estado da integridade das assinaturas da empresa: se a emissão está suspensa e porquê.
POST `/api/conformidade/integridade/verificar`	Verifica agora a integridade das assinaturas.
GET `/api/conformidade/dever-de-reporte`	O dever de reporte das vendas a grosso a pessoas singulares de valor elevado: o que há por reportar (DP 71/25, art. 15.º).
POST `/api/conformidade/dever-de-reporte/{documentoId}/reportada`	Marca um documento como já reportado.
GET `/api/facturacao-electronica/estado`	O estado da facturação electrónica da empresa.
GET `/api/facturacao-electronica/documentos`	Os documentos e o estado da sua comunicação à AGT.
GET `/api/facturacao-electronica/documentos/{documentoId}`	O estado da comunicação de um documento à AGT.
POST `/api/facturacao-electronica/comunicar`	Pede a comunicação imediata dos documentos pendentes à AGT (sem esperar pelo robô).

GET/api/conformidade/integridade#

O estado da integridade das assinaturas da empresa: se a emissão está suspensa e porquê.

Permissão Documentos.Ler

Uma falha de integridade confirmada suspende a emissão até haver relato técnico (DP 71/25, art. 22.º n.º 2 b e d).

Pedido

curl

curl 'https://<endereço-da-API>/api/conformidade/integridade' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/conformidade/integridade/verificar#

Verifica agora a integridade das assinaturas.

Permissão Saft.Exportar

Uma falha confirmada suspende a emissão.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/conformidade/integridade/verificar' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/conformidade/dever-de-reporte#

O dever de reporte das vendas a grosso a pessoas singulares de valor elevado: o que há por reportar (DP 71/25, art. 15.º).

Permissão Saft.Exportar

ano filtra por ano.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/conformidade/dever-de-reporte' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/conformidade/dever-de-reporte/{documentoId}/reportada#

Marca um documento como já reportado.

Permissão Saft.Exportar
Idempotência aceita Idempotency-Key

Parâmetros

Nome	Onde	Tipo	Obrigatório
`documentoId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON)

Campo	Tipo	Obrigatório
`referencia`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/conformidade/dever-de-reporte/<documentoId>/reportada' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/facturacao-electronica/estado#

O estado da facturação electrónica da empresa.

Permissão FacturacaoElectronica.Ler

Pedido

curl

curl 'https://<endereço-da-API>/api/facturacao-electronica/estado' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/facturacao-electronica/documentos#

Os documentos e o estado da sua comunicação à AGT.

Permissão FacturacaoElectronica.Ler

estado filtra.

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo
`estado`	na pesquisa	texto
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/facturacao-electronica/documentos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/facturacao-electronica/documentos/{documentoId}#

O estado da comunicação de um documento à AGT.

Permissão Documentos.Ler

Devolve 204 se o documento não se comunica à AGT.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`documentoId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/facturacao-electronica/documentos/<documentoId>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/facturacao-electronica/comunicar#

Pede a comunicação imediata dos documentos pendentes à AGT (sem esperar pelo robô).

Permissão FacturacaoElectronica.Editar

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/facturacao-electronica/comunicar' \
  -H 'X-Api-Key: <a-sua-chave>'