Skip to main content
PATCH
/
gl-accounts
/
{id}
Update a GL account
curl --request PATCH \
  --url https://api.arcuserp.com/v1/gl-accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "account_sub_type": "<string>",
  "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tax_line_mapping": "<string>",
  "is_active": true,
  "opening_balance": 123,
  "opening_balance_date": "2023-12-25"
}
'
import requests

url = "https://api.arcuserp.com/v1/gl-accounts/{id}"

payload = {
"name": "<string>",
"description": "<string>",
"account_sub_type": "<string>",
"parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tax_line_mapping": "<string>",
"is_active": True,
"opening_balance": 123,
"opening_balance_date": "2023-12-25"
}
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>',
description: '<string>',
account_sub_type: '<string>',
parent_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
tax_line_mapping: '<string>',
is_active: true,
opening_balance: 123,
opening_balance_date: '2023-12-25'
})
};

fetch('https://api.arcuserp.com/v1/gl-accounts/{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.arcuserp.com/v1/gl-accounts/{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>',
'description' => '<string>',
'account_sub_type' => '<string>',
'parent_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'tax_line_mapping' => '<string>',
'is_active' => true,
'opening_balance' => 123,
'opening_balance_date' => '2023-12-25'
]),
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.arcuserp.com/v1/gl-accounts/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"account_sub_type\": \"<string>\",\n \"parent_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tax_line_mapping\": \"<string>\",\n \"is_active\": true,\n \"opening_balance\": 123,\n \"opening_balance_date\": \"2023-12-25\"\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.arcuserp.com/v1/gl-accounts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"account_sub_type\": \"<string>\",\n \"parent_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tax_line_mapping\": \"<string>\",\n \"is_active\": true,\n \"opening_balance\": 123,\n \"opening_balance_date\": \"2023-12-25\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/gl-accounts/{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 \"description\": \"<string>\",\n \"account_sub_type\": \"<string>\",\n \"parent_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tax_line_mapping\": \"<string>\",\n \"is_active\": true,\n \"opening_balance\": 123,\n \"opening_balance_date\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_number": "<string>",
  "name": "<string>",
  "description": "<string>",
  "account_sub_type": "<string>",
  "is_header": true,
  "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_system_account": true,
  "system_account_key": "<string>",
  "is_bank_account": true,
  "is_active": true,
  "tax_line_mapping": "<string>",
  "opening_balance": 123,
  "opening_balance_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
description
string
account_sub_type
string
parent_account_id
string<uuid>
tax_line_mapping
string
is_active
boolean
opening_balance
number
opening_balance_date
string<date>

Response

Updated GL account

A General Ledger account in the chart of accounts. Header accounts (is_header=true) aggregate child accounts and cannot receive postings (Rule A2 / Rule 21). Leaf accounts (is_header=false, is_active=true) are the only valid targets for journal entry lines. System accounts (is_system_account=true) are provisioned by entity-seed-helpers.mjs and cannot be created or modified via the API.

id
string<uuid>
read-only
entity_id
string<uuid>
read-only
account_number
string
read-only

Immutable post-create (e.g. '1300')

name
string
description
string | null
account_type
enum<string>
read-only

Immutable post-create

Available options:
asset,
liability,
equity,
revenue,
expense,
cogs
account_sub_type
string | null
normal_balance
enum<string>
read-only

Immutable post-create

Available options:
debit,
credit
is_header
boolean

True for rollup accounts that aggregate children. Header accounts CANNOT receive journal entry line postings (Rule A2 / assertGLLinesPostable).

parent_account_id
string<uuid> | null
is_system_account
boolean
read-only

True for accounts seeded by entity-seed-helpers.mjs. System accounts cannot be created, updated, or deleted via the API.

system_account_key
string | null
read-only

Lookup key used by posting helpers (e.g. ar_account, cogs, revenue, inventory_fg). Code uses getGLAccountByKey(entityId, key) instead of hardcoded account numbers.

is_bank_account
boolean

True for bank/cash accounts eligible for reconciliation

is_active
boolean
tax_line_mapping
string | null
opening_balance
number | null
opening_balance_date
string<date> | null
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only