API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Billing

Reference

Extraserviceprice

The extraserviceprice object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this extraserviceprice
ExtraServiceId: Id required
MaximumPrice: decimal? optional
Price: decimal required
TariffId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this extraserviceprice
SystemId: string optional api-only
User defined data about this extraserviceprice. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "ExtraServiceId": 12345678,
  "MaximumPrice": ,
  "Price": 1.2,
  "TariffId": 12345678,
  "UniqueId": "46167efd-8baf-4871-8a7b-5fe2eb08ace1",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a ExtraServicePrice

This endpoint allows you to GET a list of extraserviceprices based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/billing/extraserviceprices?...

🔒 Requires role "ExtraServicePrice-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search extraserviceprice records based on their different properties.
Id number
?Id=12345678
ExtraServicePrice_ExtraService ExtraService
?ExtraServicePrice_ExtraService=...
ExtraServicePrice_MaximumPrice decimal?
?ExtraServicePrice_MaximumPrice=...
ExtraServicePrice_Price decimal
?ExtraServicePrice_Price=...
ExtraServicePrice_Tariff Tariff
?ExtraServicePrice_Tariff=...
ExtraServicePrice_ExtraServiceName string
?ExtraServicePrice_ExtraServiceName=...
ExtraServicePrice_TariffName string
?ExtraServicePrice_TariffName=...

Range search querystring parameters
Lets you search extraserviceprice records based on a range of date or numeric values.
To_ExtraServicePrice_CreatedOn date
?To_ExtraServicePrice_CreatedOn=2010-01-01T20:32
From_ExtraServicePrice_CreatedOn date
?From_ExtraServicePrice_CreatedOn=2010-01-01T20:32
To_ExtraServicePrice_UpdatedOn date
?To_ExtraServicePrice_UpdatedOn=2010-01-01T20:32
From_ExtraServicePrice_UpdatedOn date
?From_ExtraServicePrice_UpdatedOn=2010-01-01T20:32
To_ExtraServicePrice_Price number
?To_ExtraServicePrice_Price=0
From_ExtraServicePrice_Price number
?From_ExtraServicePrice_Price=10
To_ExtraServicePrice_MaximumPrice number
?To_ExtraServicePrice_MaximumPrice=0
From_ExtraServicePrice_MaximumPrice number
?From_ExtraServicePrice_MaximumPrice=10

Example request

GET https://spaces.nexudus.com/api/billing/extraserviceprices?ExtraServicePrice_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "ExtraService": ,
        "Tariff": ,
        "Price": 1.2,
        "MaximumPrice": ,
        "ExtraServicePriceExtraServiceName": "...",
        "ExtraServicePriceTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "4351ec83-58ce-4696-a95e-beef6bcb98af",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}

Find ExtraServicePrices by IDs

Gets one or more extraserviceprice records based on their Id. 
GET https://spaces.nexudus.com/api/billing/extraserviceprices?ExtraServicePrice_Id=[:id1,:id2,...]

🔒 Requires role "ExtraServicePrice-List"

Querystring parameters
ExtraServicePrice_Id: array requried
?ExtraServicePrice_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/billing/extraserviceprices?ExtraServicePrice_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "ExtraService": ,
        "Tariff": ,
        "Price": 1.2,
        "MaximumPrice": ,
        "ExtraServicePriceExtraServiceName": "...",
        "ExtraServicePriceTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "cbeb36d0-1273-4226-9c3e-716de8d59bf2",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single ExtraServicePrice by Id

Gets one extraserviceprice record by its Id. 
GET https://spaces.nexudus.com/api/billing/extraserviceprices/:Id

🔒 Requires role "ExtraServicePrice-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/billing/extraserviceprices/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "ExtraServiceId": 12345678,
  "MaximumPrice": ,
  "Price": 1.2,
  "TariffId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "55626d86-0873-49bb-927f-12ee383869eb",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new ExtraServicePrice

Creates a new extraserviceprice. 
POST https://spaces.nexudus.com/api/billing/extraserviceprices

🔒 Requires role "ExtraServicePrice-Create"

Body parameters
ExtraServiceId: number required
TariffId: number required
Price: decimal required
MaximumPrice: decimal? optional

Example request

POST https://spaces.nexudus.com/api/billing/extraserviceprices
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "ExtraServiceId": 12345678,
    "TariffId": 12345678,
    "Price": 1.2,
    "MaximumPrice": ,
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Update ExtraServicePrice

Updates an existing extraserviceprice. 
PUT https://spaces.nexudus.com/api/billing/extraserviceprices

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

🔒 Requires role "ExtraServicePrice-Edit"

Body parameters
Id: number required
The unique Id of the extraserviceprice to update.
ExtraServiceId: number cleared if missing
TariffId: number cleared if missing
Price: decimal cleared if missing
MaximumPrice: decimal? cleared if missing

Example request

PUT https://spaces.nexudus.com/api/billing/extraserviceprices
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "Id": 12345678,
    "ExtraServiceId": 12345678,
    "TariffId": 12345678,
    "Price": 1.2,
    "MaximumPrice": ,
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Delete ExtraServicePrice

Deletes an existing extraserviceprice by its Id. 
DELETE https://spaces.nexudus.com/api/billing/extraserviceprices/:Id

🔒 Requires role "ExtraServicePrice-Delete"

URL parameters
Id: number required
The unique Id of the extraserviceprice to update.

Example request

DELETE https://spaces.nexudus.com/api/billing/extraserviceprices/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}

Commands

Commands allow to perform actions against one or more extraserviceprice records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for extraserviceprice records. 
GET https://spaces.nexudus.com/api/billing/extraserviceprices/commands

Example request

GET https://spaces.nexudus.com/api/billing/extraserviceprices/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]

Run Command

Runs a command based on its Key and one or more extraserviceprice record IDs. 
POST https://spaces.nexudus.com/api/billing/extraserviceprices/runacommand
🔒 Requires role "ExtraServicePrice-Edit"

Example request

POST https://spaces.nexudus.com/api/billing/extraserviceprices/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}

Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.