Actualizar un Tipo de Cuenta

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Savings Accounts",
  "description": "Saving Account",
  "metadata": {
    "supportsOverdraft": false,
    "minimumBalance": 100,
    "statementFrequency": "weekly",
    "category": "business",
    "internalCode": "ACC_TYPE_TX_001_UPD"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}"

payload = {
    "name": "Savings Accounts",
    "description": "Saving Account",
    "metadata": {
        "supportsOverdraft": False,
        "minimumBalance": 100,
        "statementFrequency": "weekly",
        "category": "business",
        "internalCode": "ACC_TYPE_TX_001_UPD"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Savings Accounts',
    description: 'Saving Account',
    metadata: {
      supportsOverdraft: false,
      minimumBalance: 100,
      statementFrequency: 'weekly',
      category: 'business',
      internalCode: 'ACC_TYPE_TX_001_UPD'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_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' => 'Savings Accounts',
    'description' => 'Saving Account',
    'metadata' => [
        'supportsOverdraft' => false,
        'minimumBalance' => 100,
        'statementFrequency' => 'weekly',
        'category' => 'business',
        'internalCode' => 'ACC_TYPE_TX_001_UPD'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}"

	payload := strings.NewReader("{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

account-types

{account_type_id}

Actualizar un Tipo de Cuenta

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Savings Accounts",
  "description": "Saving Account",
  "metadata": {
    "supportsOverdraft": false,
    "minimumBalance": 100,
    "statementFrequency": "weekly",
    "category": "business",
    "internalCode": "ACC_TYPE_TX_001_UPD"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}"

payload = {
    "name": "Savings Accounts",
    "description": "Saving Account",
    "metadata": {
        "supportsOverdraft": False,
        "minimumBalance": 100,
        "statementFrequency": "weekly",
        "category": "business",
        "internalCode": "ACC_TYPE_TX_001_UPD"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Savings Accounts',
    description: 'Saving Account',
    metadata: {
      supportsOverdraft: false,
      minimumBalance: 100,
      statementFrequency: 'weekly',
      category: 'business',
      internalCode: 'ACC_TYPE_TX_001_UPD'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_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' => 'Savings Accounts',
    'description' => 'Saving Account',
    'metadata' => [
        'supportsOverdraft' => false,
        'minimumBalance' => 100,
        'statementFrequency' => 'weekly',
        'category' => 'business',
        'internalCode' => 'ACC_TYPE_TX_001_UPD'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}"

	payload := strings.NewReader("{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Savings Accounts\",\n  \"description\": \"Saving Account\",\n  \"metadata\": {\n    \"supportsOverdraft\": false,\n    \"minimumBalance\": 100,\n    \"statementFrequency\": \"weekly\",\n    \"category\": \"business\",\n    \"internalCode\": \"ACC_TYPE_TX_001_UPD\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Encabezados

Content-Type

string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id

string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization

string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id

string<uuid>

requerido

El identificador único de la Organización asociada al Ledger.

ledger_id

string<uuid>

requerido

El identificador único del Ledger asociado.

account_type_id

string<uuid>

requerido

El identificador único del Tipo de Cuenta que desea recuperar.

Cuerpo

application/json

name

string

Nombre del Tipo de Cuenta.

description

string

Descripción del Tipo de Cuenta.

metadata

object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.

Show child attributes

Respuesta

Indica que el recurso fue creado exitosamente y la operación se completó como se esperaba.

string<uuid>

El identificador único del Tipo de Cuenta.

organizationId

string<uuid>

El identificador único de la Organización.

ledgerId

string<uuid>

El identificador único del Ledger.

name

string

Nombre del Tipo de Cuenta.

description

string

Descripción del Tipo de Cuenta.

keyValue

string

Identificador único del Tipo de Cuenta creado.

createdAt

string<date-time>

Fecha y hora de creación (UTC).

updatedAt

string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt

string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

metadata

object

Show child attributes

Recuperar un Tipo de Cuenta

Eliminar un Tipo de Cuenta

⌘I