Períodos de Referência

Lista os períodos de referência

Recupera uma lista paginada de períodos de referência com filtros opcionais.

Filtros Disponíveis:

  • year: Filtro de ano com operadores =, !=, >, <, >=, <=, IN, NOT IN, TO.
  • month: Filtro de mês com operadores =, !=, >, <, >=, <=, IN, NOT IN, TO.

Ordenação:

  • year: Ordena pelo ano (padrão: descendente).
  • month: Ordena pelo mês (padrão: descendente).
get/v1/reference-periods

Request

  • Base URL: https://api.fipex.com.br
  • URL: https://api.fipex.com.br/v1/reference-periods
  • Auth: none declared

Query parameters

pageinteger

Número da página (mínimo 1). Valores não inteiros ou fora do intervalo retornam 400 ValidationError.

limitinteger

Número de itens por página (1-50). Valores não inteiros ou fora do intervalo retornam 400 ValidationError.

string
OR
string[]
Example:name

Especificação de ordenação. Pode ser fornecida em múltiplos formatos:

Campo único: ?order_by=name (ascendente) ou ?order_by=-name (descendente)

Separado por vírgula: ?order_by=name,-price

Notação de array: ?order_by[]=name&order_by[]=-price

Use o prefixo - para ordem descendente.

yearinteger

Filtra por ano (1981-ano atual).

monthinteger

Filtra por mês (1-12).

fieldstring required

Nome do campo para filtrar.

op'=' | '!=' | '>' | '<' | '>=' | '<=' | 'CONTAINS' | 'NOT CONTAINS' | 'IN' | 'NOT IN' | 'TO' | 'IS NULL' required

Operador do filtro.

valuestring

Valor do filtro (o tipo depende do campo e do operador). Para IN/NOT IN/TO use vírgula como separador.

negateboolean

Se deve negar a condição do filtro.

condition'AND' | 'OR'

Condição lógica para combinar com outros filtros.

Filtragem avançada usando notação de array. Cada filtro requer:

  • field: O campo a ser filtrado.
  • op: O operador (veja a seção Operadores de Filtro).
  • value: O valor para filtrar.

Formato: filters[0].field=year&filters[0].op=%3E&filters[0].value=2010

Múltiplos filtros: filters[0].field=year&filters[0].op=%3E&filters[0].value=2010&filters[1].field=price&filters[1].op=TO&filters[1].value=20000,50000

Response

Períodos de referência obtidos com sucesso.

Changes

No recorded changes to this operation across all 1 revision of this API.