Valuekeep Developers - Web API Reference

Work | Misc Costs Type

Service to manage entities of type 'MiscCostsType'.

Overview


URL api/{tenantKey}/{orgKey}/maintenanceCore/miscCostsTypes
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET MiscCostsTypes (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See MiscCostsTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /maintenanceCore/miscCostsTypes/odata

GET MiscCostsType by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See MiscCostsTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /maintenanceCore/miscCostsTypes/{id}

GET MiscCostsType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
miscCostTypeKey (string) Misc Cost Type.

Response:

When successful, the response body contains the entity record. See MiscCostsTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}

POST Operations

POST MiscCostsTypes

Creates a new entity record.

The following elements are required:

miscCostsTypeResource (ApiMiscCostsTypeResource) The request body should contain the entity record that should be created.
See ApiMiscCostsTypeResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiMiscCostsTypeResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /maintenanceCore/miscCostsTypes

PUT Operations

PUT Set Company MiscCostsType

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/company

PUT Set Currency MiscCostsType

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/currency

PUT Set DefaultValue MiscCostsType

Updates the value of attribute 'DefaultValue' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/defaultValue

PUT Set Description MiscCostsType

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/description

PUT Set IsActive MiscCostsType

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/isActive

PUT Set MaxValue MiscCostsType

Updates the value of attribute 'MaxValue' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/maxValue

PUT Set MinValue MiscCostsType

Updates the value of attribute 'MinValue' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/minValue

PUT Set MiscCost MiscCostsType

Updates the value of attribute 'MiscCost' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/miscCost

PUT Set MiscCostTypeKey MiscCostsType

Updates the value of attribute 'MiscCostTypeKey' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/miscCostTypeKey

PUT Set Remarks MiscCostsType

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/remarks

PUT Set Custom Attribute MiscCostsType

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
miscCostTypeKey (string) Misc Cost Type
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}/{customAttributeName}

DELETE Operations

DELETE MiscCostsType by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /maintenanceCore/miscCostsTypes/{id}

DELETE MiscCostsType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
miscCostTypeKey (string) Misc Cost Type.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /maintenanceCore/miscCostsTypes/{companyKey}/{miscCostTypeKey}

Resources


ApiMiscCostsTypeResource

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
description (string) Description.
miscCost (string) Misc Cost.
maxValue (MoneyResource) Max. Value.
See MoneyResource .
minValue (MoneyResource) Min. Value.
See MoneyResource .
defaultValue (MoneyResource) Default Value.
See MoneyResource .
currency (string) Currency.
company (string) Company.

The following elements are optional:

remarks (string) Remarks.


MiscCostsTypeResource

The following elements are required:

miscCostTypeKey (string) Misc Cost Type.
description (string) Description.
miscCost (string) Misc Cost.
(fk) Allowed value: the natural key of a record of type MiscCost. These records are accessibly through the MiscCosts service.
maxValue (MoneyResource) Max. Value.
See MoneyResource .
minValue (MoneyResource) Min. Value.
See MoneyResource .
defaultValue (MoneyResource) Default Value.
See MoneyResource .
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

remarks (string) Remarks.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.