Work | Report Misc Cost

Service to manage entities of type 'WorkOrderReportMiscCost'.

Overview

URL	api/{tenantKey}/{orgKey}/maintenance/workOrderReportMiscCosts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET WorkOrderReportMiscCosts (odata)
  • GET WorkOrderReportMiscCost by identifier
  • GET WorkOrderReportMiscCost by key
• POST:
  • POST WorkOrderReportMiscCosts
  • POST Update Work Order Report Misc Cost Info
• PUT:
  • PUT Set Custom Attribute WorkOrderReportMiscCost
  • PUT Set IsActive WorkOrderReportMiscCost
  • PUT Set WorkOrderReportMiscCostKey WorkOrderReportMiscCost
  • PUT Set AssetType WorkOrderReportMiscCost
  • PUT Set Location WorkOrderReportMiscCost
  • PUT Set Equipment WorkOrderReportMiscCost
  • PUT Set Tool WorkOrderReportMiscCost
  • PUT Set MaintenanceRoute WorkOrderReportMiscCost
  • PUT Set ReportDate WorkOrderReportMiscCost
  • PUT Set MiscCostDate WorkOrderReportMiscCost
  • PUT Set Employee WorkOrderReportMiscCost
  • PUT Set MinimumValue WorkOrderReportMiscCost
  • PUT Set MaxValue WorkOrderReportMiscCost
  • PUT Set Quantity WorkOrderReportMiscCost
  • PUT Set Value WorkOrderReportMiscCost
  • PUT Set Total WorkOrderReportMiscCost
  • PUT Set Remarks WorkOrderReportMiscCost
  • PUT Set Company WorkOrderReportMiscCost
  • PUT Set MiscCostsType WorkOrderReportMiscCost
  • PUT Set MiscCost WorkOrderReportMiscCost
  • PUT Set IsLocked WorkOrderReportMiscCost
  • PUT Set WorkOrderMaintenancePlan WorkOrderReportMiscCost
  • PUT Set WOMaintenancePlanId WorkOrderReportMiscCost
  • PUT Set WOMaintenancePlanTaskId WorkOrderReportMiscCost
  • PUT Set WOTaskId WorkOrderReportMiscCost
  • PUT Set Task WorkOrderReportMiscCost
• DELETE:
  • DELETE WorkOrderReportMiscCost by identifier
  • DELETE WorkOrderReportMiscCost by key

All Resources

This service uses the following resources:

• ApiWorkOrderReportMiscCostResource
• MoneyResource
• WorkOrderReportMiscCostInfoResource
• WorkOrderReportMiscCostResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• ReportAssetType

GET Operations

GET WorkOrderReportMiscCosts (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 WorkOrderReportMiscCostResource.

Response status codes:

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

Resource URL:

GET WorkOrderReportMiscCost 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 WorkOrderReportMiscCostResource.

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 WorkOrderReportMiscCost by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderReportMiscCostKey	(string) Report Misc Cost.

Response:

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

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:

POST Operations

POST WorkOrderReportMiscCosts

Creates a new entity record.

The following elements are required:

workOrderReportMiscCostResource

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

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 ApiWorkOrderReportMiscCostResource.

Response status codes:

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

Resource URL:

POST Update Work Order Report Misc Cost Info

Custom operation 'UpdateWorkOrderReportMiscCostInfo'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderReportMiscCostKey	(string) WorkOrderReportMiscCostKey.
workOrderReportMiscCostInfo	(WorkOrderReportMiscCostInfoResource) WorkOrderReportMiscCostInfo.

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 a resource of type 'WorkOrderReportMiscCostInfoResource'. See WorkOrderReportMiscCostInfoResource.

Resource URL:

PUT Operations

PUT Set AssetType WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(enum ReportAssetType) The request body should contain the new value for the attribute. See ReportAssetType.

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 Set Company WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Employee WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Equipment WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set IsActive WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set IsLocked WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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.

Resource URL:

PUT Set Location WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set MaintenanceRoute WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set MaxValue WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set MinimumValue WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set MiscCost WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set MiscCostDate WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(DateTimeOffset) 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 Set MiscCostsType WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Quantity WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Remarks WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set ReportDate WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(DateTimeOffset) 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 Set Task WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Tool WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Total WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set Value WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set WOMaintenancePlanId WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(Guid) 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 Set WOMaintenancePlanTaskId WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(Guid) 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 Set WorkOrderMaintenancePlan WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set WorkOrderReportMiscCostKey WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
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 Set WOTaskId WorkOrderReportMiscCost

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

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
companyKey	(string) The company key.
value	(Guid) 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 Set Custom Attribute WorkOrderReportMiscCost

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

The following elements are required:

companyKey	(string) The company key.
workOrderReportMiscCostKey	(string) Report Misc Cost
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:

DELETE Operations

DELETE WorkOrderReportMiscCost 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 WorkOrderReportMiscCost by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderReportMiscCostKey	(string) Report Misc Cost.

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:

Resources

ApiWorkOrderReportMiscCostResource

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
workOrder	(string) Work Order.
assetType	(enum ReportAssetType) Type. See ReportAssetType.
employee	(string) Employee.
minimumValue	(MoneyResource) Min. Value. See MoneyResource .
maxValue	(MoneyResource) Max. Value. See MoneyResource .
quantity	(decimal) Quantity.
value	(MoneyResource) Value. See MoneyResource .
total	(MoneyResource) Total. See MoneyResource .
currency	(string) Currency.
exchangeRate	(decimal) Exchange Rate.
company	(string) Company.
miscCost	(string) Misc Cost.
isLocked	(bool) Is Locked.

The following elements are optional:

location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
maintenanceRoute	(string) Route.
reportDate	(DateTimeOffset) Report Date.
miscCostDate	(DateTimeOffset) Misc Cost Date.
remarks	(string) Remarks.
exchangeRateDate	(DateTime) Exchange Rate Date.
miscCostsType	(string) Misc Costs Type.
workOrderMaintenancePlan	(string) Maintenance Plan.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.
task	(string) Task.

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.

WorkOrderReportMiscCostInfoResource

The following elements are required:

employee	(string) Employee.
miscCost	(string) Misc Cost.
quantity	(decimal) Quantity.
value	(MoneyResource) Value. See MoneyResource .

The following elements are optional:

miscCostDate	(DateTimeOffset) Misc Cost Date.
miscCostsType	(string) Misc Costs Type.
remarks	(string) Remarks.
workOrderMaintenancePlan	(string) Maintenance Plan.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.
task	(string) Task.

WorkOrderReportMiscCostResource

The following elements are required:

workOrderReportMiscCostKey	(string) Report Misc Cost.
workOrder	(string) Work Order. (fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
assetType	(enum ReportAssetType) Type. See ReportAssetType.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
minimumValue	(MoneyResource) Min. Value. See MoneyResource .
maxValue	(MoneyResource) Max. Value. See MoneyResource .
quantity	(decimal) Quantity.
value	(MoneyResource) Value. See MoneyResource .
total	(MoneyResource) Total. 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.
exchangeRate	(decimal) Exchange Rate.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
miscCost	(string) Misc Cost. (fk) Allowed value: the natural key of a record of type MiscCost. These records are accessibly through the MiscCosts service.
isLocked	(bool) Is Locked.

The following elements are optional:

location	(string) Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
equipment	(string) Equipment. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
tool	(string) Tool. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
maintenanceRoute	(string) Route. (fk) Allowed value: the natural key of a record of type Route. These records are accessibly through the Routes service.
reportDate	(DateTimeOffset) Report Date.
miscCostDate	(DateTimeOffset) Misc Cost Date.
remarks	(string) Remarks.
exchangeRateDate	(DateTime) Exchange Rate Date.
miscCostsType	(string) Misc Costs Type. (fk) Allowed value: the natural key of a record of type MiscCostsType. These records are accessibly through the MiscCostsTypes service.
workOrderMaintenancePlan	(string) Maintenance Plan. (fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.
task	(string) Task. (fk) Allowed value: the natural key of a record of type Activity. These records are accessibly through the Activities service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ReportAssetType

1	Location
2	Equipment
3	Tool