Get Report Data

post

https://revrec.recurly.com/api/report/getReportData

Body Params

layoutId

integer

unique identifier for the layout

layoutName

string

unique identifier for the layout

entityName

string

Entity Name filters or labels the specific entity, layout target, or config item for the requested report.

reportId

integer

Report ID identifies the kind of report being requested.

reportType

integer

Report Type identifies the kind of line data to include in the requested report.

bookId

integer

Book ID is the ID for the book to be included in the requested report

netType

integer

Net Type determines whether the report should present gross values, net values, or another supported balance basis.

currencyType

integer

Currency Type identifies the currency that should be used for the requested reports.

download

boolean

True will return all data by compressing the csv file. false will return csv file with first 1000 rows( mainly used for validation)

periodId

integer

Period ID identifies the accounting period in which to run the requested report. For waterfall reports, this will be the ending period of the requested report.

layoutFields

array of objects

layoutFields

waterFallType

integer

Waterfall Type determines if requested waterfall report should include actuals, forecast, or both.

summarized

boolean

Summarized indicates whether the report should return summarized output instead of detailed transaction-level rows.

Response

200

Report data fetched

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here!