Skip to main content
GET
/
api
/
billing
/
tariffextraservices
{
  "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 TariffExtraService-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

TariffExtraService_Tariff
integer
Filter by Tariff Id.
TariffExtraService_Tariff_Name
string
Filter by tariff name.
TariffExtraService_ExtraService
integer
Filter by Extra Service Id.
TariffExtraService_ExtraService_Name
string
Filter by extra service name.
TariffExtraService_ExtraService_ChargePeriod
string
Filter by extra service charge period.
TariffExtraService_ExtraService_IsBookingCredit
string
Filter by whether extra service is booking credit.
TariffExtraService_ExtraService_IsPrintingCredit
string
Filter by whether extra service is printing credit.
TariffExtraService_UsesIncluded
integer
Filter by number of uses included.
TariffExtraService_ServiceRenewalTime
integer
Filter by service renewal time period.

Range Filters

from_TariffExtraService_UsesIncluded
integer
Filter by number of uses included greater than or equal to this value.
to_TariffExtraService_UsesIncluded
integer
Filter by number of uses included less than or equal to this value.
from_TariffExtraService_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_TariffExtraService_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_TariffExtraService_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_TariffExtraService_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/tariffextraservices?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/tariffextraservices?TariffExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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

Response

200

Records
TariffExtraService[]
The list of TariffExtraService records matching the query. See the Get one TariffExtraService 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,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceChargePeriod": null,
      "ExtraServiceIsBookingCredit": null,
      "ExtraServiceIsPrintingCredit": null,
      "UsesIncluded": 0,
      "ServiceRenewalTime": 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": "TariffExtraService 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
}