GetFinancialReportList

Description

Returns array of FinancialReports filtered by input parameters. When any of the parameters is missed, then the default value is used.

Input Parameters

Parameter	Description
`apiKey` (string)	To use the Q4 API, you need to have an application key. We use this to track API usage. Currently, the use of the API is allowed only with prior permission. Requests for API keys are reviewed by staff. Please get in touch with support to get the API Key.
`languageId` (int)	Specifies the language for which financial reports should be returned. The default value is 1 (English).
`tagList` (string)	If specified, the result will be filtered by tags. Tags are pipe-delimited - 'tag1\|tag2'. The default is an empty string.
`pageNumber` (int)	When paging is used, specify the page number to return. It is 0-based.
`pageSize` (int)	When `pageSize` is greater the 0, the paging is enabled. The default is 0 (paging disabled).
`includeTags` (bool)	Specifies that returned data records have to include associated tags.
`year` (int)	Specifies the year for which events should be returned. When not used, -1 must be passed. The default value is 0.
`buffer` (int)	When `eventSelection` is 1 (Future), specifies the number of hours before the end date the event should be returned. Default is 0 (till event end date, the event is considered a Future event).
`reportTypes` (string)	Specifies pipe delimited list of report type filters that will be used to return data. When it is not provided, the result will not be filtered by report type. Example: "Supplemental Report\|Annual Report". Valid values for report type are: First Quarter Second Quarter Third Quarter Fourth Quarter Supplemental Report Annual Report

Sample URL

https://domain.com/feed/FinancialReport.svc/GetFinancialReportList?apiKey=c34993dcba1942418d97656f3ed00979&year=2010&tagList=Q1|Q2&languageId=1&pageNumber=0&pageSize=20&includeTags=true

Sample Request

JSON

var data = {
    apiKey: 'c34993dcba1942418d97656f3ed00979',
    year: 2010,
    tagList: 'Q1|Q2',
    languageId: 1,
    pageNumber: 0,
    pageSize: 20,
    includeTags: true
}

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/FinancialReport.svc/GetFinancialReportList",
    data: data,
    dataType: "json",
    success: OnLoadFinancialReportListSuccess,
    error: OnLoadError
});

Sample Response

JSON

{
    "GetFinancialReportListResult": [{
            "CoverImagePath": "http://domain.com/files/docs_images/iconAboutGold.gif",
            "Documents": [{
                "DocumentCategory": "MD&A",
                "DocumentFileSize": "1.15 MB",
                "DocumentFileType": "PDF",
                "DocumentId": 7113,
                "DocumentOrder": 999,
                "DocumentPath": "http://domain.com/files/docs_presentations/0546NesbittSHOWdraft8.pdf",
                "DocumentTitle": "4th Q document",
                "DocumentType": "File",
                "LanguageId": 1,
                "ReportWorkflowId": "32a826ed-9e06-4fed-b902-67a427b40627",
                "RevisionNumber": 31685,
                "ThumbnailPath": "http://domain.com/files/icons/pdf.gif",
                "WorkflowId": "d4d63650-603d-4549-b745-27190b9fa32d"
            }],
            "LanguageId": 1,
            "ReportDate": "09/18/2012 00:00:00",
            "ReportId": 4124,
            "ReportOrder": 1030,
            "ReportSubType": "Fourth Quarter",
            "ReportTitle": "Fourth Quarter 2012",
            "ReportYear": 2012,
            "RevisionNumber": 31664,
            "TagsList": [],
            "WorkflowId": "32a826ed-9e06-4fed-b902-67a427b40627"
        },
        {
            "CoverImagePath": "",
            "Documents": [{
                "DocumentCategory": "MD&A",
                "DocumentFileSize": "79 KB",
                "DocumentFileType": "PDF",
                "DocumentId": 7112,
                "DocumentOrder": 999,
                "DocumentPath": "http://domain.com/files/docs_annual/2004_Corporate Information.pdf",
                "DocumentTitle": "test#1",
                "DocumentType": "File",
                "LanguageId": 1,
                "ReportWorkflowId": "f18d3ed3-929a-4369-8752-97364700d9d3",
                "RevisionNumber": 31677,
                "ThumbnailPath": null,
                "WorkflowId": "5e610e5f-00c8-468f-8c21-8c34f48cdc55"
            }],
            "LanguageId": 1,
            "ReportDate": "09/18/2012 00:00:00",
            "ReportId": 4125,
            "ReportOrder": 1031,
            "ReportSubType": "Annual Report",
            "ReportTitle": "2012 Annual Report",
            "ReportYear": 2012,
            "RevisionNumber": 31665,
            "TagsList": [],
            "WorkflowId": "f18d3ed3-929a-4369-8752-97364700d9d3"
        }
    ]
}