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

Retrieve payment references for IMI

JSON Schema for API Response

{
  "type" : "object",
  "properties" : {
    "message" : {
      "type" : "string",
      "description" : "Mensagem legível para humanos que fornece informações adicionais sobre a resposta, como detalhes de erro ou atualizações informativas de estado"
    },
    "data" : {
      "type" : "object",
      "properties" : {
        "requestId" : {
          "type" : "string",
          "description" : "Identificador único do pedido"
        },
        "paymentDocs" : {
          "type" : "array",
          "description" : "Lista de documentos de pagamento IMI",
          "items" : {
            "type" : "object",
            "properties" : {
              "documentId" : {
                "type" : "string",
                "description" : "Identificador único do documento"
              },
              "amount" : {
                "type" : "number",
                "description" : "Montante a pagar"
              },
              "paymentDueDate" : {
                "type" : "string",
                "description" : "Data limite para pagamento"
              },
              "situation" : {
                "type" : "string",
                "description" : "Situação ou estado da nota de cobrança"
              },
              "paymentReference" : {
                "type" : "string",
                "description" : "Referência de pagamento associada ao documento de pagamento"
              },
              "numberOfBuildings" : {
                "type" : "integer",
                "description" : "Número de edifícios associados à nota de cobrança"
              },
              "year" : {
                "type" : "string",
                "description" : "Ano da nota de cobrança"
              }
            }
          }
        }
{
  "type" : "object",
  "properties" : {
    "message" : {
      "type" : "string",
      "description" : "A human-readable message providing additional information about the response, such as error details or informative status updates"
    },
    "data" : {
      "type" : "object",
      "properties" : {
        "requestId" : {
          "type" : "string",
          "description" : "Unique identifier for the request"
        },
        "paymentDocs" : {
          "type" : "array",
          "description" : "List of IMI payment documents",
          "items" : {
            "type" : "object",
            "properties" : {
              "documentId" : {
                "type" : "string",
                "description" : "Unique identifier for the document"
              },
              "amount" : {
                "type" : "number",
                "description" : "Amount to Pay"
              },
              "paymentDueDate" : {
                "type" : "string",
                "description" : "Due date for the payment"
              },
              "situation" : {
                "type" : "string",
                "description" : "Situation or status of the billing note"
              },
              "paymentReference" : {
                "type" : "string",
                "description" : "Payment reference associated with the payment document"
              },
              "numberOfBuildings" : {
                "type" : "integer",
                "description" : "Number of buildings associated with the billing note"
              },
              "year" : {
                "type" : "string",
                "description" : "Year of the billing note"
              }
            }
          }
        }
      }
    }
  }
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!