Skip to main content
PATCH
/
ledger_accounts
/
{ledger_account_id}
Update a ledger account
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/ledger_accounts/{ledger_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "nominal_code": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_bank_account": true,
  "status": "Active",
  "type": "Asset",
  "currency": "EUR",
  "current_balance": 123,
  "description": "<string>",
  "is_external": false,
  "name": "Accounts Receivable",
  "nominal_code": "610",
  "subtype": "Current"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
ledger_account_id
string<uuid>
required

Body

application/json

Schema for updating an existing ledger account.

​
description
string

Description of the ledger account

Maximum string length: 2048
​
name
string

Name of the ledger account

Maximum string length: 500
​
nominal_code
string

Account code in the accounting system

Maximum string length: 500

Response

Successful Response

Represents a general ledger account retrieved from an accounting system.

​
id
string<uuid>
required

A unique identifier of the ledger account.

​
created_at
string<date-time>
required

The timestamp when the ledger account was created.

​
updated_at
string<date-time>
required

The timestamp when the ledger account was last updated.

​
is_bank_account
boolean
required

Indicates whether this ledger account represents a bank account.

​
status
string
required

The status of the ledger account. Possible values: Active, Archived, Pending, Unknown.

Example:

"Active"

​
type
string
required

The type of the ledger account. It determines whether the account is a credit account or a debit account and where it appears in financial reports within the accounting system. Possible values: Asset, Equity, Expense, Income, Liability, Unknown.

Example:

"Asset"

​
currency
enum<string>

The currency of the ledger account, specified as a three-letter currency code (ISO 4217).

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"EUR"

​
current_balance
integer

The current balance in the account.

​
description
string

User-defined description of the ledger account.

​
is_external
boolean
default:false

Whether the ledger account is from an external system

​
name
string

A user-defined name of the ledger account. Examples: Accounts Receivable, Office Equipment, Advertising, Salaries.

Example:

"Accounts Receivable"

​
nominal_code
string

The account code in the accounting system.

Example:

"610"

​
subtype
string

The subtype or category of the ledger account. Possible values vary based on the accounting system used. Examples: Current, Fixed, Expense, Inventory, Equity.

Example:

"Current"