Skip to main content
POST
/
api
/
sys
/
reports
Create Report
curl --request POST \
  --url https://spaces.nexudus.com/api/sys/reports \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Folder": "<string>",
  "ReportType": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A Report defines a configured report that can be generated on demand or scheduled. Reports cover various data categories including check-ins, invoices, bookings, members, revenue, and occupancy metrics.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Report-Create role.

​
Enums

ValueName
1Checkins
2ExtraServices
3TimePasses
4Members
5AllMembers
6Invoices
7Bookings
8TodayBookings
9PaidInvoices
10Upgrades
11Tariffs
12Accruals
13Transactions
14AccrualsLiable
15AccrualsDelivered
16IncomePaid
17AccountsReceivable
18TariffHistory
19RecurrentCharges
20Events
21BookingCredit
22AccrualsByDelivery
23Tasks
24AllTasks
25Visitors
26CrmLeadTimes
27Desks
28UpgradesTransactions
29DesksOccupancy
30PricePlanOccupancy
31UnPaidInvoices
32ResourceOccupancy
33Crm
34SimpleBookings
35Surveys
36AccrualsBySaleDate
37InvoiceHeaders
38InvoicesBySaleDate
39DeferredRevenueByMonth
40Discounts
41CustomerCountChurnByMonth
42CustomerDetailsChurnByMonth
43CustomerCountChurnByMonthPayingMembers
44CustomerDetailsChurnByMonthPayingMembers
45FormPages
46GetCustomerDetailsRevenueChurnByMonth
47CancelledBookings
998CustomUrl
999CustomProcedure

​
Request Body

​
Required Fields

​
BusinessId
integer
required
ID of the business linked to this record.
​
Name
string
required
The name value for this report.
​
Folder
string
required
The folder value for this report.
​
ReportType
integer
required
The report type value for this report.

​
Optional Fields

​
ReportXml
string
The report xml value for this report.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/reports" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Folder": "",
    "ReportType": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the report was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Report was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}