Skip to main content
GET
/
api
/
billing
/
tarifftimepasses
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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 TariffTimePass-List role.

Query Parameters

Pagination & Sorting

page
integer
default:"1"
The page number to retrieve.
size
integer
default:"25"
The number of records per page.
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
dir
integer
Sort direction. 1 for ascending, -1 for descending.

Filters

TariffTimePass_Tariff
integer
Filter by Tariff Id.
TariffTimePass_Tariff_Name
string
Filter by tariff name.
TariffTimePass_TimePass
integer
Filter by Time Pass Id.
TariffTimePass_TimePass_Name
string
Filter by time pass name.
TariffTimePass_PassesIncluded
integer
Filter by number of passes included.
TariffTimePass_PassRenewalTime
integer
Filter by pass renewal time period.

Range Filters

from_TariffTimePass_PassesIncluded
integer
Filter by number of passes included greater than or equal to this value.
to_TariffTimePass_PassesIncluded
integer
Filter by number of passes included less than or equal to this value.
from_TariffTimePass_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_TariffTimePass_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_TariffTimePass_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_TariffTimePass_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tarifftimepasses?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tarifftimepasses?TariffTimePass_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tarifftimepasses?from_TariffTimePass_UpdatedOn=2025-01-01T00:00&to_TariffTimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records
TariffTimePass[]
The list of TariffTimePass records matching the query. See the Get one TariffTimePass endpoint for the full list of properties returned for each record.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
FirstItem
integer
Index of the first item on the current page.
LastItem
integer
Index of the last item on the current page.
TotalItems
integer
Total number of matching records across all pages.
TotalPages
integer
Total number of pages.
HasNextPage
boolean
Whether there is a next page of results.
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "TariffId": 0,
      "TariffName": null,
      "TimePassId": 0,
      "TimePassName": null,
      "PassesIncluded": 0,
      "PassRenewalTime": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "TariffTimePass Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}