Filtros e operadores

Os filtros são passados no parâmetro where (ou whereGroup), um array de condições. Cada condição tem, no mínimo, um type (o operador) e, na maioria dos casos, um attribute e um value.

{ "type": "equals", "attribute": "status", "value": "New" }

Operadores de comparação

Operador (type)	Descrição
equals	Igualdade.
notEquals	Desigualdade.
greaterThan	Valor maior que…
lessThan	Valor menor que…
greaterThanOrEquals	Maior ou igual.
lessThanOrEquals	Menor ou igual.

{ "type": "greaterThanOrEquals", "attribute": "valor", "value": 1000 }

Operadores de nulidade e booleanos

Operador (type)	Descrição
isNull	Valor nulo.
isNotNull	Valor presente.
isTrue	Valor booleano verdadeiro.
isFalse	Valor booleano falso.

{ "type": "isNotNull", "attribute": "dataEntrega" }

Operadores de vínculo (relacionamentos)

Operador (type)	Descrição
linkedWith	Registros ligados (link-multiple).
notLinkedWith	Registros não ligados.
isLinked	Possui vínculo com qualquer registro.
isNotLinked	Não possui vínculo.

Operadores de conjunto

Operador (type)	Descrição
in	Valor contido num conjunto.
notIn	Valor fora do conjunto.

{ "type": "in", "attribute": "status", "value": ["New", "Pending"] }

Operadores de texto

Operador (type)	Descrição
contains	Texto contido.
notContains	Texto não contido.
startsWith	Inicia com…
endsWith	Termina com…
like	Similaridade com padrão.
notLike	Não similar ao padrão.

{ "type": "startsWith", "attribute": "sicCode", "value": "123" }

Operadores lógicos

Combinam outras condições.

Operador (type)	Descrição
and	Combina condições — todas verdadeiras.
or	Qualquer condição verdadeira.

Filtros para arrays

Operador (type)	Descrição
arrayAnyOf	Contém pelo menos um dos valores especificados.
arrayAllOf	Contém todos os valores especificados.
arrayNoneOf	Não contém nenhum dos valores especificados.
arrayIsEmpty	Campo array está vazio.
arrayIsNotEmpty	Campo array não está vazio.

Filtros de data

Operador (type)	Descrição
today	Hoje.
past	Passado recente.
future	Futuro próximo.
lastSevenDays	Últimos 7 dias.
currentMonth	Mês atual.
lastMonth	Mês anterior.
nextMonth	Mês seguinte.
currentQuarter	Trimestre atual.
lastQuarter	Trimestre anterior.
currentYear	Ano atual.
lastYear	Ano anterior.
currentFiscalYear	Ano fiscal atual.
lastFiscalYear	Ano fiscal passado.
currentFiscalQuarter	Trimestre fiscal atual.
lastFiscalQuarter	Trimestre fiscal passado.
lastXDays	Últimos X dias.
nextXDays	Próximos X dias.
olderThanXDays	Mais antigo que X dias.
afterXDays	Depois de X dias.
between	Entre dois valores.

{ "type": "lastXDays", "attribute": "modifiedAt", "value": 30 }

Combinando filtros

Você pode enviar várias condições no array where. Para lógicas mais elaboradas, use os operadores and / or para agrupar condições.