API Reference
Log In
API Reference

Serviços AT (Autoridade Tributária)

Serviços AT (Autoridade Tributária)

Serviços de integração com a Autoridade Tributária Portuguesa.

AT-Aggregator (Autoridade Tributária Agregador)

serviceName: at-aggregator

Retrieve information about the current alerts, interactions and the integrated position from Autoridade Tributária

Request Example

{
  "serviceName": "at-aggregator",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "test",
      "password": "test"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "<value>",
    "Posicao Integrada": [
      {
        "title": "Patrimonio",
        "status": "amarelo"
      },
      {
        "title": "IRS",
        "status": "vermelho"
      },
      {
        "title": "IVA",
        "status": "amarelo"
      }
    ],
    "Alertas": [
      {
        "descriptionName": "IRC",
        "description": "<description>",
        "limitDate": "2023-10-26"
      },
      {
        "descriptionName": "IUC",
        "description": "<description>",
        "limitDate": "2023-10-12"
      },
      {
        "descriptionName": "IVA",
        "description": "<description>",
        "limitDate": "2023-10-05"
      },
      {
        "descriptionName": "IMI",
        "description": "<description>",
        "limitDate": "2023-10-03"
      }
    ],
    "Interacoes": [
      {
        "tax": "IRS",
        "description": "Entrega da declaração",
        "date": "2023-10-22"
      }
    ]
  }
}

AT-Alerts (Autoridade Tributária Alertas)

serviceName: at-alert

Endpoint to retrieve the list of alerts in Autoridade Tributária.

Request Example

{
  "serviceName": "at-alert",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "extractData"
    }
  }
}

Response Example

{
  "data": {
    "requestId": "<value>",
    "alerts": [
      {
        "descriptionName": "IRC",
        "description": "Data limite para entrega da declaração Modelo 23 de IRC relativo a 2023",
        "limitDate": "2023-10-05"
      }
    ]
  }
}

AT-Divida (Autoridade Tributária Dívida/Não Dívida

serviceName: at-divida

Endpoint to retrieve the document "Dívida/Não Dívida" from Autoridade Tributária

Request Example

{
  "serviceName": "at-divida",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "notFound"
    }
  }
}

Response Example

{
  "data": {
    "requestId": ""
  },
  "file": "<base64EncodedFile>"
}

AT-Interações (Autoridade Tributária - Interações)

serviceName: at-interacoes

Endpoint to retrieve list of "Interações" present in Autoridade Tributária

Request Example

{
  "serviceName": "at-interacoes",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "test",
      "password": "test"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "<value>",
    "Interacoes": [
      {
        "tax": "IRS",
        "description": "Entrega da declaração",
        "date": "2023-10-22"
      }
    ]
  }
}

AT-IRC (Autoridade Tributária-Imposto Sobre o Rendimento)

serviceName: at-irc

Endpoint to retrieve the list of IRC (Imposto sobre o Rendimento das Pessoas Coletivas) in Autoridade Tributária.

Request Example

{
  "serviceName": "at-irc",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "reachAuthentication"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "",
    "alert": "Está a decorrer até 2023-02-31 o prazo de entrega da declaração modelo 22 IRC para 2022",
    "list": [
      {
        "year": "2022",
        "situation": "NAO LIQUIDAVEL",
        "date": "2023-03-04"
      },
      {
        "year": "2021",
        "situation": "LIQUIDAVEL",
        "date": "2022-03-07"
      },
      {
        "year": "2020",
        "situation": "LIQUIDAVEL",
        "date": "2021-12-01"
      },
      {
        "year": "2019",
        "situation": "LIQUIDAVEL",
        "date": "2020-01-31"
      }
    ]
  }
}

AT-IVA- SA (Autoridade Tributária-IVA Situação Atual)

serviceName: at-iva-sa

Endpoint to retrieve the list of IVA (Imposto sobre Valor Acrescentado Situação Atual) in Autoridade Tributária.

Request Example

{
  "serviceName": "at-iva-sa",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "loginTimeout"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "",
    "ivaList": {
      "2019": [
        {
          "periodo": "1901",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1902",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "0"
        },
        {
          "periodo": "1903",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1904",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "0"
        },
        {
          "periodo": "1905",
          "entregues": "0",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "1",
          "declaracaoRecapit": "0"
        },
        {
          "periodo": "1906",
          "entregues": "0",
          "emFalta": "1",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1907",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "1",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1908",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1909",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1910",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1911",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "1912",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "1",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "1",
          "declaracaoRecapit": "0"
        }
      ],
      "2023": [
        {
          "periodo": "2301",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "1",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        },
        {
          "periodo": "2302",
          "entregues": "0",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "0"
        },
        {
          "periodo": "2303",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "0",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "0"
        },
        {
          "periodo": "2304",
          "entregues": "1",
          "emFalta": "0",
          "reembolsoPedido": "1",
          "reembolsoEmAnalise": "-",
          "reembolsoDeferido": "0",
          "declaracaoRecapit": "1"
        }
      ]
    }
  }
}

AT-IVA-Enquadramento (Autoridade Tributária Enquadramento do IVA)

serviceName: at-iva-enquadramento

Endpoint to retrieve the list of IVA (Imposto sobre Valor Acrescentado Enquadramento) in Autoridade Tributária.

Request Example

{
  "serviceName": "at-iva-enquadramento",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "invalidCredentials"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "<value>",
    "enquadramento": "Normal Mensal",
    "dataDeEnquadramento": "2003-12-01",
    "situacao": "Enquadramento em vigor",
    "dataDeCessao": "-",
    "motivoDeCessao": "-",
    "nifDaCaessao": "-",
    "nomeDoCessionario": null,
    "atividadeConstante": "NÃO",
    "descricao": "-",
    "tipoOperacoes": "Que conferem direito à dedução",
    "proRataDeducaoIva": "2%",
    "transacaoIntracomunitariasBens": "-",
    "opcaoRenuncia": "NÃO",
    "opcaoRegime": "-",
    "opcaoPeriodicidade": "NÃO",
    "prestacao": "SIM",
    "importacoes": "NAO",
    "exportacoes": "SIM",
    "aquisicoes": "NAO",
    "trasnmissoes": "SIM",
    "reembolsoSituacao": "-",
    "reembolsoDataInicio": "-",
    "reembolsoDataFim": "-",
    "ivaDataInicio": "-",
    "ivaDataFim": "-",
    "ivaMotivo": "-",
    "importacoesDataInicio": "-",
    "importacoesDataFim": "-",
    "importacoesMotivo": "-",
    "forfetarioDataInicio": "-",
    "forfetarioDataFim": "-",
    "forfetarioMotivo": "-"
  }
}

AT-IVA-DP (Autoridade Tributária IVA Declarações Periódicas)

serviceName: at-iva-dp

Endpoint to retrieve the list of IVA (Imposto sobre Valor Acrescentado Declaração periódica) in Autoridade Tributária.

Request Example

{
  "serviceName": "at-iva-dp",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "loginTimeout"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "<value>",
    "results": "30",
    "totalPages": 2,
    "atIvaList": [
      {
        "declaracao": "1112342680",
        "vigente": "Sim",
        "periodo": "2302",
        "estado": "Liquidável",
        "dataSub": "2023-04-03",
        "valor": "null"
      },
      {
        "declaracao": "0987657520",
        "vigente": "Sim",
        "periodo": "2301",
        "estado": "Liquidada",
        "dataSub": "2023-03-02",
        "valor": "-1.000,00"
      },
      {
        "declaracao": "119876546",
        "vigente": "Sim",
        "periodo": "2212",
        "estado": "Liquidada",
        "dataSub": "2023-02-06",
        "valor": "null"
      },
      {
        "declaracao": "1876543887",
        "vigente": "Sim",
        "periodo": "2211",
        "estado": "Liquidada",
        "dataSub": "2022-12-29",
        "valor": "-1.000,00"
      },
      {
        "declaracao": "23456780028",
        "vigente": "Sim",
        "periodo": "2209",
        "estado": "Liquidada",
        "dataSub": "2022-11-04",
        "valor": "-10.000,00"
      },
      {
        "declaracao": "1127654",
        "vigente": "Sim",
        "periodo": "2208",
        "estado": "Liquidada",
        "dataSub": "2022-10-11",
        "valor": "-1.000,00"
      },
      {
        "declaracao": "1234567890",
        "vigente": "Sim",
        "periodo": "2207",
        "estado": "Liquidada",
        "dataSub": "2022-09-01",
        "valor": "null"
      },
      {
        "declaracao": "11237098765435",
        "vigente": "Sim",
        "periodo": "2206",
        "estado": "Liquidada",
        "dataSub": "2022-08-10",
        "valor": "null"
      },
      {
        "declaracao": "112373076500",
        "vigente": "Sim",
        "periodo": "2205",
        "estado": "Liquidada",
        "dataSub": "2022-07-08",
        "valor": "-1.000,00"
      },
      {
        "declaracao": "198765400420",
        "vigente": "Sim",
        "periodo": "2203",
        "estado": "Liquidada",
        "dataSub": "2022-05-09",
        "valor": "null"
      },
      {
        "declaracao": "112362495078",
        "vigente": "Sim",
        "periodo": "2202",
        "estado": "Liquidada",
        "dataSub": "2022-04-08",
        "valor": "null"
      },
      {
        "declaracao": "11237098765412",
        "vigente": "Sim",
        "periodo": "2201",
        "estado": "Liquidada",
        "dataSub": "2022-03-09",
        "valor": "-1.000,00"
      },
      {
        "declaracao": "11237098765413",
        "vigente": "Sim",
        "periodo": "2302",
        "estado": "Liquidável",
        "dataSub": "2023-04-03",
        "valor": "null"
      },
      {
        "declaracao": "11237098765414",
        "vigente": "Sim",
        "periodo": "2301",
        "estado": "Liquidada",
        "dataSub": "2023-03-02",
        "valor": "-8.355,95"
      }
    ]
  }
}

AT-PI (Autoridade Tributária Posição Integrada)

serviceName: at-pi

Endpoint to retrieve the values corresponding to Posição Integrada in Autoridade Tributária.

Request Example

{
  "serviceName": "at-pi",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "<user>",
      "password": "failedLogin"
    }
  }
}

Response Example

{
  "data": {
    "RequestId": "<value>",
    "atpiList": [
      {
        "title": "Património",
        "status": "vermelho"
      },
      {
        "title": "IRC",
        "status": "amarelo"
      },
      {
        "title": "IVA",
        "status": "verde"
      },
      {
        "title": "IUC",
        "status": "amarelo"
      }
    ]
  }
}

CP (Caderneta Predial)

serviceName: at-docs

The building book is a document that contains all relevant information about the property. This endpoint retrieves this document in an encoded base64 pdf.

Response Example

{
  "data": {
    "requestId": ""
  },
  "file": "<base64EncodedFile>"
}

Tax Registration Status Service

serviceName: tax-registration-status

This service retrieves the tax registration status of a given NIF (Número de Identificação Fiscal) from the Portuguese Tax Authority (AT) portal.

Request

Called via the request-orchestrator:

{
  "serviceName": "tax-registration-status",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "nif": "509442015",
      "pdfRequest": true
    }
  }
}

Response Example

{
  "data": {
    "requestid": "abc-456",
    "nif": "509442015",
    "name": "EMPRESA EXEMPLO LDA",
    "cod_financas": "3850",
    "desc_financas": "SERVIÇO FINANÇAS DE COIMBRA - 1",
    "act_css_iva": "2020-12-31",
    "act_css_irs": "2020-12-31",
    "inclusion_iva": null,
    "situation": null,
    "activity_message": null,
    "dataUpdatedTime": "2026-03-06T14:30:00",
    "entityWithRegisteredActivity": true,
    "entitySituationIsActive": false
  },
  "file": "JVBERi0xLjQKJeLj..."
}

Updated 7 months ago

Did this page help you?

Updated 7 months ago

Did this page help you?