🚧
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 ⏳ Coming Soon
🧪 QUAL ⏳ Coming Soon
🚀 Production ⏳ Coming Soon
Learn more about error handling →

Download Project

DOWNLOAD PROJECT

To watch the video click here

JSON Schema API Response

Portuguese

{
  "type" : "object",
  "properties" : {
    "RequestId" : {
      "type" : "string",
      "description" : "Identificador único do pedido."
    },
    "Interacoes" : {
      "type" : "array",
      "description" : "Registro de interações entre o contribuinte e a Autoridade Tributária, incluindo submissões, pedidos de informação e respostas da AT.",
      "items" : {
        "type" : "object",
        "properties" : {
          "tax" : {
            "type" : "string",
            "description" : "O tipo de imposto ou item fiscal relacionado com esta interação."
          },
          "description" : {
            "type" : "string",
            "description" : "Uma descrição detalhada da interação, como o propósito ou contexto."
          },
          "date" : {
            "type" : "string",
            "description" : "A data em que a interação ocorreu, no formato 'YYYY-MM-DD'."
          }
        }
      }
    }
  }
}

English

{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "Interacoes": {
      "type": "array",
      "description": "Record of interactions between the taxpayer and the Tax Authority, including submissions, information requests, and AT responses.",
      "items": {
        "type": "object",
        "properties": {
          "tax": {
            "type": "string",
            "description": "The type of tax or fiscal item related to this interaction."
          },
          "description": {
            "type": "string",
            "description": "A detailed description of the interaction, such as its purpose or context."
          },
          "date": {
            "type": "string",
            "description": "The date the interaction occurred, 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 →

200200

401401

503503