Listar Facturas Electrónicas
Serviço destinado a obter a lista de facturas registadas em nome do contribuinte durante um determinado período, devolvendo em resposta a lista de facturas encontradas e respectivas datas de emissão.
Características do Serviço
Endereço de homologação
Endereço de produção
Payload de entrada para solicitar criação de série
{
"schemaVersion": "1.0",
"submissionGUID": "a1b2c3d4-e5f6-7890-g1h2-i2302832271",
"taxRegistrationNumber": "5406024493",
"submissionTimeStamp": "2025-09-19T07:41:54.473Z",
"softwareInfo": {
"softwareInfoDetail": {
"productId": "Meu ERP CERTO",
"productVersion": "1.0.1",
"softwareValidationNumber": "C_134"
},
"jwsSoftwareSignature": "eyJ0eXAiOiJKT1NFIiwiYWxnIjoiUlMyNTYifQ.eyJwcm9kdWN0SWQiOiJNZXUgRVJQIENFUlRPIiwicHJvZHVjdFZlcnNpb24iOiIxLjAuMSIsInNvZnR3YXJlVmFsaWRhdGlvbk51bWJlciI6IkNfMTM0In0.VE3zkvOJOpqBfz4wpx4KCgcwOGgzGUP3MSMbaHCDnHhwOaeA6jlccBW9HjgQvg2tYCVVq0imrU_z0grEHNthhG4xD3afSOD1_RzvHs8Tc45dvztHJzB4gF0CAX-yIDwi7XcHiMRY0vkXOETBeHKewg0ktWSnZ7SLf4GxGzE7ry2u_pmhqhCPhxpa0oGQ_rBJUYkEAFg1OwaqjwvzCFgdT11r-XsHmnkcfJX_ktj59RWR_zgbytiCRtwCK9LNUflveS5GzUaCXbPn2deQ3F2hPldLECEa_ahwoapoK1LhkgOAVyPLJf6M1Cm09Le7rkdSaWQSW5BI_sPx5YaUaXkeqg"
},
"jwsSignature": "string",
"queryStartDate": "2025-09-10",
"queryEndDate": "2025-09-20"
}
Parâmetros de entrada
| Campo | Tipo (JSON) | Atributos | Obrigatório | Descrição |
|---|---|---|---|---|
schemaVersion |
string |
N/A |
Sim |
Versão do schema do serviço, exemplo “1.0” |
taxRegistrationNumber |
string |
“maxlength”: 15 |
Sim |
Número fiscal de contribuinte. |
submissionTimeStamp |
string |
N/A |
Sim |
Timestamp de submissão do pedido no formato ISO 8601, exemplos:
|
softwareInfo |
object |
N/A |
Sim |
Objecto com os dados do Software de Facturação (ver formato em 5.1.2.1) |
jwsSignature |
string |
Tamanho variável em Base64URL (dependendo do tamanho da chave usada) |
Sim |
Assinatura digital da solicitação usando a chave privada do emissor através do algoritmo RS256 (RSA + SHA-256). Os campos a serem utilizados na assinatura são:
|
queryStartDate |
string |
“format”: “date” |
Sim |
Data inicial do período de pesquisa de facturas recebidas a pesquisar. |
queryEndDate |
string |
“format”: “date” |
Sim |
Data final do período de pesquisa de facturas recebidas a pesquisar. |
Parâmetros de Saída
| HTTP code | Tipo (JSON) | Descrição |
|---|---|---|
200 |
object documentListResult |
Registo de pedido efectuado com sucesso sendo devolvido um object do tipo documentListResult com os dados das facturas encontradas. |
422 |
Object errorEntry |
Chamada ocorreu com erro, sendo enviado uma mensagem (código e descrição) correspondente ao erro “E94” - “erro na chamada, NIF diferente” |
429 |
Object errorEntry |
Chamada ocorreu com erro, sendo enviado uma mensagem (código e descrição) correspondente ao erro “E98” - “erro na chamada, demasiadas solicitações repetidas” |
400 |
Object errorEntry |
Chamada ocorreu com erro, sendo enviado uma mensagem (código e descrição) correspondente ao erro “E96” - “solicitação mal efectuada – erro de estrutura” |
Composição (properties) do object documentListResult
| Campo | Tipo (JSON) | Atributos | Obrigatório | Descrição |
|---|---|---|---|---|
documentResultCount |
integer |
N/A |
Sim |
Número de facturas que foram encontradas para os critérios de pesquisa especificados. |
documentResultList |
array |
N/A |
Sim |
Dados (identificação e data de emissão) da factura electrónica encontrada para o período Array com a lista de dados de facturas (object documentResultList). |
Composição (properties) do array documentResultList
| Campo | Tipo (JSON) | Atributos | Obrigatório | Descrição |
|---|---|---|---|---|
documentNo |
string |
“maxlength”: 60 |
Sim |
Identificador da factura electrónica que se pretende consultar (enviado como parâmetro na chamada). |
documentDate |
string |
“format”: “date” |
Sim |
Data de emissão da factura electrónica encontrada |
Códigos e mensagens de erro no retorno do Serviço
Tendo em conta as regras de negócio, são propostos adicionalmente os seguintes erros de validação:
| Regra de negócio | Código de erro | Descrição de erro |
|---|---|---|
FE-RNG-010 |
E08 |
A assinatura do Produtor de Software “jwsSoftwareSignature” não está de acordo com a informação transmitida. |
FE-RNG-011 |
E31 |
Os dados constantes na assinatura do Produtor de Software “jwsSoftwareSignature” não estão de acordo com a informação constante na Certificação do Software. |
FE-RNG-032 |
E39 |
Os dados constantes na assinatura do Produtor de Software “jwsSoftwareSignature” não estão de acordo com a informação constante no processo de Certificação do Software. |