AT-PAYREF-IRC (Autoridade Tributária Referencia de Pagamento IRC)

Retrieve pay references for IRC

JSON Schema for API Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AtPayrefIrcResponse",
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "TaxSelfAssessmentList": {
      "type": "array",
      "description": "List of tax self assessments.",
      "items": {
        "type": "object",
        "properties": {
          "declarationId": {
            "type": "string",
            "description": "Declaration Identification"
          },
          "periodYear": {
            "type": "string",
            "description": "Year of the Period"
          },
          "documentId": {
            "type": "string",
            "description": "Document Identification"
          },
          "fiscalId": {
            "type": "string",
            "description": "Fiscal Identification"
          },
          "amountToPay": {
            "type": "number",
            "description": "Amount to Pay"
          },
          "paymentReference": {
            "type": "string",
            "description": "Payment Reference"
          },
          "paymentCertification": {
            "type": "string",
            "description": "Payment Certification"
          }
        },
        "required": []
      }
    }
  },
  "required": []
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AtPayrefIrcResponse",
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Identificador único do pedido."
    },
    "TaxSelfAssessmentList": {
      "type": "array",
      "description": "Lista de declarações de autoavaliação fiscal.",
      "items": {
        "type": "object",
        "properties": {
          "declarationId": {
            "type": "string",
            "description": "Identificação da declaração"
          },
          "periodYear": {
            "type": "string",
            "description": "Ano do período fiscal"
          },
          "documentId": {
            "type": "string",
            "description": "Identificação do documento"
          },
          "fiscalId": {
            "type": "string",
            "description": "Número de identificação fiscal do contribuinte"
          },
          "amountToPay": {
            "type": "number",
            "description": "Montante a pagar"
          },
          "paymentReference": {
            "type": "string",
            "description": "Referência para pagamento"
          },
          "paymentCertification": {
            "type": "string",
            "description": "Código de certificação do pagamento"
          }
        },
        "required": []
      }
    }
  },
  "required": []
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!