🚧
What's New in bizAPIs 3.0
Enhanced Error Responses with bizAPIs Status Codes
bizAPIs 3.0 introduces structured error responses with dedicated bizAPIs status codes, making debugging faster and support interactions more efficient. All error responses now include detailed metadata like requestId, errorCode, and errorName to help you quickly identify and resolve issues.
Availability by Environment
Environment Status
📚 Documentation ✅ Available
🧪 QUAL ✅ Available
🚀 Production ⏳ Coming Soon
Learn more about error handling →

💻

DOWNLOAD PROJECT

Java

Python

C#

To watch the video click here

JSON Schema API Response

{
  "type" : "object",
  "properties" : {
    "RequestId" : {
      "type" : "string",
      "description" : "Identificador único do pedido."
    },
    "alert" : {
      "type" : "string",
      "description" : "Mensagem de alerta emitida pela Autoridade Tributária. Pode incluir informações como prazos ou obrigações fiscais."
    },
    "list" : {
      "type" : "array",
      "description" : "Lista de registos fiscais relacionados com o Imposto sobre o Rendimento de Pessoas Coletivas (IRC), incluindo ano, situação e data.",
      "items" : {
        "type" : "object",
        "properties" : {
          "year" : {
            "type" : "string",
            "description" : "Ano em observação."
          },
          "situation" : {
            "type" : "string",
            "description" : "Situação fiscal para o ano especificado."
          },
          "date" : {
            "type" : "string",
            "description" : "Data em que a situação foi determinada ou registada, no formato 'YYYY-MM-DD'."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "alert": {
      "type": "string",
      "description": "Alert message issued by the Tax Authority. May include information such as deadlines or tax obligations."
    },
    "list": {
      "type": "array",
      "description": "List of tax records related to the Corporate Income Tax (IRC), including year, situation, and date.",
      "items": {
        "type": "object",
        "properties": {
          "year": {
            "type": "string",
            "description": "Year under observation."
          },
          "situation": {
            "type": "string",
            "description": "Tax situation for the specified year."
          },
          "date": {
            "type": "string",
            "description": "Date when the situation was determined or registered, in the format 'YYYY-MM-DD'."
          }
        }
      }
    }
  }
}

Best Practices

Always log the requestId - Include it when contacting support for faster issue resolution
Use errorCode or errorName for programmatic error handling in your application
Reference the timestamp for correlating errors with your application logs

📖 View complete error codes reference →