post https://apigwws.bizapis.com/v2/documents/at-alert
Endpoint to retrieve the list of alerts in Autoridade Tributária.
JSON Schema API Response
{
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Identificador único do pedido."
},
"alerts" : {
"type" : "array",
"description" : "Lista de alertas emitidos pela Autoridade Tributária. Pode incluir prazos de pagamento, avisos de irregularidades ou necessidade de submissão de declarações.",
"items" : {
"type" : "object",
"properties" : {
"descriptionName" : {
"type" : "string",
"description" : "O nome ou categoria do alerta."
},
"description" : {
"type" : "string",
"description" : "Uma explicação detalhada sobre o alerta."
},
"limitDate" : {
"type" : "string",
"description" : "O prazo ou data em que a ação associada ao alerta deve ser concluída, no formato 'YYYY-MM-DD'."
}
}
}
}
}
}
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier for the request."
},
"alerts": {
"type": "array",
"description": "List of alerts issued by the Tax Authority. This may include payment deadlines, notices of irregularities, or the need for declaration submissions.",
"items": {
"type": "object",
"properties": {
"descriptionName": {
"type": "string",
"description": "The name or category of the alert."
},
"description": {
"type": "string",
"description": "A detailed explanation about the alert."
},
"limitDate": {
"type": "string",
"description": "The deadline or date by which the action associated with the alert must be completed, in the format 'YYYY-MM-DD'."
}
}
}
}
}
}