GET
/
external-api
/
v1
/
reports
/
{id}
Get Report
curl --request GET \
  --url https://getbill.io/external-api/v1/reports/{id} \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "message": "Success",
  "data": {
    "id": "report_abc123",
    "type": "financial",
    "title": "Monthly Financial Summary - January 2024",
    "description": "Comprehensive financial report including debt amounts, collection rates, revenue analysis, and monthly trends. Covers all active debts, payment receipts, and outstanding balances.",
    "status": "completed",
    "filename": "financial_summary_2024_01.pdf",
    "file_size": 245760,
    "mime_type": "application/pdf",
    "period_from": "2024-01-01",
    "period_to": "2024-01-31",
    "generated_at": "2024-02-01T09:30:00Z",
    "created_at": "2024-02-01T09:00:00Z",
    "download_available": true
  }
}

​
Overview

This endpoint returns comprehensive information about a single report, including metadata, generation status, and download availability.

​
Authentication

Requires a valid OAuth 2.0 access token with the reports:read scope.

​
Request

​
Authorization
string
required
Bearer token for authentication
​
id
string
required
The encrypted ID of the report to retrieve

​
Example Request

curl -X GET "/external-api/v1/reports/report_abc123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Response

​
error
boolean
Always false for successful requests
​
message
string
Success message
​
data
object
Complete report information

​
Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "id": "report_abc123",
    "type": "financial",
    "title": "Monthly Financial Summary - January 2024",
    "description": "Comprehensive financial report including debt amounts, collection rates, revenue analysis, and monthly trends. Covers all active debts, payment receipts, and outstanding balances.",
    "status": "completed",
    "filename": "financial_summary_2024_01.pdf",
    "file_size": 245760,
    "mime_type": "application/pdf",
    "period_from": "2024-01-01",
    "period_to": "2024-01-31",
    "generated_at": "2024-02-01T09:30:00Z",
    "created_at": "2024-02-01T09:00:00Z",
    "download_available": true
  }
}

​
Report Status Values

Report is currently being created. Check back later or use webhooks to be notified when complete.
Report has been successfully generated and is ready for download.
Report generation failed due to an error. Contact support if this persists.
Report download link has expired. You may need to regenerate the report.

​
File Types

Reports are available in various formats:
  • PDF: application/pdf - Formatted reports with charts and graphics
  • Excel: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - Spreadsheet data
  • CSV: text/csv - Raw data exports
  • JSON: application/json - Structured data for programmatic use

​
Next Steps

Once you have the report information:
  1. Check Status: Ensure the report status is completed
  2. Download: Use the Download Report endpoint
  3. Process: Parse or display the report data in your application

​
Error Responses

{
  "error": true,
  "message": "Access denied to this report",
  "code": 403
}