Skip to main content
PATCH
/
v1
/
businesses
/
{businessId}
/
ledger
/
accounts
/
{accountId}
Patch update ledger account
curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/accounts/{accountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "account_number": "4000",
  "normality": "CREDIT",
  "parent_id": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "stable_name": {
    "type": "StableName",
    "stable_name": "CURRENT_ASSETS"
  },
  "account_type": {
    "value": "ASSET",
    "display_name": "Asset"
  },
  "account_subtype": {
    "value": "BANK_ACCOUNTS",
    "display_name": "Current Assets"
  }
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Content-Type
string

Content-Type must be set to application/json

Path Parameters

​
businessId
string
required

The UUID of the business to confirm the matches for

​
accountId
string
required

The id of the ledger account to update

Body

application/json

Parameters for partially updating a ledger account (PATCH operation). All fields are optional.

​
name
string

Account name

​
account_number
string | null

Optional account number for the ledger account

Example:

"4000"

​
normality
enum<string>

Account normality

Available options:
CREDIT,
DEBIT
​
parent_id
object

The Account Identifier of the parent account under which this ledger account is categorized. ID of the account

  • Account ID
  • Account Stable Name
​
stable_name
object

The Stable Name for the account.

​
account_type
object

Type of the ledger account

​
account_subtype
object

Subtype of the ledger account

Response

200 - application/json

The updated ledger account

A single ledger account without nested children

​
id
object

ID of the account

  • Account ID
  • Account Stable Name
​
name
string

Name of the account

Example:

"Current Assets"

​
account_number
string | null

Account number if configured

Example:

"4000"

​
stable_name
object
​
normality
enum<string>
Available options:
CREDIT,
DEBIT
​
account_type
object
​
account_subtype
object