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

Tariffproduct

The tariffproduct object

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

Json Structure Example 


{
  "Id": 1234567,
  "ProductId": 12345678,
  "TariffId": 12345678,
  "UniqueId": "e554d272-d87c-462e-aafe-fb30f7789e46",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a TariffProduct

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

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

🔒 Requires role "TariffProduct-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 tariffproduct records based on their different properties.
Id number
?Id=12345678
TariffProduct_Product Product
?TariffProduct_Product=...
TariffProduct_Tariff Tariff
?TariffProduct_Tariff=...
TariffProduct_TariffName string
?TariffProduct_TariffName=...
TariffProduct_ProductName string
?TariffProduct_ProductName=...
TariffProduct_ProductPrice string
?TariffProduct_ProductPrice=...
TariffProduct_ProductBusiness_Currency_Code string
?TariffProduct_ProductBusiness_Currency_Code=...

Range search querystring parameters
Lets you search tariffproduct records based on a range of date or numeric values.
To_TariffProduct_CreatedOn date
?To_TariffProduct_CreatedOn=2010-01-01T20:32
From_TariffProduct_CreatedOn date
?From_TariffProduct_CreatedOn=2010-01-01T20:32
To_TariffProduct_UpdatedOn date
?To_TariffProduct_UpdatedOn=2010-01-01T20:32
From_TariffProduct_UpdatedOn date
?From_TariffProduct_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "Product": ,
        "TariffProductTariffName": "...",
        "TariffProductProductName": "...",
        "TariffProductProductPrice": "...",
        "TariffProductProductBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9bbd9048-d374-476d-a598-a30147de5528",
        "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 TariffProducts by IDs

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

🔒 Requires role "TariffProduct-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "Product": ,
        "TariffProductTariffName": "...",
        "TariffProductProductName": "...",
        "TariffProductProductPrice": "...",
        "TariffProductProductBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "eb41a0d0-b43f-49b1-880d-78916673ca1f",
        "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 TariffProduct by Id

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

🔒 Requires role "TariffProduct-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ProductId": 12345678,
  "TariffId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "8e1f61b3-7a5c-46fd-9d17-a3558ab2390a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new TariffProduct

Creates a new tariffproduct. 
POST https://spaces.nexudus.com/api/billing/tariffproducts

🔒 Requires role "TariffProduct-Create"

Body parameters
TariffId: number required
ProductId: number required

Example request

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


{
    "TariffId": 12345678,
    "ProductId": 12345678,
}

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 TariffProduct

Updates an existing tariffproduct. 
PUT https://spaces.nexudus.com/api/billing/tariffproducts

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

🔒 Requires role "TariffProduct-Edit"

Body parameters
Id: number required
The unique Id of the tariffproduct to update.
TariffId: number cleared if missing
ProductId: number cleared if missing

Example request

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


{
    "Id": 12345678,
    "TariffId": 12345678,
    "ProductId": 12345678,
}

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 TariffProduct

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

🔒 Requires role "TariffProduct-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/billing/tariffproducts/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 tariffproduct 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 tariffproduct records. 
GET https://spaces.nexudus.com/api/billing/tariffproducts/commands

Example request

GET https://spaces.nexudus.com/api/billing/tariffproducts/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 tariffproduct record IDs. 
POST https://spaces.nexudus.com/api/billing/tariffproducts/runacommand
🔒 Requires role "TariffProduct-Edit"

Example request

POST https://spaces.nexudus.com/api/billing/tariffproducts/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.