post https://apigwws.bizapis.com/v2/documents/at-payref-irs
Retrieve payment references for IRS
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"
},
"currentPaymentDocs" : {
"type" : "array",
"description" : "List of current payment documents",
"items" : {
"type" : "object",
"properties" : {
"service" : {
"type" : "string",
"description" : "Unique identifier for the service request"
},
"documentId" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"paymentReference" : {
"type" : "string",
"description" : "Payment reference associated with the payment document"
},
"amount" : {
"type" : "number",
"description" : "Amount to pay"
},
"paymentDueDate" : {
"type" : "string",
"description" : "Due date for the payment"
}
}
}
},
"missingPaymentDocs" : {
"type" : "array",
"description" : "List of missing payment documents",
"items" : {
"type" : "object",
"properties" : {
"service" : {
"type" : "string",
"description" : "Unique identifier for the service request"
},
"documentId" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"paymentReference" : {
"type" : "string",
"description" : "Payment reference associated with the payment document"
},
"amount" : {
"type" : "number",
"description" : "Amount to pay"
},
"paymentDueDate" : {
"type" : "string",
"description" : "Due date for the payment"
}
}
}
}
}
},
"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"
},
"currentPaymentDocs" : {
"type" : "array",
"description" : "Lista de documentos de pagamento atuais",
"items" : {
"type" : "object",
"properties" : {
"service" : {
"type" : "string",
"description" : "Identificador único do pedido de serviço"
},
"documentId" : {
"type" : "string",
"description" : "Identificador único do documento"
},
"paymentReference" : {
"type" : "string",
"description" : "Referência de pagamento associada ao documento de pagamento"
},
"amount" : {
"type" : "number",
"description" : "Montante a pagar"
},
"paymentDueDate" : {
"type" : "string",
"description" : "Data limite para pagamento"
}
}
}
},
"missingPaymentDocs" : {
"type" : "array",
"description" : "Lista de documentos de pagamento em falta",
"items" : {
"type" : "object",
"properties" : {
"service" : {
"type" : "string",
"description" : "Identificador único do pedido de serviço"
},
"documentId" : {
"type" : "string",
"description" : "Identificador único do documento"
},
"paymentReference" : {
"type" : "string",
"description" : "Referência de pagamento associada ao documento de pagamento"
},
"amount" : {
"type" : "number",
"description" : "Montante a pagar"
},
"paymentDueDate" : {
"type" : "string",
"description" : "Data limite para 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"