Skip to main content
PATCH
/
v1
/
categories
/
{id}
Update a Category
curl --request PATCH \
  --url https://api.bookeeping.ai/public-api/v1/categories/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "emoji": "<string>",
  "group": "<string>",
  "number": ""
}
'
import requests

url = "https://api.bookeeping.ai/public-api/v1/categories/{id}"

payload = {
    "name": "<string>",
    "emoji": "<string>",
    "group": "<string>",
    "number": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', emoji: '<string>', group: '<string>', number: ''})
};

fetch('https://api.bookeeping.ai/public-api/v1/categories/{id}', 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://api.bookeeping.ai/public-api/v1/categories/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'emoji' => '<string>',
    'group' => '<string>',
    'number' => ''
  ]),
  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://api.bookeeping.ai/public-api/v1/categories/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"emoji\": \"<string>\",\n  \"group\": \"<string>\",\n  \"number\": \"\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.bookeeping.ai/public-api/v1/categories/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"emoji\": \"<string>\",\n  \"group\": \"<string>\",\n  \"number\": \"\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.bookeeping.ai/public-api/v1/categories/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"emoji\": \"<string>\",\n  \"group\": \"<string>\",\n  \"number\": \"\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "emoji": "<string>",
    "isArchived": true,
    "number": "<string>",
    "group": "<string>"
  }
}
{
  "error": "BadRequestError",
  "message": "<string>"
}
{
  "error": "UnauthorizedError",
  "message": "<string>"
}
{
  "error": "ConflictError",
  "message": "<string>"
}
{
  "error": "TooManyRequestsError",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Path Parameters

id
string
required

The id of the category. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$

Body

application/json
name
string

The name of the category

emoji
string | null

The emoji of the category

group
string | null

The group of the category

parentCategory
enum<string>

The parent category of the category

Available options:
INCOME,
OTHER_INCOME,
SALES,
EXPENSE,
DEPRECIATION,
COST_OF_GOODS_SOLD,
OTHER_EXPENSE,
OVERHEAD,
CURRENT_ASSET,
FIXED_ASSET,
INVENTORY,
NON_CURRENT_ASSET,
PREPAYMENT,
LIABILITY,
CURRENT_LIABILITY,
NON_CURRENT_LIABILITY,
TAX_PAYABLE,
TAX,
EQUITY,
OTHER
number
string
default:""

The number of the category

Response

Update a Category executed successfully

message
string

Success message

metaData
object
data
object