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

Reference

Contractdeposit

The contractdeposit object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this contractdeposit
CoworkerContractId: Id required
Credited: bool optional read-only
Invoiced: bool optional read-only
InvoicedOn: DateTime? optional read-only
Notes: string optional
Price: decimal? optional
ProductId: Id required
Refundable: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this contractdeposit
SystemId: string optional api-only
User defined data about this contractdeposit. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "CoworkerContractId": 12345678,
  "Credited": false,
  "Invoiced": false,
  "InvoicedOn": ,
  "Notes": "Notes",
  "Price": ,
  "ProductId": 12345678,
  "Refundable": false,
  "UniqueId": "38f702f6-1f88-4c9a-a84f-93c0e5c7340e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a ContractDeposit

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

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

🔒 Requires role "ContractDeposit-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 contractdeposit records based on their different properties.
Id number
?Id=12345678
ContractDeposit_CoworkerContract CoworkerContract
?ContractDeposit_CoworkerContract=...
ContractDeposit_Credited bool
?ContractDeposit_Credited=...
ContractDeposit_Invoiced bool
?ContractDeposit_Invoiced=...
ContractDeposit_InvoicedOn DateTime?
?ContractDeposit_InvoicedOn=...
ContractDeposit_Notes string
?ContractDeposit_Notes=...
ContractDeposit_Price decimal?
?ContractDeposit_Price=...
ContractDeposit_Product Product
?ContractDeposit_Product=...
ContractDeposit_Refundable bool
?ContractDeposit_Refundable=...
ContractDeposit_CoworkerContractQuantity string
?ContractDeposit_CoworkerContractQuantity=...
ContractDeposit_CoworkerContractFloorPlanDeskIds string
?ContractDeposit_CoworkerContractFloorPlanDeskIds=...
ContractDeposit_CoworkerContractFloorPlanDeskNames string
?ContractDeposit_CoworkerContractFloorPlanDeskNames=...
ContractDeposit_CoworkerContractTariff_Name string
?ContractDeposit_CoworkerContractTariff_Name=...
ContractDeposit_CoworkerContractCoworker_Id string
?ContractDeposit_CoworkerContractCoworker_Id=...
ContractDeposit_CoworkerContractCoworker_FullName string
?ContractDeposit_CoworkerContractCoworker_FullName=...
ContractDeposit_CoworkerContractCoworker_BillingName string
?ContractDeposit_CoworkerContractCoworker_BillingName=...
ContractDeposit_ProductName string
?ContractDeposit_ProductName=...
ContractDeposit_ProductPrice string
?ContractDeposit_ProductPrice=...
ContractDeposit_ProductCurrency_Code string
?ContractDeposit_ProductCurrency_Code=...

Range search querystring parameters
Lets you search contractdeposit records based on a range of date or numeric values.
To_ContractDeposit_CreatedOn date
?To_ContractDeposit_CreatedOn=2010-01-01T20:32
From_ContractDeposit_CreatedOn date
?From_ContractDeposit_CreatedOn=2010-01-01T20:32
To_ContractDeposit_UpdatedOn date
?To_ContractDeposit_UpdatedOn=2010-01-01T20:32
From_ContractDeposit_UpdatedOn date
?From_ContractDeposit_UpdatedOn=2010-01-01T20:32
To_ContractDeposit_Price number
?To_ContractDeposit_Price=0
From_ContractDeposit_Price number
?From_ContractDeposit_Price=10
To_ContractDeposit_InvoicedOn date
?To_ContractDeposit_InvoicedOn=2010-01-01T20:32
From_ContractDeposit_InvoicedOn date
?From_ContractDeposit_InvoicedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerContract": ,
        "Product": ,
        "Notes": "Notes",
        "Price": ,
        "Refundable": false,
        "Invoiced": false,
        "Credited": false,
        "InvoicedOn": ,
        "ContractDepositCoworkerContractQuantity": "...",
        "ContractDepositCoworkerContractFloorPlanDeskIds": "...",
        "ContractDepositCoworkerContractFloorPlanDeskNames": "...",
        "ContractDepositCoworkerContractTariff_Name": "...",
        "ContractDepositCoworkerContractCoworker_Id": "...",
        "ContractDepositCoworkerContractCoworker_FullName": "...",
        "ContractDepositCoworkerContractCoworker_BillingName": "...",
        "ContractDepositProductName": "...",
        "ContractDepositProductPrice": "...",
        "ContractDepositProductCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "a21376a8-93a6-4a5e-9939-1807a199db33",
        "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 ContractDeposits by IDs

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

🔒 Requires role "ContractDeposit-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerContract": ,
        "Product": ,
        "Notes": "Notes",
        "Price": ,
        "Refundable": false,
        "Invoiced": false,
        "Credited": false,
        "InvoicedOn": ,
        "ContractDepositCoworkerContractQuantity": "...",
        "ContractDepositCoworkerContractFloorPlanDeskIds": "...",
        "ContractDepositCoworkerContractFloorPlanDeskNames": "...",
        "ContractDepositCoworkerContractTariff_Name": "...",
        "ContractDepositCoworkerContractCoworker_Id": "...",
        "ContractDepositCoworkerContractCoworker_FullName": "...",
        "ContractDepositCoworkerContractCoworker_BillingName": "...",
        "ContractDepositProductName": "...",
        "ContractDepositProductPrice": "...",
        "ContractDepositProductCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "899ece66-72fa-4a93-ba6e-d172f0befcc9",
        "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 ContractDeposit by Id

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

🔒 Requires role "ContractDeposit-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CoworkerContractId": 12345678,
  "Credited": false,
  "Invoiced": false,
  "InvoicedOn": ,
  "Notes": "Notes",
  "Price": ,
  "ProductId": 12345678,
  "Refundable": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "49c7e5c7-9c9e-40cd-86f8-a147246051ff",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new ContractDeposit

Creates a new contractdeposit. 
POST https://spaces.nexudus.com/api/billing/contractdeposits

🔒 Requires role "ContractDeposit-Create"

Body parameters
CoworkerContractId: number required
ProductId: number required
Notes: string optional
Price: decimal? optional
Refundable: bool optional

Example request

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


{
    "CoworkerContractId": 12345678,
    "ProductId": 12345678,
    "Notes": "Notes",
    "Price": ,
    "Refundable": false,
}

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 ContractDeposit

Updates an existing contractdeposit. 
PUT https://spaces.nexudus.com/api/billing/contractdeposits

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

🔒 Requires role "ContractDeposit-Edit"

Body parameters
Id: number required
The unique Id of the contractdeposit to update.
CoworkerContractId: number cleared if missing
ProductId: number cleared if missing
Notes: string cleared if missing
Price: decimal? cleared if missing
Refundable: bool cleared if missing

Example request

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


{
    "Id": 12345678,
    "CoworkerContractId": 12345678,
    "ProductId": 12345678,
    "Notes": "Notes",
    "Price": ,
    "Refundable": false,
}

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 ContractDeposit

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

🔒 Requires role "ContractDeposit-Delete"

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

Example request

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

Example request

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

Example request

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