Create Report

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
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reports"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Folder": "<string>",
    "ReportType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Folder: '<string>', ReportType: 123})
};

fetch('https://spaces.nexudus.com/api/sys/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

eReportType — ReportType values

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this report.

string

required

The folder value for this report.

integer

required

The report type value for this report.

Optional Fields

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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reports',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Folder: '',
      ReportType: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/reports',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Folder': '',
        'ReportType': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the report was created successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update ReportUpdate an existing Report record.

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
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reports"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Folder": "<string>",
    "ReportType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Folder: '<string>', ReportType: 123})
};

fetch('https://spaces.nexudus.com/api/sys/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400