Generate PDF/A3 by UUID

Get the PDF/A3 version of an E-Invoice with the XML attached based on the invoice identifiers of the invoice data already sent to Clear earlier.

Request Method

POST

Request URL

{{BASE_URL}}/api/EInvoice/GeneratePDFA3byUUID

Replace the {{BASE_URL}} with the one mentioned here based on whether you are using sandbox or production.

Replace the {Your_Invoice_Number} with Invoice Number.

Request Authorization

Parameter	Data Type	Validations and Example	Description
Bearer token	String	Cannot be empty.	Mandatory

Request Body

Parameter	Data Type	Validations and Example	Description
UUID	String		Mandatory. Universal Unique Identifier of zatca cleared/reported invoice

Sample Request

{
    "UUID": "ba79e7f0-b2ac-45f6-8dac-28796d7de59h"
}

Response Status Codes

HTTP Status Code	Description
200	For a successful A3 PDF E-Invoice.
400	For any kind of validation issues or invalid Invoice Number.
401	If the user is not authenticated for the operation.
403	If the user is not authorized for the operation.
500	HTTP Internal Server Error. Returned when the service faces internal errors.

Response Schema

Parameter	Data Type	Description
EncodedPDF	String	Mandatory

Sample Response

Success - HTTP Status Code - 200

{
    "EncodedPDF": "JVBERi0xLjcKJeLjz9MKOSAwIG9i..."
}

Error - HTTP Status Code - 400

{
    "errorCode": "00400",
    "errorMessage": "Universal Unique Identifier is Required",
    "errorSource": "EVS_Portal"
}

Error - HTTP Status Code - 400

{
    "errorCode": "00400",
    "errorMessage": "Record Not Found Against the provided UUID: ba79e7f0-b2ac-45f6-8dac-28796d7de59h",
    "errorSource": "EVS_Portal"
}

Error - HTTP Status Code - 400

{
    "errorCode": "00400",
    "errorMessage": "XML is Null for this Request",
    "errorSource": "EVS_Portal"
}