Reference

Coworkerbookingcredit

The coworkerbookingcredit object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerbookingcredit
BusinessId: Id required
CaneBeUsedForEvents: bool optional
CoworkerId: Id required
Description: string optional
ExpireDate: DateTime? optional
RemainingCredit: decimal required read-only
TariffBookingCreditId: Id optional read-only
TotalCredit: decimal required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerbookingcredit
SystemId: string optional api-only
User defined data about this coworkerbookingcredit. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CaneBeUsedForEvents": false,
  "CoworkerId": 12345678,
  "Description": "Abc123456",
  "ExpireDate": ,
  "RemainingCredit": 1.2,
  "TariffBookingCreditId": 12345678,
  "TotalCredit": 1.2,
  "UniqueId": "565b171e-5c8e-4a12-a2c9-ea98e86791a5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerBookingCredit

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

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

πŸ”’ Requires role "CoworkerBookingCredit-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 coworkerbookingcredit records based on their different properties.
Id number
?Id=12345678
CoworkerBookingCredit_Business Business
?CoworkerBookingCredit_Business=...
CoworkerBookingCredit_CaneBeUsedForEvents bool
?CoworkerBookingCredit_CaneBeUsedForEvents=...
CoworkerBookingCredit_Coworker Coworker
?CoworkerBookingCredit_Coworker=...
CoworkerBookingCredit_Description string
?CoworkerBookingCredit_Description=...
CoworkerBookingCredit_ExpireDate DateTime?
?CoworkerBookingCredit_ExpireDate=...
CoworkerBookingCredit_RemainingCredit decimal
?CoworkerBookingCredit_RemainingCredit=...
CoworkerBookingCredit_TariffBookingCredit TariffBookingCredit
?CoworkerBookingCredit_TariffBookingCredit=...
CoworkerBookingCredit_TotalCredit decimal
?CoworkerBookingCredit_TotalCredit=...
CoworkerBookingCredit_TariffBookingCreditName string
?CoworkerBookingCredit_TariffBookingCreditName=...
CoworkerBookingCredit_ElegibleResourceTypes List of ResourceType
?CoworkerBookingCredit_ElegibleResourceTypes=...
CoworkerBookingCredit_EventCategories List of CalendarEventCategory
?CoworkerBookingCredit_EventCategories=...

Range search querystring parameters
Lets you search coworkerbookingcredit records based on a range of date or numeric values.
To_CoworkerBookingCredit_CreatedOn date
?To_CoworkerBookingCredit_CreatedOn=2010-01-01T20:32
From_CoworkerBookingCredit_CreatedOn date
?From_CoworkerBookingCredit_CreatedOn=2010-01-01T20:32
To_CoworkerBookingCredit_UpdatedOn date
?To_CoworkerBookingCredit_UpdatedOn=2010-01-01T20:32
From_CoworkerBookingCredit_UpdatedOn date
?From_CoworkerBookingCredit_UpdatedOn=2010-01-01T20:32
To_CoworkerBookingCredit_RemainingCredit number
?To_CoworkerBookingCredit_RemainingCredit=0
From_CoworkerBookingCredit_RemainingCredit number
?From_CoworkerBookingCredit_RemainingCredit=10
To_CoworkerBookingCredit_TotalCredit number
?To_CoworkerBookingCredit_TotalCredit=0
From_CoworkerBookingCredit_TotalCredit number
?From_CoworkerBookingCredit_TotalCredit=10
To_CoworkerBookingCredit_ExpireDate date
?To_CoworkerBookingCredit_ExpireDate=2010-01-01T20:32
From_CoworkerBookingCredit_ExpireDate date
?From_CoworkerBookingCredit_ExpireDate=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "Description": "Abc123456",
        "TariffBookingCredit": ,
        "RemainingCredit": 1.2,
        "TotalCredit": 1.2,
        "ExpireDate": ,
        "CaneBeUsedForEvents": false,
        "CoworkerBookingCreditTariffBookingCreditName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6550ff03-6a9d-4002-8f3b-30564e8bc782",
        "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 CoworkerBookingCredits by IDs

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

πŸ”’ Requires role "CoworkerBookingCredit-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "Description": "Abc123456",
        "TariffBookingCredit": ,
        "RemainingCredit": 1.2,
        "TotalCredit": 1.2,
        "ExpireDate": ,
        "CaneBeUsedForEvents": false,
        "CoworkerBookingCreditTariffBookingCreditName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6de6da72-336c-4d6e-910f-e8e9905a1c8e",
        "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 CoworkerBookingCredit by Id

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

πŸ”’ Requires role "CoworkerBookingCredit-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CaneBeUsedForEvents": false,
  "CoworkerId": 12345678,
  "Description": "Abc123456",
  "ExpireDate": ,
  "RemainingCredit": 1.2,
  "TariffBookingCreditId": 12345678,
  "TotalCredit": 1.2,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "ff005e4c-1a3e-45b4-99c9-ed31ae376ef5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerBookingCredit

Creates a new coworkerbookingcredit.
POST https://spaces.nexudus.com/api/billing/coworkerbookingcredits

πŸ”’ Requires role "CoworkerBookingCredit-Create"

Body parameters
CoworkerId: number required
BusinessId: number required
Description: string optional
TotalCredit: decimal required
ExpireDate: DateTime? optional
CaneBeUsedForEvents: bool optional

Example request

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

{
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "Description": "Abc123456",
    "ElegibleResourceTypes": [12345678, 87654321],
    "TotalCredit": 1.2,
    "ExpireDate": ,
    "CaneBeUsedForEvents": false,
    "EventCategories": [12345678, 87654321],
}


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 CoworkerBookingCredit

Updates an existing coworkerbookingcredit.
PUT https://spaces.nexudus.com/api/billing/coworkerbookingcredits

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

πŸ”’ Requires role "CoworkerBookingCredit-Edit"

Body parameters
Id: number required
The unique Id of the coworkerbookingcredit to update.
CoworkerId: number cleared if missing
BusinessId: number cleared if missing
Description: string cleared if missing
TotalCredit: decimal cleared if missing
ExpireDate: DateTime? cleared if missing
CaneBeUsedForEvents: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "Description": "Abc123456",
    "ElegibleResourceTypes": [12345678, 87654321],
    "TotalCredit": 1.2,
    "ExpireDate": ,
    "CaneBeUsedForEvents": false,
    "EventCategories": [12345678, 87654321],
}


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 CoworkerBookingCredit

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

πŸ”’ Requires role "CoworkerBookingCredit-Delete"

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

Example request

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

Example request

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

Example request

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