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

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services"

payload = {
    "name": "<string>",
    "external_id": "<string>",
    "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "billable_rate_per_minute_amount": 123,
    "memo": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    external_id: '<string>',
    account_identifier: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
    billable_rate_per_minute_amount: 123,
    memo: '<string>',
    metadata: {}
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'external_id' => '<string>',
    'account_identifier' => [
        'type' => 'AccountId',
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'billable_rate_per_minute_amount' => 123,
    'memo' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"account_identifier\": {\n    \"type\": \"AccountId\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"billable_rate_per_minute_amount\": 123,\n  \"memo\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"account_identifier\": {\n    \"type\": \"AccountId\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"billable_rate_per_minute_amount\": 123,\n  \"memo\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/catalog/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"account_identifier\": {\n    \"type\": \"AccountId\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"billable_rate_per_minute_amount\": 123,\n  \"memo\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "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",
    "type": "com.layerfi.routers.ApiService",
    "external_id": "<string>",
    "account_identifier": {
      "type": "AccountId",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "ledger_account": {
      "type": "Single_Chart_Account",
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "account_number": "4000",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "account_type": {
        "display_name": "Asset"
      },
      "account_subtype": {
        "display_name": "Current Assets"
      }
    },
    "billable_rate_per_minute_amount": 123,
    "memo": "<string>",
    "metadata": {},
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}
{
  "data": {
    "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",
    "type": "com.layerfi.routers.ApiService",
    "external_id": "<string>",
    "account_identifier": {
      "type": "AccountId",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "ledger_account": {
      "type": "Single_Chart_Account",
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "account_number": "4000",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "account_type": {
        "display_name": "Asset"
      },
      "account_subtype": {
        "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.

Body

application/json
​
name
string
required

The name of the service.

​
external_id
string | null

An optional external identifier for the service. If provided and a service with this external_id already exists, the existing service will be updated instead of creating a new one.

​
account_identifier
Account ID · object

The ledger account identifier for revenue tracking.

​
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 | null

Custom metadata for the service.

Response

Service already exists and was updated.

​
data
object
required