Skip to main content
POST
/
v1
/
exports
/
rentals
Export rentals to CSV
curl --request POST \
  --url https://api-eu.flexportal.io/v1/exports/rentals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "format": "csv",
  "includeFields": {
    "customerDetails": true,
    "deviceDetails": true,
    "financialDetails": true,
    "customFields": true
  },
  "status": "active",
  "customerIds": [
    "<string>"
  ]
}
'
{
  "success": true,
  "filename": "<string>",
  "csvData": "<string>",
  "totalRecords": 123,
  "generatedAt": "<string>",
  "filters": {},
  "totalRentals": 123,
  "activeRentals": 123,
  "totalRevenue": 123,
  "averageMonthlyRevenue": 123
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Body

application/json
startDate
string<date-time>
endDate
string<date-time>
format
enum<string>
default:csv
Available options:
csv
includeFields
object
status
enum<string>
Available options:
active,
cancelled,
ended_completed,
ended_buyout,
ended_upgrade,
ended_early_return
customerIds
string[]

Response

Export generated

success
boolean
required
filename
string
required
csvData
string
required
totalRecords
number
required
generatedAt
string
required
filters
object
required
totalRentals
number
required
activeRentals
number
required
totalRevenue
number
required
averageMonthlyRevenue
number
required