Saltar al contenido principal
POST
Crear una Cuenta

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.

Cuerpo

application/json
assetCode
string
requerido

El código que identifica el Activo utilizado en la Cuenta. Importante: Debe ser un Activo que ya haya creado usando el endpoint Crear un Activo.

Maximum string length: 100
type
string
requerido

Especifica el Tipo de Cuenta asociado a la cuenta. Este campo es obligatorio. Importante: Cuando la validación de Tipo de Cuenta está habilitada para su Organización y Ledger, el valor debe coincidir con un keyValue existente definido en su configuración de Tipos de Cuenta. Cuando la validación está deshabilitada (comportamiento predeterminado), el campo sigue siendo obligatorio pero acepta cualquier cadena de formato libre sin validación. El valor external está reservado y se rechaza en la entrada.

Maximum string length: 256
name
string

El nombre de la Cuenta.

Maximum string length: 256
alias
string

Un identificador único y fácil de usar para la cuenta. Se utiliza para referenciar la cuenta en transacciones y otras operaciones. Si no se proporciona, el sistema usará el ID de la cuenta como alias. Nota: el alias no debe contener el prefijo reservado @external/, que está reservado para cuentas externas gestionadas por el sistema.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9@:_-]+$
blocked
boolean
predeterminado:false

Define si la cuenta debe iniciar bloqueada.

parentAccountId
string<uuid> | null

El identificador único de la Cuenta matriz, si esta es una subcuenta.

entityId
string | null

El identificador único de la Entidad responsable de la Cuenta.

Maximum string length: 256
portfolioId
string<uuid> | null

El identificador único del Portafolio asociado.

segmentId
string<uuid> | null

El identificador único del Segmento que se utiliza para agrupar la Cuenta.

status
object

Un objeto que contiene información sobre el estado. Importante: Si no se proporciona, el estado predeterminado será 'ACTIVE'.

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.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

id
string<uuid>

El identificador único de la Cuenta.

organizationId
string<uuid>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

assetCode
string

El código que identifica el Activo utilizado en la Cuenta.

name
string

El nombre de la Cuenta.

Maximum string length: 256
alias
string

Un identificador único y fácil de usar para la cuenta. Se utiliza para referenciar la cuenta en transacciones y otras operaciones.

type
string

Especifica el Tipo de Cuenta asociado a la cuenta.

blocked
boolean
predeterminado:false

Define si la cuenta debe estar bloqueada.

parentAccountId
string<uuid> | null

El identificador único de la Cuenta matriz.

entityId
string | null

El identificador único de la Entidad responsable de la Cuenta.

portfolioId
string<uuid> | null

El identificador único del Portafolio asociado.

segmentId
string<uuid> | null

El identificador único del Segmento que se utiliza para agrupar la Cuenta.

status
object

Un objeto que contiene información sobre el estado.

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.

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).