Skip to content

Skill: Interactive Custom Report

The Interactive Custom Report skill executes a pre-built custom report in Sage Intacct and returns its results. This is the skill to use when the standard query skills do not cover a specific reporting need — if your organization has built custom reports in Sage Intacct, this skill can run them programmatically.

ParameterTypeRequiredDescription
report_idstringYesThe Sage Intacct report ID to execute. This is the unique identifier of the custom report as configured in Sage Intacct.
max_retriesintegerNoMaximum number of retry attempts if the report execution fails or times out. Defaults to 3.
retry_delayintegerNoDelay in seconds between retry attempts. Defaults to 5.
return_formatstringNoHow to format the results. Options: summary, detailed, raw. Defaults to summary.
max_records_returnedintegerNoMaximum number of records to return from the report. Defaults to 1000.
FormatDescription
summaryReturns a condensed version with totals and key metrics. Best for quick overviews.
detailedReturns the full report with all rows and columns. Best for thorough analysis.
rawReturns the unprocessed Sage Intacct API response. Best for debugging or downstream processing.

“Run the monthly financial summary report.”

The agent would invoke:

  • report_id: MONTHLY_FIN_SUMMARY
  • return_format: summary

“Pull the full vendor analysis report with all details, up to 5000 rows.”

The agent would invoke:

  • report_id: VENDOR_ANALYSIS_Q1
  • return_format: detailed
  • max_records_returned: 5000
  • max_retries: 5
  • retry_delay: 10

The response structure depends on the return_format:

  • Summary — key metrics extracted from the report (totals, averages, counts) with a brief textual description.
  • Detailed — full tabular data with column headers and all rows, up to max_records_returned.
  • Raw — the complete Sage Intacct API response object, including metadata and all data fields.

In all formats, the response includes:

  • Report metadata — report name, execution time, number of records.
  • Status — whether the report completed successfully or required retries.
  • Record count — total records available vs. records returned (if truncated by max_records_returned).

POST /api/sage-intacct/v1.0/interactive-custom-report


Related skills: Query GL Detail | Query GL Budget Items | Query AP Bill Items