DocumentPdfPreview

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Read	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Query)	`documentPdfPreview`	`DocumentPdfPreviewGLDtoInput`

Description

The DocumentPdfPreview service allows you to preview documents in PDF format.

This service generates a binary representation of the PDF.

This binary data, often referred to as a blob can easily be displayed in a PDF viewer embedded within a browser tab.

Functionality

Document Retrieval: Fetches a binary representation of the document in PDF format.
Supports Different Document Types: Able to generate previews for various document types such as sales quotes, orders, delivery notes, and invoices.

Required Parameters

To utilize this service, you need to provide the following input parameters:

type: Type of the document for which the preview is requested.
- SALES_QUOTE
- SALES_ORDER
- SALES_DELIVERY_NOTE
- SALES_INVOICE
id: The unique identifier of the document for which the preview is being generated.

Response

The service returns a DocumentPdfPreviewOutputGLDto object containing the following fields:

type: The type of the document previewed.
id: The unique identifier of the document.
pdfPreview: A string representing the binary content of the PDF.

Key	Value
`Authorization`	Bearer Current access Token How to find?
`X-TenantId`	Current tenant id How to find?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

How to use the Document Pdf Preview service?

graphQL Query

query($input: DocumentPdfPreviewGLDtoInput!) {
  documentPdfPreview(input: $input) {
    type
    id
    pdfPreview
  }
}

graphQL Variables

{
  "input": {
    "type": "SALES_INVOICE",
    "id": "{invoiceId}"
  }
}

Example Response

{
  "type": "SALES_INVOICE",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pdfPreview": "JVBERi0xLjcKJYGBgYEKCjQgMCBvYmoKPDwKL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUg..."
}

documentPdfPreview Input parameters

Fields	Type	Description	Length
type	SALES_QUOTE SALES_ORDER SALES_DELIVERY_NOTE SALES_INVOICE	Type of the document (e.g., SALES_INVOICE)
id	UUID	Unique identifier of the document

documentPdfPreview Response

Fields	Type	Description
type	SALES_QUOTE SALES_ORDER SALES_DELIVERY_NOTE SALES_INVOICE	Type of the document previewed
id	UUID	Unique identifier of the document
pdfPreview	String	Binary representation of the PDF (Base64 encoded string) See InfoAdditional information is available in the Info block below

Info

pdfPreview: This is a Base64 encoded string representing the PDF file. It can be converted to a binary file and viewed in a PDF reader.

Javascript sample to display the pdf in a browser tab

To display the PDF in a browser, you can use the provided JavaScript function pdfPreviewInBrowser with the PdfPreview string.

function pdfPreviewInBrowser(base64String){
  const base64Pdf = `data:application/pdf;base64,${base64String}`;
  let pdfBlob = fetch(base64Pdf).then(res => res.blob());
  pdfBlob.then(blob => {
    const pdfUrl = URL.createObjectURL(blob);
    window.open(pdfUrl);
  });
}