Skip to main content

Reports via API

You can request FA to generate a JSReport and return the generated report document via GraphQL. This enables you to provide your custom JSReports in your own applications, for example in your customized FA Client Portal.

Sample requests

You can find the full schema documentation for report generation in GraphQL API view in FA Developer app. The example requests for some of FA's sample JSReports are listed below.

Sample request for the Transaction confirmation report (for details about the report, see Transaction confirmation report (PDF)):

query {
  report(
    reportId:"Transaction confirmation (PDF)", 
    reportParameters: {
      transactionId:[750063], 
      reportLanguage:"en_US"
    }
    language:"en"
  )
}

Sample request for the Position report grouped by security type (for details about the report, see Positions report (PDF)):

query {
  report(
    reportId:"Positions (Sample)", 
    reportParameters: {
      reportDate:"2022-08-02",
      portfolioId:[24],
      reportLanguage:"en_US",
      groupBy2:"TYPE"
    },
    language:"en"
  )
}

Sample request for the Position report grouped by the ASSET asset class and sector (for details about the report, see Positions report (PDF)):

query {
  report(
    reportId:"Positions (Sample)", 
    reportParameters: {
      reportDate:"2022-08-02",
      portfolioId:[24],
      reportLanguage:"en_US",
      group:"ASSET",
      groupBy2:"SECTOR"
    },
    language:"en"
  )
}
In this section: