Services

Update a service

Updates a service (send only the fields to change).

Tool
filmo_services_update
Access: Write

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_services_update",
    "arguments": {
      "serviceId": "serv_8f2a1c"
    }
  }
}

generated from the schema

It includes the rate, the travel times and the expenses passed on by default —of which only the PRICE goes in, not the cost—. Lists replace the existing one. Returns the updated service.

Arguments

serviceIdstringRequired

Service identifier.

Limits: min length 1

namestring

Customer-facing service name.

Limits: min length 2

descriptionstring | null

Service description; null clears it.

serviceTypestring

Service type.

Available options: crew, fleet, general

showInPlannerboolean

Whether it appears as a plannable service.

defaultQtyinteger

Default quantity.

Limits: min 1

breakMinutesinteger

Break deducted from the work day, in minutes.

Limits: min 0

orderInfostring

Information printed on the order and on the delivery note.

priceConfigobject

Service rate.

Show child attributes
priceConfig.hourlyRatenumber

Price per hour.

Limits: min 0

priceConfig.fixedPricenumber

Fixed price per service.

Limits: min 0

priceConfig.perKmRatenumber

Price per kilometre.

Limits: min 0

includeInPriceboolean

Whether its amount counts towards the document total.

distancePolicystring

How the billable distance is calculated.

travelTimeBeforeinteger

Travel time before, in minutes.

Limits: min 0

travelTimeAfterinteger

Travel time after, in minutes.

Limits: min 0

usagePeriodPolicyobject

Window in which it is used.

Show child attributes
usagePeriodPolicy.inheritstringRequired

"order" inherits the dates of the order; "custom" uses the offsets below.

Available options: order, custom

usagePeriodPolicy.offsetBeforeMinutesinteger

Minutes before the order start.

Limits: min 0

usagePeriodPolicy.offsetAfterMinutesinteger

Minutes after the order end.

Limits: min 0

planningPeriodPolicyobject

Window in which it is planned.

Show child attributes
planningPeriodPolicy.inheritstringRequired

"order" inherits the dates of the order; "custom" uses the offsets below.

Available options: order, custom

planningPeriodPolicy.offsetBeforeMinutesinteger

Minutes before the order start.

Limits: min 0

planningPeriodPolicy.offsetAfterMinutesinteger

Minutes after the order end.

Limits: min 0

defaultExpensesobject

Expenses passed on by default. Only the price, not the cost. Merged with the stored ones: categories you omit are left unchanged, and each category keeps its stored cost.

Show child attributes
defaultExpenses.cateringobject

Meal allowances.

Show child attributes
defaultExpenses.catering.pricenumberRequired

What the customer is charged for this concept.

defaultExpenses.travelobject

Travel.

Show child attributes
defaultExpenses.travel.pricenumberRequired

What the customer is charged for this concept.

defaultExpenses.accommodationobject

Accommodation.

Show child attributes
defaultExpenses.accommodation.pricenumberRequired

What the customer is charged for this concept.

defaultExpenses.otherobject

Other expenses.

Show child attributes
defaultExpenses.other.pricenumberRequired

What the customer is charged for this concept.

requirementsobject[]

Required resources. Replaces the whole list.

Show child attributes
requirements.requiredResourceTypestringRequired

What is needed to provide it: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtyintegerRequired

How many are needed.

Limits: min 1

requirements.requiredTagsstring[]

Tags the assigned resource must have. E.g.: "Carné C".

Limits: max 20 items, each max length 100

collectionIdstring

Collection it belongs to.

tagsstring[]

Tags. Replaces the whole list.

imagesstring[]

Service image URLs.

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
idstring

Unique service identifier.

namestring

Service name as the customer sees it.

serviceTypestring

Type: crew (personnel), fleet (vehicles) or general.

descriptionstring | null

Description; null if it has none.

defaultQtyinteger

Quantity added to an order by default.

showInPlannerboolean

Whether it appears as a plannable service.

includeInPriceboolean

Whether its amount counts towards the document total.

collectionNamestring | null

Path of the collection it belongs to; null if it is in none.

tagsobject[]

Service tags, with their identifier and name.

Show child attributes
tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

requirementsobject[]

Resources needed to provide it.

Show child attributes
requirements.requiredResourceTypestring

What is needed to provide it: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtyinteger

How many are needed.

Limits: min 1

requirements.requiredTagsstring[]

Tags the assigned resource must have. E.g.: "Carné C".

Limits: max 20 items, each max length 100

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/services/{serviceId}.

  • Services

    Update a service

    Updates a service (send only the fields to change).

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.