Listar Tipos de Conta

{ "items": [ { "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": {} } ], "page": 123, "next_cursor": "<string>", "prev_cursor": "<string>", "limit": 123 }

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization

string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

Content-Type

string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id

string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Parâmetros de caminho

organization_id

string

obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id

string

obrigatório

O identificador único do Ledger associado.

Parâmetros de consulta

limit

string

O número máximo de itens a incluir na resposta.

page

integer

Número da página a retornar (para paginação baseada em offset).

start_date

string

O início do período que você deseja consultar. Você também deve incluir o end_date.

end_date

string

O fim do período que você deseja consultar. Você também deve incluir o start_date.

sort_order

string

A ordem utilizada para classificar os resultados.

cursor

string

Um token de cursor codificado de uma resposta anterior (next_cursor ou prev_cursor) para navegar para frente ou para trás nos resultados.

metadata.key

string

Filtra por metadata usando notação de ponto. Substitua key pelo nome do seu campo de metadata (ex.: metadata.costCenter=BR_11101997).

key_value

string

Filtra tipos de conta pelo valor da chave (correspondência exata, case-insensitive).

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

items

object[]

Show child attributes

page

integer

O número da página atual.

next_cursor

string

Cursor codificado apontando para a próxima página de resultados.

prev_cursor

string

Cursor codificado apontando para a página anterior de resultados.

limit

integer

O número máximo de itens incluídos na resposta.