Criar uma Conta
Use este endpoint para criar uma Conta no Midaz. Você pode criar quantas contas forem necessárias para estruturar seu ledger, mas cada requisição cria apenas uma conta por vez.
Importante: Antes de criar uma Conta, certifique-se de que o Ativo correspondente já existe. Use o endpoint Criar um Ativo para registrá-lo, se necessário.
Se você definiu Tipos de Conta anteriormente, certifique-se de que estão configurados corretamente antes da criação da conta. Recomendamos recriar as contas existentes ou atualizá-las para incluir o tipo correto antes de habilitar o recurso de validação de Tipo de Conta — isso ajuda a prevenir erros de validação e garante conformidade com sua estrutura contábil.
Cabeçalhos
O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado.
O tipo de mídia do recurso. Deve ser application/json.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
Parâmetros de caminho
O identificador único da Organização associada ao Ledger.
O identificador único do Ledger associado.
Corpo
O código que identifica o Ativo utilizado na Conta. Importante: Deve ser um Ativo que você já criou usando o endpoint Criar um Ativo.
Especifica o Tipo de Conta associado à conta. Importante: Quando a validação de Tipo de Conta está habilitada para sua Organização e Ledger, este campo se torna obrigatório e deve corresponder a um keyValue existente definido na sua configuração de Tipos de Conta. No entanto, quando a validação está desabilitada (comportamento padrão), este campo é opcional e aceita qualquer string de formato livre sem validação.
O nome da Conta.
256Um identificador único e amigável para a conta. Usado para referenciar a conta em transações e outras operações. Se não fornecido, o sistema usará o ID da conta como alias.
100Define se a conta deve começar bloqueada.
O identificador único da Conta Pai. Se a conta não possuir uma conta pai, este campo será nulo.
O identificador único da Entidade responsável pela Conta.
O identificador único do Portfolio associado.
O identificador único do Segmento utilizado para agrupar a Conta.
Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.
Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.
Resposta
Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.
O identificador único da Conta.
O identificador único da Organização.
O identificador único do Ledger.
O código que identifica o Ativo utilizado na Conta.
O nome da Conta.
256Um identificador único e amigável para a conta. Usado para referenciar a conta em transações e outras operações.
Especifica o Tipo de Conta associado à conta.
Define se a conta deve ser bloqueada.
O identificador único da Conta Pai.
O identificador único da Entidade responsável pela Conta.
O identificador único do Portfolio associado.
O identificador único do Segmento utilizado para agrupar a Conta.
Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.
Data e hora de criação (UTC).
Data e hora da última atualização (UTC).
Data e hora da exclusão lógica, se aplicável (UTC).