Update service

Partially updates a service. Only the fields provided in the request body will be updated.

PATCH /v1/businesses/{businessId}/catalog/services/{serviceId}

Update service

cURL

curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services/{serviceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "name": "<string>",
  "account_identifier": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "billable_rate_per_minute_amount": 123,
  "memo": "<string>",
  "metadata": {}
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "account_identifier": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ledger_account": {
    "id": {
      "type": "AccountId",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "name": "Current Assets",
    "account_number": "4000",
    "stable_name": {
      "type": "StableName",
      "stable_name": "CURRENT_ASSETS"
    },
    "normality": "CREDIT",
    "account_type": {
      "value": "ASSET",
      "display_name": "Asset"
    },
    "account_subtype": {
      "value": "BANK_ACCOUNTS",
      "display_name": "Current Assets"
    }
  },
  "billable_rate_per_minute_amount": 123,
  "memo": "<string>",
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId · string<uuid> · required

The UUID of the business.

serviceId · string<uuid> · required

The UUID of the service.

Body

application/json

Partial update parameters for a service. Only specified fields will be updated.

external_id · string | null

Update the external identifier for the service.

name · string

Update the name of the service.

account_identifier · Account ID · object

Update the ledger account identifier. Set to null to remove the account association.

Account ID

Account Stable Name

Show child attributes

billable_rate_per_minute_amount · integer<int64> | null

Update the billable rate per minute in cents.

memo · string | null

Update the memo.

metadata · object

Update the custom metadata.

Response

200

application/json

Service updated successfully.

id · string<uuid> · required

The unique identifier of the service.

business_id · string<uuid> · required

The UUID of the business this service belongs to.

name · string · required

The name of the service.

created_at · string<date-time> · required

Timestamp when the service was created.

updated_at · string<date-time> · required

Timestamp when the service was last updated.

external_id · string | null

An optional external identifier for the service, used for idempotency.

account_identifier · Account ID · object

The ledger account identifier for revenue tracking.

Account ID

Account Stable Name

Show child attributes

ledger_account · object

The ledger account associated with this service.

Show child attributes

billable_rate_per_minute_amount · integer<int64> | null

The billable rate per minute for this service in cents (e.g., 100 = $1.00 per minute or $60.00 per hour).

memo · string | null

Optional memo or notes about the service.

metadata · object

Custom metadata for the service.

deleted_at · string<date-time> | null

Timestamp when the service was deleted, or null if not deleted.