Consultar Factura
Serviço destinado a obter os dados detalhados de uma factura electrónica emitida em nome do contribuinte, devolvendo em resposta o indicador de sucesso ou insucesso na obtenção da informação, bem como o detalhe da factura especificada na solicitação.
Características do Serviço
Endereço de homologação
Endereço de produção
Exemplo do Pedido(Payload)
{
"schemaVersion": "1.2",
"submissionUUID": "a1b2c3d4-e5f6-7890-g1h2-i238j234k5122",
"taxRegistrationNumber": "5001636863",
"submissionTimeStamp": "2025-09-02T14:30:00Z",
"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",
"invoiceNo": "FT FT6325S2C/1000020"
}
{
"taxRegistrationNumber": "...",
"documentNo": "..."
}
Payload de Saída(resposta)
{
"documentNo": "",
"documentStatus": "",
"document": "",
"documentStatusList": [""],
"errorList": [
{
"idError": "E93",
"descriptionError": "Documento desconhecido (FT FT6325S2C/1000020)"
}
]
}
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 da 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:
|
documentNo |
string |
“maxlength”: 60 |
Sim |
Identificador da factura electrónica que se pretende consultar. |
Parâmetros de Saída
| HTTP code | Tipo (JSON) | Descrição |
|---|---|---|
200 |
object statusResult |
Registo de pedido efectuado com sucesso sendo devolvido um object do tipo statusFEResult com os dados da factura pesquisada. |
400 |
array errorList |
Registo de pedido efectuado com erros, sendo devolvida uma lista de erros na recepção dos dados do pedido de registo dos documentos de facturação. |
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 “E93” - “documento desconhecido” |
Composição (properties) do object statusFEResult
| 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). |
validationStatus |
string |
“maxlength”: 1 |
Não |
Indicador de validação do documento de facturação solicitado, com os seguintes valores possíveis e significados:
Campo é de preenchimento obrigatório se, para o documento de facturação encontrada, não foi encontrado registo de anulação posterior. |
documents |
array |
N/A |
Sim |
Array com o(s) dado(s) da(s) factura(s) electrónica(s) – poderão ser encontrados mais que um resultado se a factura foi anulada após emitida (ver formato em 5.1.2.2) . |
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 |
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. |
FE-RNG-032 |
E40 |
Os dados constantes na assinatura da chamada do serviço “jwsSignature” não estão de acordo com a informação constante na chamada do serviço. |