Referência
Ficheiros fiscais
Os ficheiros que a empresa entrega à administração fiscal (SAF-T de facturação, de compras e de inventário) e a prova de integridade da cadeia de assinaturas.
Os ficheiros que a empresa entrega à administração fiscal (SAF-T de facturação, de compras e de inventário) e a prova de integridade da cadeia de assinaturas.
| Operação | O que faz |
|---|---|
GET /api/saft | O ficheiro SAF-T(AO) de facturação de um estabelecimento, num período. |
GET /api/saft/cadeia-assinaturas | Reverifica a cadeia de assinaturas de um tipo de documento: a prova de que nenhum documento foi alterado, retirado ou inserido. |
GET /api/saft/compras | O SAF-T(AO) de aquisição de bens e serviços (compras) de um mês. |
GET /api/saft/compras/resumo | A pré-visualização do SAF-T de compras de um mês: totais, fornecedores e avisos. |
GET /api/saft/inventario | O ficheiro de inventário (existências a 31 de Dezembro) de um exercício. |
GET /api/saft/inventario/resumo | A pré-visualização do inventário de um exercício: linhas, valor total e avisos. |
/api/saft#O ficheiro SAF-T(AO) de facturação de um estabelecimento, num período.
dataInicio e dataFim são obrigatórias; lojaId é obrigatório quando a empresa tem mais do que um estabelecimento. Conta como um pedido pesado.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
dataInicio | na pesquisa | data (AAAA-MM-DD) | sim |
dataFim | na pesquisa | data (AAAA-MM-DD) | sim |
lojaId | na pesquisa | identificador (UUID) |
Resposta
Devolve 200 com o ficheiro XML (application/xml).
Pedido
curl 'https://<endereço-da-API>/api/saft' \
-H 'X-Api-Key: <a-sua-chave>'/api/saft/cadeia-assinaturas#Reverifica a cadeia de assinaturas de um tipo de documento: a prova de que nenhum documento foi alterado, retirado ou inserido.
Só lê. Com ano verifica esse ano; sem ele, a série inteira.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
tipoDocumentoId | na pesquisa | identificador (UUID) | sim |
lojaId | na pesquisa | identificador (UUID) | |
ano | na pesquisa | número inteiro |
Resposta (200 · JSON)
| Campo | Tipo | Significado |
|---|---|---|
lojaId | identificador (UUID) | O estabelecimento. |
tipoDocumentoId | identificador (UUID) | O tipo do documento (ver /api/documentos/tipos). |
sigla | texto | |
ano | número inteiro ou nulo | |
totalDocumentos | número inteiro | |
assinaturasVerificadas | número inteiro | |
assinaturasNaoVerificaveis | número inteiro | |
integra | verdadeiro/falso | |
problemas | lista de objectos | |
problemas[].gravidade | texto | |
problemas[].codigo | texto | O código curto. |
problemas[].sequencial | número inteiro | |
problemas[].numero | texto | O número legível, atribuído pelo servidor («FR LC2026/25»). |
problemas[].documentoId | identificador (UUID) ou nulo | |
problemas[].descricao | texto | A descrição. |
problemasTruncados | verdadeiro/falso |
Pedido
curl 'https://<endereço-da-API>/api/saft/cadeia-assinaturas' \
-H 'X-Api-Key: <a-sua-chave>'/api/saft/compras#O SAF-T(AO) de aquisição de bens e serviços (compras) de um mês.
periodo no formato AAAA-MM.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
periodo | na pesquisa | texto | sim |
Resposta
Devolve 200 com o ficheiro XML (application/xml).
Pedido
curl 'https://<endereço-da-API>/api/saft/compras' \
-H 'X-Api-Key: <a-sua-chave>'/api/saft/compras/resumo#A pré-visualização do SAF-T de compras de um mês: totais, fornecedores e avisos.
periodo no formato AAAA-MM.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
periodo | na pesquisa | texto | sim |
Resposta (200 · JSON)
| Campo | Tipo | Significado |
|---|---|---|
nifContribuinte | texto | |
periodo | texto | |
linhas | lista de objectos | |
linhas[].tipo | texto | |
linhas[].data | data (AAAA-MM-DD) | A data e hora (UTC). |
linhas[].numeroDocumento | texto | |
linhas[].fornecedorNif | texto | |
linhas[].fornecedorNome | texto | |
linhas[].valorTotal | número | |
linhas[].iva | número | |
linhas[].natureza | texto ou nulo | |
linhas[].percentagemDedutivel | número ou nulo | |
linhas[].ivaDedutivel | número ou nulo | |
fornecedores | número inteiro | |
totalValor | número | |
totalIva | número | |
totalIvaDedutivel | número | |
perguntasPorConfirmar | lista de texto | |
avisos | lista de texto |
Pedido
curl 'https://<endereço-da-API>/api/saft/compras/resumo' \
-H 'X-Api-Key: <a-sua-chave>'/api/saft/inventario#O ficheiro de inventário (existências a 31 de Dezembro) de um exercício.
anoFiscal é o exercício a que o inventário se refere. formato é Xml (por omissão), Json ou Excel.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
anoFiscal | na pesquisa | número inteiro | sim |
formato | na pesquisa | uma de: «Xml», «Json», «Excel» |
Resposta
Devolve 200 com o ficheiro no formato pedido.
Pedido
curl 'https://<endereço-da-API>/api/saft/inventario' \
-H 'X-Api-Key: <a-sua-chave>'/api/saft/inventario/resumo#A pré-visualização do inventário de um exercício: linhas, valor total e avisos.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
anoFiscal | na pesquisa | número inteiro | sim |
Resposta (200 · JSON)
| Campo | Tipo | Significado |
|---|---|---|
anoFiscal | número inteiro | |
dataReferencia | data (AAAA-MM-DD) | |
nif | texto | |
semOperacoes | verdadeiro/falso | |
linhas | lista de objectos | |
linhas[].tipo | texto | |
linhas[].productCode | texto | |
linhas[].productDescription | texto | |
linhas[].quantity | número | |
linhas[].unitOfMeasure | texto | |
linhas[].valor | número | O valor. |
totalValor | número | |
avisos | lista de texto |
Pedido
curl 'https://<endereço-da-API>/api/saft/inventario/resumo' \
-H 'X-Api-Key: <a-sua-chave>'