Get pdfDocument

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Retrieve a PDF print-out of the corresponding document as binary content for Dynamics 365 Business Central.

Note

To generate a document in the supported local language, you must specify Accept-Language in the Request header, for example Accept-Language: nl-NL for Dutch.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline. The following example gets a link to the content of the PDF:

GET businesscentralPrefix/api/v2.0/companies({id})/salesQuote({quoteId})/pdfDocument
GET businesscentralPrefix/api/v2.0/companies({id})/salesInvoice({salesInvoiceId})/pdfDocument
GET businesscentralPrefix/api/v2.0/companies({id})/salesCreditMemo(salesCreditMemoId})/pdfDocument
GET businesscentralPrefix/api/v2.0/companies({id})/purchaseInvoide({purchaseInvoiceId})/pdfDocument

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a link to the PDF document in the response body.

Example

Request Here is an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesQuotes({quoteId})/pdfDocument

Response Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{

    "@odata.context":"https://api.businesscentral.dynamics.com/v2.0/api/v2.0/$metadata#companies('CRONUS%20International%20Ltd.')/salesQuotes(94913756-80e9-47bc-995a-048a655b8cdd)/pdfDocument",
    "value":
    [
        {
            "@odata.etag":"W/\"JzQ0O0tQNUdjaUtZcU8rcUNCQTdXOUxIZVEwalA0clhjSmlXU1pqWjQ4RFczd2s9MTswMDsn\"",
            "id":"94913756-80e9-47bc-995a-048a655b8cdd",
            "content@odata.mediaReadLink":"https:// api.businesscentral.dynamics.com/v2.0/pi/v2.0/companies(name='CRONUS%20International%20Ltd.')/salesQuotes(94913756-80e9-47bc-995a-048a655b8cdd)/pdfDocument(94913756-80e9-47bc-995a-048a655b8cdd)/content"
        }
    ]
}

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline. The following example gets the actual PDF document: GET businesscentralPrefix/api/v2.0/companies({companyid})/salesQuotes({quoteId})/pdfDocument({invoiceid})/content

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and the PDF document in the response body.

Example

Request Here is an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({companyid})/salesQuotes({quoteId})/pdfDocument({id})/content

Response The PDF document in binary format.

See also

Tips for working with the APIs
salesquote
Get salesquote
Delete salesquote
Create salesquote
Update salesquote