Afeta
Equipes que usam a documentação pública do Midaz Ledger para consultar contas, organizações ou tipos de conta. Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime.
O portal público de documentação é a referência voltada ao cliente. Recomenda-se que os arquivos-fonte do repositório não sejam tratados como artefatos de integração nem como especificações de API baixadas para uso do cliente.
O que mudou
Filtros de listagem do ledger
A referência do Midaz Ledger agora mostra parâmetros de consulta que já existem na API, mas faltavam na referência pública. Áreas atualizadas:- Filtros de
GET /accounts, incluindo filtros de portfólio, segmento, status, ativo, entidade, conta pai, nome, alias e metadados. - Filtros de
GET /organizationspara status e documento legal. - Filtro de
GET /account-typespara o valor da chave. - Descrições de metadados que usam o padrão documentado de notação por ponto.
Impacto
Esta é uma atualização de documentação. Ela torna visíveis na documentação pública os filtros do Midaz Ledger que já existiam. Nenhuma migração é necessária apenas por esta nota de release. Recomenda-se que as equipes que usam esses endpoints de listagem usem o portal de documentação atualizado ao revisar o comportamento das consultas.
O que você precisa fazer
1
Revise os filtros de listagem atualizados do Midaz se sua integração consulta contas, organizações ou tipos de conta.
2
Use o portal de documentação como a referência voltada ao cliente para os parâmetros de consulta disponíveis.
3
Não trate os arquivos-fonte do repositório como artefatos de integração do cliente.