CostAdjustment

Returns a list of cost adjustments.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>
Responses
get/api/v1/businessUnits/{businessUnitId}/costAdjustments
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates cost adjustment
This call creates a new cost adjustment.


Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
The business unit id.


 
Request Body schema: 
required
The cost adjustment to be created.


code
required
string  non-empty 
The cost adjustment code.


 
description
string or null
The cost adjustment description.


 
applyCost
boolean or null
whether cost values (based on rates and/or entry) 
are generated by that cost adjustment entity.
default is true


 
applyToAllHours
boolean or null
Whether to apply cost against attendance hours 
in addition to working hours.
default is false


 
isTaxable
boolean or null
Whether the cost adjustment is taxable.
default is true


 
isActive
boolean or null
Whether the cost adjustment is active.


 
type
required
string (CostAdjustmentType) 
 Enum: "undefined" "hour" "day" "dollar" "quantity"  
accountingCode
string or null
The accounting code.


 
Responses 
post/api/v1/businessUnits/{businessUnitId}/costAdjustments
Request samples 
{
  • "code": "CostAdjustment",
  • "description": "Cost Adjustment Description",
  • "applyToAllHours": false,
  • "isTaxable": true,
  • "isActive": true,
  • "type": "quantity",
  • "accountingCode": "Accounting Code"
}
Response samples 
application/json
{
  • "id": "ff76af83-e765-4a81-bd3d-427e1c640bac",
  • "businessUnitId": "93bfd2f6-400e-47cd-82bb-45c62c3b23e5",
  • "code": "CostAdjustment",
  • "description": "Cost Adjustment Description",
  • "applyCost": true,
  • "applyToAllHours": false,
  • "isTaxable": true,
  • "isActive": true,
  • "type": "quantity",
  • "accountingCode": "Accounting Code"
}
Updates an existing cost adjustment by its id.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The id of the existing cost adjustment.


 
Request Body schema: 
required
The new parameters for the cost adjustment.


code
required
string  non-empty 
The cost adjustment code.


 
description
string or null
The cost adjustment description.


 
applyCost
boolean or null
whether cost values (based on rates and/or entry) 
are generated by that cost adjustment entity.
default is true


 
applyToAllHours
boolean or null
Whether to apply cost against attendance hours 
in addition to working hours.
default is false


 
isTaxable
boolean or null
Whether the cost adjustment is taxable.
default is true


 
isActive
boolean or null
Whether the cost adjustment is active.


 
type
required
string (CostAdjustmentType) 
 Enum: "undefined" "hour" "day" "dollar" "quantity"  
accountingCode
string or null
The accounting code.


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


put/api/v1/costAdjustments/{id}
Request samples 
{
  • "code": "CostAdjustment",
  • "description": "Cost Adjustment Description",
  • "applyToAllHours": false,
  • "isTaxable": true,
  • "isActive": true,
  • "type": "quantity",
  • "accountingCode": "Accounting Code"
}
Deletes a cost adjustment by its id.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The cost adjustment id


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


delete/api/v1/costAdjustments/{id}
Request samples