Reference

Productbookingcredit

The productbookingcredit object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this productbookingcredit
CaneBeUsedForEvents: bool optional
Credit: decimal required
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional
ExpiresIn: int? optional
Name: string required
ProductId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this productbookingcredit
SystemId: string optional api-only
User defined data about this productbookingcredit. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "CaneBeUsedForEvents": false,
  "Credit": 1.2,
  "ExpirationType": 1,
  "ExpiresIn": ,
  "Name": "00001",
  "ProductId": 12345678,
  "UniqueId": "78429075-47f7-4c32-85a0-12b6a72fc0e5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ProductBookingCredit

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

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

πŸ”’ Requires role "ProductBookingCredit-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 productbookingcredit records based on their different properties.
Id number
?Id=12345678
ProductBookingCredit_CaneBeUsedForEvents bool
?ProductBookingCredit_CaneBeUsedForEvents=...
ProductBookingCredit_Credit decimal
?ProductBookingCredit_Credit=...
ProductBookingCredit_ExpirationType Nexudus.Coworking.Core.Enums.eRecurrentChargePattern?
?ProductBookingCredit_ExpirationType=...
ProductBookingCredit_ExpiresIn int?
?ProductBookingCredit_ExpiresIn=...
ProductBookingCredit_Name string
?ProductBookingCredit_Name=...
ProductBookingCredit_Product Product
?ProductBookingCredit_Product=...
ProductBookingCredit_ProductName string
?ProductBookingCredit_ProductName=...
ProductBookingCredit_ProductBusiness_Currency_Code string
?ProductBookingCredit_ProductBusiness_Currency_Code=...
ProductBookingCredit_ElegibleResourceTypes List of ResourceType
?ProductBookingCredit_ElegibleResourceTypes=...
ProductBookingCredit_EventCategories List of CalendarEventCategory
?ProductBookingCredit_EventCategories=...

Range search querystring parameters
Lets you search productbookingcredit records based on a range of date or numeric values.
To_ProductBookingCredit_CreatedOn date
?To_ProductBookingCredit_CreatedOn=2010-01-01T20:32
From_ProductBookingCredit_CreatedOn date
?From_ProductBookingCredit_CreatedOn=2010-01-01T20:32
To_ProductBookingCredit_UpdatedOn date
?To_ProductBookingCredit_UpdatedOn=2010-01-01T20:32
From_ProductBookingCredit_UpdatedOn date
?From_ProductBookingCredit_UpdatedOn=2010-01-01T20:32
To_ProductBookingCredit_Credit number
?To_ProductBookingCredit_Credit=0
From_ProductBookingCredit_Credit number
?From_ProductBookingCredit_Credit=10
To_ProductBookingCredit_ExpiresIn number
?To_ProductBookingCredit_ExpiresIn=0
From_ProductBookingCredit_ExpiresIn number
?From_ProductBookingCredit_ExpiresIn=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Name": "00001",
        "Product": ,
        "Credit": 1.2,
        "CaneBeUsedForEvents": false,
        "ExpirationType": 1,
        "ExpiresIn": ,
        "ProductBookingCreditProductName": "...",
        "ProductBookingCreditProductBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "36b1c944-5896-4cb1-86d0-f0572c1eb36e",
        "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 ProductBookingCredits by IDs

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

πŸ”’ Requires role "ProductBookingCredit-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Name": "00001",
        "Product": ,
        "Credit": 1.2,
        "CaneBeUsedForEvents": false,
        "ExpirationType": 1,
        "ExpiresIn": ,
        "ProductBookingCreditProductName": "...",
        "ProductBookingCreditProductBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "f44e99ea-7444-491c-b4dc-b5c5a4dc201a",
        "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 ProductBookingCredit by Id

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

πŸ”’ Requires role "ProductBookingCredit-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CaneBeUsedForEvents": false,
  "Credit": 1.2,
  "ExpirationType": 1,
  "ExpiresIn": ,
  "Name": "00001",
  "ProductId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "0bfaac07-19a9-41b8-a8e1-64d51ccac85e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ProductBookingCredit

Creates a new productbookingcredit.
POST https://spaces.nexudus.com/api/billing/productbookingcredits

πŸ”’ Requires role "ProductBookingCredit-Create"

Body parameters
Name: string required
ProductId: number required
Credit: decimal required
CaneBeUsedForEvents: bool optional
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional
ExpiresIn: int? optional

Example request

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

{
    "Name": "00001",
    "ProductId": 12345678,
    "ElegibleResourceTypes": [12345678, 87654321],
    "Credit": 1.2,
    "CaneBeUsedForEvents": false,
    "EventCategories": [12345678, 87654321],
    "ExpirationType": 1, //(check Enumerated values section below)
    "ExpiresIn": ,
}


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 ProductBookingCredit

Updates an existing productbookingcredit.
PUT https://spaces.nexudus.com/api/billing/productbookingcredits

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

πŸ”’ Requires role "ProductBookingCredit-Edit"

Body parameters
Id: number required
The unique Id of the productbookingcredit to update.
Name: string cleared if missing
ProductId: number cleared if missing
Credit: decimal cleared if missing
CaneBeUsedForEvents: bool cleared if missing
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? cleared if missing
ExpiresIn: int? cleared if missing

Example request

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

{
    "Id": 12345678,
    "Name": "00001",
    "ProductId": 12345678,
    "ElegibleResourceTypes": [12345678, 87654321],
    "Credit": 1.2,
    "CaneBeUsedForEvents": false,
    "EventCategories": [12345678, 87654321],
    "ExpirationType": 1, //(check Enumerated values section below)
    "ExpiresIn": ,
}


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 ProductBookingCredit

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

πŸ”’ Requires role "ProductBookingCredit-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/billing/productbookingcredits/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 productbookingcredit record IDs.
POST https://spaces.nexudus.com/api/billing/productbookingcredits/runacommand
πŸ”’ Requires role "ProductBookingCredit-Edit"

Example request

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


Enumerated values

ExpirationType

GET /api/utils/enums?name=eRecurrentChargePattern

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.