Custom reports based on company information can be created in the Sage Intacct UI and then used to read records.
Get Custom Report Definition
This will return the custom report definition in a company.
|report||Required||string||The name of the custom report definition to get|
The above function returns both user-defined and system-defined arguments:
|REPORTNAME||string||The report name defined during creation of the report.|
|REPORTTYPE||string||The report type is either |
|ROOT||string||The object the report is set for|
|PARAMETERS|| ||Run-time parameters of the report, including both user-defined and system-defined parameters.|
|NAME||string||Name of the parameter. Returned for both user-defined and system-defined parameters.|
|label||string||Given label of the parameter. Return for only user-defined parameters.|
|promptOnRun||boolean||Whether the parameter was defined as one that needs prompting from the user when the report is run from the UI.|
Run Custom Report
This function is intended to allow developers to design a dataset and not to perform grouping and summary operations. If you need to group or summarize your data, you will need to do that in your own code on the data returned from the report. In short, only run
readReport on tabular reports where grouping is not set.
Run Custom Report with Date Range Arguments
Run Custom Report with Reporting Period Argument
|report||Required||string||The name of the custom report to run|
|pagesize||Optional||integer||Custom page size between |
|arguments||Optional||XMLElement||Each argument is specified by its name (as defined in the report definition) and includes the value to be substituted into the report argument. Report arguments are defined in the report in one of two ways. Some report arguments are hard-coded in the definition of the report. Other report arguments are defined as “run time” parameters and are selected by the user when running the report.|
|waitTime||Optional||integer||Set a custom wait time between |
For reports that define a PERIOD parameter (as returned in the report definition), both system reporting periods and user-defined reporting periods names may be used in the parameter.
To eliminate conflicts on overlapping requests, the system returns report IDs on your initial request.
|reportId||string||The stored report ID to use in subsequent |
List Stored Custom Report Data
When you reach the end of the report, the report ID no longer works. You need to initiate a new
readReport request again to generate a new report ID. Think of it as if the system is running your report, giving that instance an ID, and then holding it in queue for you to read with the
readMore method. After you finish reading it, the system purges it from the queue.
|reportId||Required||string||The report ID of the stored custom report|