GET Contact/id/generate-pdf

Returns a response with raw PDF file content for a specified generate type related to a contact.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.

FileId Specifies the file id of the file to perform the operation upon. integer

Required

FromDate Filter records with Date greater than or equal to a date (must also specifiy ToDate). string

Required for GenerateType Statement.

ToDate Filter records with Date less than or equal to a date (must also specifiy FromDate). string

Required for GenerateType Statement.

GenerateType Specifies the type for generating the PDF. Valid Values - Statement. string

Required.

id Contact Id. integer

Required

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional information