Skip to main content

GenerateReportInput

The input type used to request the generation of new report results.

input GenerateReportInput {
  reportCode: String!
  reportParameters: JSONObject
  requestedColumns: [String!]
}

Fields​

GenerateReportInput.reportCode ● String! non-null scalar​

Uniquely identifies which report should be generated. The set of possible values for reportCode is outlined in the First Dollar API documentation.

GenerateReportInput.reportParameters ● JSONObject scalar​

The set of parameters to pass with this report generation request. This keys in this field are the parameter names and the values are the parameter values. The possible parameters for each individual reportCode are specified in the First Dollar API documentation.

GenerateReportInput.requestedColumns ● [String!] list scalar​

This field allows the caller to specify a subset of columns in the report for generation. If this value is not specified, all requested columns will be returned.

Member Of​

generateReport mutation