---
updatedAt: 2026-05-01T15:26:29.000Z
agentTools:
  siteIndex: https://docs.recurly.com/llms.txt
  projectIndex: https://docs.recurly.com/recurly-revrec/llms.txt
---

# Get Report Data

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Revrec APIs",
    "version": "1.9.0"
  },
  "servers": [
    {
      "url": "https://revrec.recurly.com"
    }
  ],
  "tags": [
    {
      "name": "Outbound Report APIs"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Authentication scheme using Basic Auth where the API key is provided as the username and the password is blank.\n\nExample usage:\nIf your API key is `110eee7324cf4146ac875db3108f175c`, then the Authorization header should be:\n`Authorization: Basic MTEwZWVlNzMyNGNmNDE0NmFjODc1ZGIzMTA4ZjE3NWM6`\n\nThis value is the Base64 encoding of the string `110eee7324cf4146ac875db3108f175c:` (note the trailing colon for empty password)."
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/api/report/getReportData": {
      "post": {
        "tags": [
          "Outbound Report APIs"
        ],
        "summary": "Get Report Data",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "layoutId": {
                    "type": "integer",
                    "description": "unique identifier for the layout"
                  },
                  "layoutName": {
                    "type": "string",
                    "description": "unique identifier for the layout"
                  },
                  "entityName": {
                    "type": "string",
                    "description": "Entity Name filters or labels the specific entity, layout target, or config item for the requested report."
                  },
                  "reportId": {
                    "type": "integer",
                    "description": "Report ID identifies the kind of report being requested."
                  },
                  "reportType": {
                    "type": "integer",
                    "description": "Report Type identifies the kind of line data to include in the requested report."
                  },
                  "bookId": {
                    "type": "integer",
                    "description": "Book ID is the ID for the book to be included in the requested report"
                  },
                  "netType": {
                    "type": "integer",
                    "description": "Net Type determines whether the report should present gross values, net values, or another supported balance basis."
                  },
                  "currencyType": {
                    "type": "integer",
                    "description": "Currency Type identifies the currency that should be used for the requested reports."
                  },
                  "download": {
                    "type": "boolean",
                    "description": "True will return all data by compressing the csv file. false will return csv file with first 1000 rows( mainly used for validation)"
                  },
                  "periodId": {
                    "type": "integer",
                    "description": "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": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "fieldConfigId": {
                          "type": "string",
                          "description": "Field Config ID identifies the report field definition used in the saved layout filter or prompt."
                        },
                        "value": {
                          "type": "string",
                          "nullable": true,
                          "description": "Value is the user-selected filter or prompt value for the corresponding layout field."
                        },
                        "indicator": {
                          "type": "integer",
                          "format": "int32",
                          "description": "Indicator controls field behavior in the layout, such as search, grouping, or other supported flags."
                        }
                      }
                    }
                  },
                  "waterFallType": {
                    "type": "integer",
                    "description": "Waterfall Type determines if requested waterfall report should include actuals, forecast, or both."
                  },
                  "summarized": {
                    "type": "boolean",
                    "description": "Summarized indicates whether the report should return summarized output instead of detailed transaction-level rows."
                  }
                },
                "example": {
                  "layoutId": 0,
                  "reportId": 3,
                  "reportType": 1,
                  "bookId": 1,
                  "netType": 1,
                  "currencyType": 0,
                  "download": true,
                  "periodId": 1,
                  "layoutFields": [
                    {
                      "fieldConfigId": 13,
                      "value": "USD",
                      "indicators": 0
                    }
                  ],
                  "waterFallType": 0,
                  "summarized": true
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Report data fetched"
          }
        }
      }
    }
  }
}
```

# Sibling pages

* [Get Transfer Batches](https://docs.recurly.com/recurly-revrec/reference/get_api-transfer-gettransferbatches.md)
* [Get Eligible Transfer Batches](https://docs.recurly.com/recurly-revrec/reference/get_api-transfer-geteligibletransferbatches.md)
* [Get Eligible Approve Batches](https://docs.recurly.com/recurly-revrec/reference/get_api-transfer-geteligibleapprovebatches.md)
* [Mark Transfer Batch](https://docs.recurly.com/recurly-revrec/reference/put_api-transfer-marktransferred.md)
* [Approve Transfer Batch](https://docs.recurly.com/recurly-revrec/reference/put_api-transfer-approvetransferbatch.md)