🚧
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

DOWNLOAD PROJECT

To watch the video click here

JSON Schema API Response

Portuguese

{
  "type" : "object",
  "properties" : {
    "RequestId" : {
      "type" : "string",
      "description" : "Identificador único do pedido."
    },
    "ivaList" : {
      "type" : "object",
      "description" : "Lista dos períodos de tributação do IVA, organizados por período.",
      "additionalProperties" : {
        "type" : "array",
        "items" : {
          "type" : "object",
          "properties" : {
            "periodo" : {
              "type" : "string",
              "description" : "Período de tributação em formato 'YYMM'. Representa o ano e o mês do imposto."
            },
            "entregues" : {
              "type" : "string",
              "description" : "Número de declarações periódicas entregues para o período."
            },
            "emFalta" : {
              "type" : "string",
              "description" : "Número de declarações periódicas que não foram entregues para o período."
            },
            "reembolsoPedido" : {
              "type" : "string",
              "description" : "Número de pedidos de reembolso realizados para o período."
            },
            "reembolsoEmAnalise" : {
              "type" : "string",
              "description" : "Número de pedidos de reembolso que estão em análise para o período."
            },
            "reembolsoDeferido" : {
              "type" : "string",
              "description" : "Número de pedidos de reembolso que foram deferidos para o período."
            },
            "declaracaoRecapit" : {
              "type" : "string",
              "description" : "Número de declarações recapitulativas associadas ao período."
            }
          }
        }
      }
    }
  }
}

English

{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "ivaList": {
      "type": "object",
      "description": "List of VAT taxation periods, organized by period.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "periodo": {
              "type": "string",
              "description": "Taxation period in the format 'YYMM'. Represents the year and month of the tax."
            },
            "entregues": {
              "type": "string",
              "description": "Number of periodic declarations submitted for the period."
            },
            "emFalta": {
              "type": "string",
              "description": "Number of periodic declarations that were not submitted for the period."
            },
            "reembolsoPedido": {
              "type": "string",
              "description": "Number of refund requests made for the period."
            },
            "reembolsoEmAnalise": {
              "type": "string",
              "description": "Number of refund requests under analysis for the period."
            },
            "reembolsoDeferido": {
              "type": "string",
              "description": "Number of refund requests that have been approved for the period."
            },
            "declaracaoRecapit": {
              "type": "string",
              "description": "Number of recapitulative declarations associated with the period."
            }
          }
        }
      }
    }
  }
}

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 →