POST api/v1/DocumentPDF

Retrieve a pdf copy of an Caliq pdf document
You must send a document id which would have been returned as part of an order or ledger query, or from an EventDocuments list
InvoicePDF has since been replaced with DocumentPDF but functionailty remains the same in both

Request Information

URI Parameters

None.

Body Parameters

InvoicePDFParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
DocumentID	Returned with order data	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "DocumentID": 2
}

application/xml, text/xml

Sample:

<InvoicePDFParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <DocumentID>2</DocumentID>
</InvoicePDFParams>

Response Information

Resource Description

Returns:
200 OK Returns a base64 encoded version of the pdf document
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
402 No Content if the requested document id does not exist 503 Service Unavailable

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string>sample string 1</string>