PATCH /other-costs/{otherCostId}

Update a Other Cost

This endpoint allows you to update an Other Cost. Only users with the role "admin" or "manager" can perform this operation.

Operation ID: updateOtherCost

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name	Type	Description
`otherCostId` required path	string	The Other Cost ID

Request Body

Content-Type: application/json

name string

The name (or description) of the Other Cost

Example: Contractual Labor

input_type string

The type of Other Cost. Different types of Other Costs have different associated fields. Other Costs of type resource will measure its total cost based on how long (e.g. hours, minutes) the resource is occupied. Other Costs of type distance will measure its total cost based on how many units (e.g. meters, kilometers) are needed. Other Costs of type interval and time_range will measure its total cost based on duration. Other Costs of type currency will have a fixed cost manually defined for each operation. Other Costs of type custom_unit_of_measurement will measure its total cost based on how many units (e.g. m3, liters) are needed.

currency distance interval time_range resource custom_unit_of_measurement

Example: currency

failure boolean

Indicates if the Other Cost can be included in costs for Corrective Maintenance (Work Orders)

Example: 1

schedule_work boolean | null

Indicates if the Other Cost can be included in costs for Preventive Maintenance (Planned Job Orders)

Example: 1

operator boolean | null

Indicates if the Other Cost can be included in individual costs for operators (technicians)

Example: 1

element boolean | null

Indicates if the Other Cost can be included in costs for Assets

Example: 1

icon string

The icon to be presented for the Other Cost in Infraspeak platform.

truck car clock-o bed user usd cutlery wrench

Example: truck

cost_per_unit number | null

Cost per unit of the Other Cost. Only applicable if input_type is "resource", "distance" or "custom_unit_of_measurement"

default_sell_price number | null

Default sell price of the Other Cost. Only applicable if input_type is "resource", "distance" or "custom_unit_of_measurement"

default_sell_vat number | null

Default sale VAT/IVA percentage of the Other Cost. Only applicable if input_type is "resource", "distance" or "custom_unit_of_measurement"

unit string | null

Unit of the Other Cost. Only applicable if input_type is "resource", "distance" or "custom_unit_of_measurement"

Responses

data object

Other Cost model structure details

id string required read-only

The ID of the Other Cost

Example: 123

type string required read-only

Model type

other-cost

Example: other-cost

attributes object required

other_cost_id integer read-only

The ID of the Other Cost

Example: 123

entity_id integer read-only

The ID of the Entity

Example: 123

input_type string

currency distance interval time_range resource custom_unit_of_measurement

Example: currency

name string

The name (or description) of the Other Cost

Example: Contractual Labor

failure boolean

Indicates if the Other Cost can be included in costs for Corrective Maintenance (Work Orders)

Example: 1

schedule_work boolean | null

Indicates if the Other Cost can be included in costs for Preventive Maintenance (Planned Job Orders)

Example: 1

operator boolean | null

Indicates if the Other Cost can be included in individual costs for operators (technicians)

Example: 1

icon string

The icon to be presented for the Other Cost in Infraspeak platform.

truck car clock-o bed user usd cutlery wrench

Example: truck

element boolean | null

Indicates if the Other Cost can be included in costs for Assets

Example: 1

cost_per_unit number | null

Cost per unit of the Other Cost. Specific for input_type "resource", "distance" or "custom_unit_of_measurement"

Example: 2.5

default_sell_price number | null

Default sell price of the Other Cost. Specific for input_type "resource", "distance" or "custom_unit_of_measurement"

Example: 4

default_sell_vat number | null

Default sale VAT/IVA percentage of the Other Cost. Specific for input_type "resource", "distance" or "custom_unit_of_measurement"

Example: 23

unit string | null

Unit of the Other Cost. Specific for input_type "resource", "distance" or "custom_unit_of_measurement"

relationships object

The relationships of the Other Cost (Only present when expanded in the request)

customClientPrices object

The Custom Client Prices associated with the Other Cost

entity object

The Entity where the Other Cost belongs

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

otherCostId

Request Body

PATCH https://api.sandbox.infraspeak.com/v3/other-costs/{otherCostId}

curl -X PATCH \
  'https://api.sandbox.infraspeak.com/v3/other-costs/{otherCostId}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '{
    "name": "Contractual Labor",
    "input_type": "currency",
    "failure": true,
    "schedule_work": true,
    "operator": true,
    "element": true,
    "icon": "truck",
    "cost_per_unit": 0,
    "default_sell_price": 0,
    "default_sell_vat": 0,
    "unit": ""
}'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/other-costs/{otherCostId}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify({
    "name": "Contractual Labor",
    "input_type": "currency",
    "failure": true,
    "schedule_work": true,
    "operator": true,
    "element": true,
    "icon": "truck",
    "cost_per_unit": 0,
    "default_sell_price": 0,
    "default_sell_vat": 0,
    "unit": ""
}),
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->patch('https://api.sandbox.infraspeak.com/v3/other-costs/{otherCostId}',
    array (
      'name' => 'Contractual Labor',
      'input_type' => 'currency',
      'failure' => true,
      'schedule_work' => true,
      'operator' => true,
      'element' => true,
      'icon' => 'truck',
      'cost_per_unit' => 0,
      'default_sell_price' => 0,
      'default_sell_vat' => 0,
      'unit' => '',
    )
  );

import requests

response = requests.patch(
    'https://api.sandbox.infraspeak.com/v3/other-costs/{otherCostId}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        {
            "name": "Contractual Labor",
            "input_type": "currency",
            "failure": true,
            "schedule_work": true,
            "operator": true,
            "element": true,
            "icon": "truck",
            "cost_per_unit": 0,
            "default_sell_price": 0,
            "default_sell_vat": 0,
            "unit": ""
        }
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "123",
        "type": "other-cost",
        "attributes": {
            "other_cost_id": 123,
            "entity_id": 123,
            "input_type": "currency",
            "name": "Contractual Labor",
            "failure": true,
            "schedule_work": true,
            "operator": true,
            "icon": "truck",
            "element": true,
            "cost_per_unit": 2.5,
            "default_sell_price": 4,
            "default_sell_vat": 23,
            "unit": "string"
        },
        "relationships": {
            "customClientPrices": {},
            "entity": {}
        }
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}