post https://apigwws.bizapis.com/v2/documents/at-payref-irc
Retrieve payment references for IRC
What's New in bizAPIs 3.0Enhanced 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, anderrorNameto help you quickly identify and resolve issues.
Availability by Environment
Environment Status 📚 Documentation ⏳ Coming Soon 🧪 QUAL ⏳ Coming Soon 🚀 Production ⏳ Coming Soon
Important NoticeThe option to receive the pdf document associated with the extracted information is only available for licenses that include access to this file.
If you wish to enable this feature in your plan, please contact our sales team for further details and subscription options.
JSON Schema for API Response
{
"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 IRC payment documents",
"items" : {
"type" : "object",
"properties" : {
"declarationId" : {
"type" : "string",
"description" : "Declaration Identification"
},
"period" : {
"type" : "string",
"description" : "Period of the document"
},
"documentId" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"fiscalId" : {
"type" : "string",
"description" : "Fiscal Identification"
},
"amount" : {
"type" : "number",
"description" : "Amount to Pay"
},
"paymentReference" : {
"type" : "string",
"description" : "Payment reference associated with the payment document"
},
"paymentCertification" : {
"type" : "string",
"description" : "Payment Certification"
}
}
}
}
}
},
"files" : {
"type" : "array",
"description" : "A list of files, each encoded as a Base64 string. Used when multiple files are included in the response.",
"items" : {
"type" : "string"
}
}
}
}
{
"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 IRC",
"items" : {
"type" : "object",
"properties" : {
"declarationId" : {
"type" : "string",
"description" : "Identificação da declaração"
},
"period" : {
"type" : "string",
"description" : "Período do documento"
},
"documentId" : {
"type" : "string",
"description" : "Identificador único do documento"
},
"fiscalId" : {
"type" : "string",
"description" : "Identificação fiscal"
},
"amount" : {
"type" : "number",
"description" : "Montante a pagar"
},
"paymentReference" : {
"type" : "string",
"description" : "Referência de pagamento associada ao documento de pagamento"
},
"paymentCertification" : {
"type" : "string",
"description" : "Certificação de pagamento"
}
}
}
}
}
},
"files" : {
"type" : "array",
"description" : "Lista de ficheiros, cada um codificado como uma string Base64. Utilizado quando múltiplos ficheiros estão incluídos na resposta.",
"items" : {
"type" : "string"
}
}Best Practices
- Always log the
requestId- Include it when contacting support for faster issue resolution - Use
errorCodeorerrorNamefor programmatic error handling in your application - Reference the timestamp for correlating errors with your application logs