🚧 Em Construção 🚧
Pular para o conteúdo principal

Obtém posições de saldo de um book

GET 
/v1/ledgers/:ledger_identifier/books/:book_identifier/positions

Obtém as positions (posições de saldo) de um book específico com filtros temporais flexíveis.

O campo scope define o escopo do filtro de referência temporal.

  • current: Retorna a posição de saldo atual do book. Valor padrão.
  • historical: Retorna a posição de saldo histórico do book.
  • all: Retorna a posição de saldo atual e histórico do book.

Os filtros temporais permitem selecionar o campo de referência temporal e aplicar operadores de comparação:

  • filter_by: Define o campo de referência temporal (created_at, posted_at, reference_at)
  • gt: Maior que a data e hora especificada
  • gte: Maior ou igual à data e hora especificada
  • lt: Menor que a data e hora especificada
  • lte: Menor ou igual à data e hora especificada
  • eq: Igual à data e hora especificada
nota

Caso o campo scope seja current, os filtros temporais não serão aplicados.

Request​

Responses​

Lista de posições de saldo do book

Response Headers
    Cache-Control

    Controla o comportamento de cache para respostas HTTP. Deve ser 'no-store' para dados sensíveis. Deve ser 'public' para respostas de sucesso sem dados sensíveis que podem ser compartilhadas, ou 'private' para respostas de sucesso sem dados sensíveis que não podem ser compartilhadas, seguido da diretiva 'max-age' determinando o tempo máximo de cache em segundos.

    Example: public, max-age=900
    Content-Language

    O idioma em que a API retorna as mensagens de erro. Use en para inglês americano, es para espanhol ou pt-BR para português brasileiro.

    Example: en
    Content-Length

    Indica o tamanho, em bytes, do corpo da resposta retornado pela API.

    Example: <length>
    Content-Type

    Tipo de contrato retornado.

    Example: application/vnd.guardia.v1+json
    Link

    Fornece links de navegação HATEOAS para paginação.

    Example: <https://{tenant_id}.guardia.finance/api/v1/ledgers?page_token={first_page_token}>; rel="first", <https://{tenant_id}.guardia.finance/api/v1/ledgers?page_token={previous_page_token}>; rel="previous", <https://{tenant_id}.guardia.finance/api/v1/ledgers?page_token={next_page_token}>; rel="next", <https://{tenant_id}.guardia.finance/api/v1/ledgers?page_token={last_page_token}>; rel="last"
    Strict-Transport-Security

    Indica que o navegador deve acessar o site apenas por HTTPS.

    Example: max-age=31536000; includeSubDomains
    X-Grd-Correlation-Id

    Identificador de correlação para rastreamento distribuído.

    Example: 018f74a6e3b270ccbf248a4b012f5f3e
    X-Grd-Trace-Id

    Identificador único da requisição gerado pela infraestrutura Guardia.

    Example: 018f74a6e3b270ccbf248a4b012f5f3e
    X-RateLimit-Limit

    Cota de requisições por segundos por cliente (org id + tenant id).

    Example: 30
    X-RateLimit-Remaining

    Cota de requisições restantes no mesmo segundo.

    Example: 10
    X-RateLimit-Reset

    Tempo restante em segundos para a próxima requisição.

    Example: 60