Update an account

The closing instant is output only: a body naming closedAt or closed_at at its root is refused with 400 whatever the value it carries, and the stored instant is only ever written by the close command. Metadata is applied as an RFC 7396 merge patch: a body without metadata, or with an empty metadata object, leaves the stored metadata as it is; a key sent as null is deleted; any other key is added or replaced; metadata sent as null deletes every key the client wrote.

PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}

Update an account

cURL

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blocked": true,
  "entityId": "EXT-ACC-12345",
  "metadata": {},
  "name": "Primary Corporate Checking Account",
  "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "alias": "@treasury_checking",
  "assetCode": "USD",
  "blocked": true,
  "closedAt": "2021-01-01T00:00:00Z",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "entityId": "EXT-ACC-12345",
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "name": "Corporate Checking Account",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "parentAccountId": "00000000-0000-0000-0000-000000000000",
  "portfolioId": "00000000-0000-0000-0000-000000000000",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "type": "deposit",
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {}
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id · string · requerido

Organization ID (UUID)

ledger_id · string · requerido

Ledger ID (UUID)

account_id · string · requerido

Account ID (UUID)

Cuerpo

application/json

blocked · boolean | null

entityId · string | null

Maximum string length: 256

Ejemplo:

"EXT-ACC-12345"

metadata · object

Show child attributes

name · string

Maximum string length: 256

Ejemplo:

"Primary Corporate Checking Account"

portfolioId · string<uuid> | null

segmentId · string<uuid> | null

status · object

Show child attributes

Respuesta

200

application/json

OK

alias · string | null · requerido

Maximum string length: 100

Ejemplo:

"@treasury_checking"

assetCode · string · requerido

Maximum string length: 100

Ejemplo:

"USD"

blocked · boolean | null · requerido

closedAt · string<date-time> | null · requerido

Instant the account was closed, null while it is still open. Output only: it is written exclusively by the close command and is refused as an input field on create and update

Ejemplo:

"2021-01-01T00:00:00Z"

createdAt · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

deletedAt · string<date-time> | null · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

entityId · string | null · requerido

Maximum string length: 256

Ejemplo:

"EXT-ACC-12345"

id · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

name · string · requerido

Maximum string length: 256

Ejemplo:

"Corporate Checking Account"

organizationId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

parentAccountId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

portfolioId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

segmentId · string<uuid> | null · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

status · object · requerido

Show child attributes

type · string · requerido

Ejemplo:

"deposit"

updatedAt · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

metadata · object

Show child attributes