Reference

Coworkercontract

The coworkercontract object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkercontract
Active: bool optional read-only
ApplyProRating: bool optional
BillingDay: int required
CancellationDate: DateTime? optional
CancellationLimitDays: int? optional
CancellationNotes: string optional
CancellationReason: Nexudus.Coworking.Core.Enums.eCancellationReason? optional
Cancelled: bool optional read-only
CancelTeamContracts: bool optional
ContractTerm: DateTime? optional
CoworkerId: Id required
FloorPlanDeskIds: string optional
FloorPlanDeskNames: string optional
IncludeSignupFee: bool optional
InvoiceAdvancedCycles: bool optional
InvoicedPeriod: DateTime? optional
IssuedById: Id required
MainContract: bool optional read-only
NextAutoInvoice: DateTime? optional
NextTariffId: Id optional
Notes: string optional
Price: decimal? optional
PricePlanTermsAccepted: bool optional
PricePlanTermsAcceptedOn: DateTime? optional read-only
ProposalUniqueId: Guid? optional
ProRateCancellation: bool optional
Quantity: int required
RenewalDate: DateTime? optional
StartDate: DateTime? optional
TariffId: Id required
Value: decimal? optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkercontract
SystemId: string optional api-only
User defined data about this coworkercontract. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "ApplyProRating": false,
  "BillingDay": ,
  "CancellationDate": ,
  "CancellationLimitDays": ,
  "CancellationNotes": "Notes",
  "CancellationReason": 1,
  "Cancelled": false,
  "CancelTeamContracts": false,
  "ContractTerm": ,
  "CoworkerId": 12345678,
  "FloorPlanDeskIds": "Abc123456",
  "FloorPlanDeskNames": "Abc123456",
  "IncludeSignupFee": false,
  "InvoiceAdvancedCycles": false,
  "InvoicedPeriod": ,
  "IssuedById": 12345678,
  "MainContract": false,
  "NextAutoInvoice": ,
  "NextTariffId": 12345678,
  "Notes": "Notes",
  "Price": ,
  "PricePlanTermsAccepted": false,
  "PricePlanTermsAcceptedOn": ,
  "ProposalUniqueId": ,
  "ProRateCancellation": false,
  "Quantity": ,
  "RenewalDate": ,
  "StartDate": ,
  "TariffId": 12345678,
  "Value": ,
  "UniqueId": "2651a68d-865b-46c1-9b87-fa3d3f996e46",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerContract

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

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

๐Ÿ”’ Requires role "CoworkerContract-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 coworkercontract records based on their different properties.
Id number
?Id=12345678
CoworkerContract_Active bool
?CoworkerContract_Active=...
CoworkerContract_ApplyProRating bool
?CoworkerContract_ApplyProRating=...
CoworkerContract_BillingDay int
?CoworkerContract_BillingDay=...
CoworkerContract_CancellationDate DateTime?
?CoworkerContract_CancellationDate=...
CoworkerContract_CancellationLimitDays int?
?CoworkerContract_CancellationLimitDays=...
CoworkerContract_CancellationNotes string
?CoworkerContract_CancellationNotes=...
CoworkerContract_CancellationReason Nexudus.Coworking.Core.Enums.eCancellationReason?
?CoworkerContract_CancellationReason=...
CoworkerContract_Cancelled bool
?CoworkerContract_Cancelled=...
CoworkerContract_CancelTeamContracts bool
?CoworkerContract_CancelTeamContracts=...
CoworkerContract_ContractTerm DateTime?
?CoworkerContract_ContractTerm=...
CoworkerContract_Coworker Coworker
?CoworkerContract_Coworker=...
CoworkerContract_FloorPlanDeskIds string
?CoworkerContract_FloorPlanDeskIds=...
CoworkerContract_FloorPlanDeskNames string
?CoworkerContract_FloorPlanDeskNames=...
CoworkerContract_IncludeSignupFee bool
?CoworkerContract_IncludeSignupFee=...
CoworkerContract_InvoiceAdvancedCycles bool
?CoworkerContract_InvoiceAdvancedCycles=...
CoworkerContract_InvoicedPeriod DateTime?
?CoworkerContract_InvoicedPeriod=...
CoworkerContract_IssuedBy Business
?CoworkerContract_IssuedBy=...
CoworkerContract_MainContract bool
?CoworkerContract_MainContract=...
CoworkerContract_NextAutoInvoice DateTime?
?CoworkerContract_NextAutoInvoice=...
CoworkerContract_NextTariff Tariff
?CoworkerContract_NextTariff=...
CoworkerContract_Notes string
?CoworkerContract_Notes=...
CoworkerContract_Price decimal?
?CoworkerContract_Price=...
CoworkerContract_PricePlanTermsAccepted bool
?CoworkerContract_PricePlanTermsAccepted=...
CoworkerContract_PricePlanTermsAcceptedOn DateTime?
?CoworkerContract_PricePlanTermsAcceptedOn=...
CoworkerContract_ProposalUniqueId Guid?
?CoworkerContract_ProposalUniqueId=...
CoworkerContract_ProRateCancellation bool
?CoworkerContract_ProRateCancellation=...
CoworkerContract_Quantity int
?CoworkerContract_Quantity=...
CoworkerContract_RenewalDate DateTime?
?CoworkerContract_RenewalDate=...
CoworkerContract_StartDate DateTime?
?CoworkerContract_StartDate=...
CoworkerContract_Tariff Tariff
?CoworkerContract_Tariff=...
CoworkerContract_Value decimal?
?CoworkerContract_Value=...
CoworkerContract_IssuedByName string
?CoworkerContract_IssuedByName=...
CoworkerContract_CoworkerFullName string
?CoworkerContract_CoworkerFullName=...
CoworkerContract_CoworkerCompanyName string
?CoworkerContract_CoworkerCompanyName=...
CoworkerContract_CoworkerBillingName string
?CoworkerContract_CoworkerBillingName=...
CoworkerContract_CoworkerEmail string
?CoworkerContract_CoworkerEmail=...
CoworkerContract_TariffName string
?CoworkerContract_TariffName=...
CoworkerContract_TariffInvoiceEvery string
?CoworkerContract_TariffInvoiceEvery=...
CoworkerContract_TariffInvoiceEveryWeeks string
?CoworkerContract_TariffInvoiceEveryWeeks=...
CoworkerContract_TariffPrice string
?CoworkerContract_TariffPrice=...
CoworkerContract_TariffCurrency_Code string
?CoworkerContract_TariffCurrency_Code=...
CoworkerContract_NextTariffName string
?CoworkerContract_NextTariffName=...
CoworkerContract_Desks List of FloorPlanDesk
?CoworkerContract_Desks=...

Range search querystring parameters
Lets you search coworkercontract records based on a range of date or numeric values.
To_CoworkerContract_CreatedOn date
?To_CoworkerContract_CreatedOn=2010-01-01T20:32
From_CoworkerContract_CreatedOn date
?From_CoworkerContract_CreatedOn=2010-01-01T20:32
To_CoworkerContract_UpdatedOn date
?To_CoworkerContract_UpdatedOn=2010-01-01T20:32
From_CoworkerContract_UpdatedOn date
?From_CoworkerContract_UpdatedOn=2010-01-01T20:32
To_CoworkerContract_StartDate date
?To_CoworkerContract_StartDate=2010-01-01T20:32
From_CoworkerContract_StartDate date
?From_CoworkerContract_StartDate=2010-01-01T20:32
To_CoworkerContract_BillingDay number
?To_CoworkerContract_BillingDay=0
From_CoworkerContract_BillingDay number
?From_CoworkerContract_BillingDay=10
To_CoworkerContract_RenewalDate date
?To_CoworkerContract_RenewalDate=2010-01-01T20:32
From_CoworkerContract_RenewalDate date
?From_CoworkerContract_RenewalDate=2010-01-01T20:32
To_CoworkerContract_InvoicedPeriod date
?To_CoworkerContract_InvoicedPeriod=2010-01-01T20:32
From_CoworkerContract_InvoicedPeriod date
?From_CoworkerContract_InvoicedPeriod=2010-01-01T20:32
To_CoworkerContract_ContractTerm date
?To_CoworkerContract_ContractTerm=2010-01-01T20:32
From_CoworkerContract_ContractTerm date
?From_CoworkerContract_ContractTerm=2010-01-01T20:32
To_CoworkerContract_Price number
?To_CoworkerContract_Price=0
From_CoworkerContract_Price number
?From_CoworkerContract_Price=10
To_CoworkerContract_Value number
?To_CoworkerContract_Value=0
From_CoworkerContract_Value number
?From_CoworkerContract_Value=10
To_CoworkerContract_Quantity number
?To_CoworkerContract_Quantity=0
From_CoworkerContract_Quantity number
?From_CoworkerContract_Quantity=10
To_CoworkerContract_NextAutoInvoice date
?To_CoworkerContract_NextAutoInvoice=2010-01-01T20:32
From_CoworkerContract_NextAutoInvoice date
?From_CoworkerContract_NextAutoInvoice=2010-01-01T20:32
To_CoworkerContract_PricePlanTermsAcceptedOn date
?To_CoworkerContract_PricePlanTermsAcceptedOn=2010-01-01T20:32
From_CoworkerContract_PricePlanTermsAcceptedOn date
?From_CoworkerContract_PricePlanTermsAcceptedOn=2010-01-01T20:32
To_CoworkerContract_CancellationDate date
?To_CoworkerContract_CancellationDate=2010-01-01T20:32
From_CoworkerContract_CancellationDate date
?From_CoworkerContract_CancellationDate=2010-01-01T20:32
To_CoworkerContract_CancellationLimitDays number
?To_CoworkerContract_CancellationLimitDays=0
From_CoworkerContract_CancellationLimitDays number
?From_CoworkerContract_CancellationLimitDays=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "IssuedBy": ,
        "Coworker": ,
        "Tariff": ,
        "NextTariff": ,
        "Notes": "Notes",
        "StartDate": ,
        "BillingDay": ,
        "RenewalDate": ,
        "InvoicedPeriod": ,
        "ContractTerm": ,
        "Price": ,
        "Value": ,
        "Quantity": ,
        "Active": false,
        "MainContract": false,
        "Cancelled": false,
        "IncludeSignupFee": false,
        "InvoiceAdvancedCycles": false,
        "ApplyProRating": false,
        "NextAutoInvoice": ,
        "PricePlanTermsAccepted": false,
        "PricePlanTermsAcceptedOn": ,
        "CancellationDate": ,
        "CancellationLimitDays": ,
        "ProRateCancellation": false,
        "CancelTeamContracts": false,
        "CancellationReason": 1,
        "CancellationNotes": "Notes",
        "ProposalUniqueId": ,
        "FloorPlanDeskIds": "Abc123456",
        "FloorPlanDeskNames": "Abc123456",
        "CoworkerContractIssuedByName": "...",
        "CoworkerContractCoworkerFullName": "...",
        "CoworkerContractCoworkerCompanyName": "...",
        "CoworkerContractCoworkerBillingName": "...",
        "CoworkerContractCoworkerEmail": "...",
        "CoworkerContractTariffName": "...",
        "CoworkerContractTariffInvoiceEvery": "...",
        "CoworkerContractTariffInvoiceEveryWeeks": "...",
        "CoworkerContractTariffPrice": "...",
        "CoworkerContractTariffCurrency_Code": "...",
        "CoworkerContractNextTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "08bfb8b2-407e-4d89-913f-fff0c2269b94",
        "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 CoworkerContracts by IDs

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

๐Ÿ”’ Requires role "CoworkerContract-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "IssuedBy": ,
        "Coworker": ,
        "Tariff": ,
        "NextTariff": ,
        "Notes": "Notes",
        "StartDate": ,
        "BillingDay": ,
        "RenewalDate": ,
        "InvoicedPeriod": ,
        "ContractTerm": ,
        "Price": ,
        "Value": ,
        "Quantity": ,
        "Active": false,
        "MainContract": false,
        "Cancelled": false,
        "IncludeSignupFee": false,
        "InvoiceAdvancedCycles": false,
        "ApplyProRating": false,
        "NextAutoInvoice": ,
        "PricePlanTermsAccepted": false,
        "PricePlanTermsAcceptedOn": ,
        "CancellationDate": ,
        "CancellationLimitDays": ,
        "ProRateCancellation": false,
        "CancelTeamContracts": false,
        "CancellationReason": 1,
        "CancellationNotes": "Notes",
        "ProposalUniqueId": ,
        "FloorPlanDeskIds": "Abc123456",
        "FloorPlanDeskNames": "Abc123456",
        "CoworkerContractIssuedByName": "...",
        "CoworkerContractCoworkerFullName": "...",
        "CoworkerContractCoworkerCompanyName": "...",
        "CoworkerContractCoworkerBillingName": "...",
        "CoworkerContractCoworkerEmail": "...",
        "CoworkerContractTariffName": "...",
        "CoworkerContractTariffInvoiceEvery": "...",
        "CoworkerContractTariffInvoiceEveryWeeks": "...",
        "CoworkerContractTariffPrice": "...",
        "CoworkerContractTariffCurrency_Code": "...",
        "CoworkerContractNextTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "3a44fcc9-0683-4303-b112-c61f937d3156",
        "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 CoworkerContract by Id

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

๐Ÿ”’ Requires role "CoworkerContract-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Active": false,
  "ApplyProRating": false,
  "BillingDay": ,
  "CancellationDate": ,
  "CancellationLimitDays": ,
  "CancellationNotes": "Notes",
  "CancellationReason": 1,
  "Cancelled": false,
  "CancelTeamContracts": false,
  "ContractTerm": ,
  "CoworkerId": 12345678,
  "FloorPlanDeskIds": "Abc123456",
  "FloorPlanDeskNames": "Abc123456",
  "IncludeSignupFee": false,
  "InvoiceAdvancedCycles": false,
  "InvoicedPeriod": ,
  "IssuedById": 12345678,
  "MainContract": false,
  "NextAutoInvoice": ,
  "NextTariffId": 12345678,
  "Notes": "Notes",
  "Price": ,
  "PricePlanTermsAccepted": false,
  "PricePlanTermsAcceptedOn": ,
  "ProposalUniqueId": ,
  "ProRateCancellation": false,
  "Quantity": ,
  "RenewalDate": ,
  "StartDate": ,
  "TariffId": 12345678,
  "Value": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "ea0ee253-c277-4654-97e9-d99a1a076c6d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerContract

Creates a new coworkercontract.
POST https://spaces.nexudus.com/api/billing/coworkercontracts

๐Ÿ”’ Requires role "CoworkerContract-Create"

Body parameters
IssuedById: number required
CoworkerId: number required
TariffId: number required
Notes: string optional
StartDate: DateTime? optional
BillingDay: int required
Price: decimal? optional
Value: decimal? optional
Quantity: int required
InvoiceAdvancedCycles: bool optional
ApplyProRating: bool optional
PricePlanTermsAccepted: bool optional
CancellationDate: DateTime? optional
CancellationLimitDays: int? optional
ProRateCancellation: bool optional
CancelTeamContracts: bool optional
CancellationReason: Nexudus.Coworking.Core.Enums.eCancellationReason? optional
CancellationNotes: string optional
ProposalUniqueId: Guid? optional
FloorPlanDeskIds: string optional
FloorPlanDeskNames: string optional

Example request

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

{
    "IssuedById": 12345678,
    "CoworkerId": 12345678,
    "TariffId": 12345678,
    "Notes": "Notes",
    "StartDate": ,
    "BillingDay": ,
    "Price": ,
    "Value": ,
    "Desks": [12345678, 87654321],
    "Quantity": ,
    "InvoiceAdvancedCycles": false,
    "ApplyProRating": false,
    "PricePlanTermsAccepted": false,
    "CancellationDate": ,
    "CancellationLimitDays": ,
    "ProRateCancellation": false,
    "CancelTeamContracts": false,
    "CancellationReason": 1, //(check Enumerated values section below)
    "CancellationNotes": "Notes",
    "ProposalUniqueId": ,
    "FloorPlanDeskIds": "Abc123456",
    "FloorPlanDeskNames": "Abc123456",
}


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 CoworkerContract

Updates an existing coworkercontract.
PUT https://spaces.nexudus.com/api/billing/coworkercontracts

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

๐Ÿ”’ Requires role "CoworkerContract-Edit"

Body parameters
Id: number required
The unique Id of the coworkercontract to update.
IssuedById: number cleared if missing
CoworkerId: number cleared if missing
TariffId: number cleared if missing
NextTariffId: number cleared if missing
Notes: string cleared if missing
StartDate: DateTime? cleared if missing
BillingDay: int cleared if missing
RenewalDate: DateTime? cleared if missing
InvoicedPeriod: DateTime? cleared if missing
ContractTerm: DateTime? cleared if missing
Price: decimal? cleared if missing
Value: decimal? cleared if missing
Quantity: int cleared if missing
IncludeSignupFee: bool cleared if missing
InvoiceAdvancedCycles: bool cleared if missing
ApplyProRating: bool cleared if missing
NextAutoInvoice: DateTime? cleared if missing
PricePlanTermsAccepted: bool cleared if missing
CancellationDate: DateTime? cleared if missing
CancellationLimitDays: int? cleared if missing
ProRateCancellation: bool cleared if missing
CancelTeamContracts: bool cleared if missing
CancellationReason: Nexudus.Coworking.Core.Enums.eCancellationReason? cleared if missing
CancellationNotes: string cleared if missing
ProposalUniqueId: Guid? cleared if missing
FloorPlanDeskIds: string cleared if missing
FloorPlanDeskNames: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "IssuedById": 12345678,
    "CoworkerId": 12345678,
    "TariffId": 12345678,
    "Notes": "Notes",
    "StartDate": ,
    "BillingDay": ,
    "Price": ,
    "Value": ,
    "Desks": [12345678, 87654321],
    "Quantity": ,
    "InvoiceAdvancedCycles": false,
    "ApplyProRating": false,
    "PricePlanTermsAccepted": false,
    "CancellationDate": ,
    "CancellationLimitDays": ,
    "ProRateCancellation": false,
    "CancelTeamContracts": false,
    "CancellationReason": 1, //(check Enumerated values section below)
    "CancellationNotes": "Notes",
    "ProposalUniqueId": ,
    "FloorPlanDeskIds": "Abc123456",
    "FloorPlanDeskNames": "Abc123456",
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more coworkercontract 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 coworkercontract records.
GET https://spaces.nexudus.com/api/billing/coworkercontracts/commands

Example request

GET https://spaces.nexudus.com/api/billing/coworkercontracts/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 coworkercontract record IDs.
POST https://spaces.nexudus.com/api/billing/coworkercontracts/runacommand
๐Ÿ”’ Requires role "CoworkerContract-Edit"

Example request

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

CancellationReason

GET /api/utils/enums?name=eCancellationReason

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.