Documento saída
Quantidade máxima de items retornados.
20Quantidade de items para ignorar antes de retornar resultado.
0O filtro é permitido apenas pelos atributos do objeto principal.
Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.
A filtragem é o processo de limitar um recurso de coleção usando uma definição de filtro dinâmico por solicitação em vários recursos de página, em que cada página contém um subconjunto de itens encontrados na coleção completa. A filtragem permite a passagem eficiente de grandes coleções.
Para filtrar em uma consulta, inclua o parâmetro q=FilterObject, onde FilterObject é um objeto JSON que representa a seleção e classificação customizadas a serem aplicadas ao recurso. Por exemplo, suponha o seguinte recurso:
https://api.systextil.com
A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":
https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}
Gramática FilterObject
FilterObject { orderby , asof, wmembers }
orderby
"$orderby": {orderByMembers}
orderByMembers
orderByProperty
orderByProperty , orderByMembers
orderByProperty
columnName : sortingValue
sortingValue
"ASC"
"DESC"
"-1"
"1"
-1
1
asof
"$asof": date
"$asof": "datechars"
"$asof": scn
"$asof": +int
wmembers
wpair
wpair , wmembers
wpair
columnProperty
complexOperatorProperty
columnProperty
columnName : string
columnName : number
columnName : date
columnName : simpleOperatorObject
columnName : complexOperatorObject
columnName : [complexValues]
columnName
"\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
complexOperatorProperty
complexKey : [complexValues]
complexKey : simpleOperatorObject
complexKey
"$and"
"$or"
complexValues
complexValue , complexValues
complexValue
simpleOperatorObject
complexOperatorObject
columnObject
columnObject
{columnProperty}
simpleOperatorObject
{simpleOperatorProperty}
complexOperatorObject
{complexOperatorProperty}
simpleOperatorProperty
"$eq" : string | number | date
"$ne" : string | number | date
"$lt" : number | date
"$lte" : number | date
"$gt" : number | date
"$gte" : number | date
"$instr" : string
"$ninstr" : string
"$like" : string
"$null" : null
"$notnull" : null
"$between" : betweenValue
betweenValue
[null , betweenNotNull]
[betweenNotNull , null]
[betweenRegular , betweenRegular]
betweenNotNull
number
date
betweenRegular
string
number
date
Definições de tipo de dados incluem o seguinte:
string
JSONString
number
JSONNumber
date
{"$date":"datechars"}
scn
{"$scn": +int}
where
Datechars é um formato de data RFC3339 em UTC (Z)
JSONString
""
" chars "
chars
char
char chars
char
any-Unicode-character except-"-or-\-or-control-character
\"
\\
\/
\b
\f
\n
\r
\t
\u four-hex-digits
JSONNumber
int
int frac
int exp
int frac exp
int
digit
digit1-9 digits
- digit
- digit1-9 digits
frac
. digits
exp
e digits
digits
digit
digit digits
e
e
e+
e-
E
E+
E-
O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986
Exemplos
A seguir estão exemplos de operadores em especificações de FilterObject.
ORDER BY property ($orderby)
Order by with literals
{
"$orderby": {"SALARY": "ASC","ENAME":"DESC"}
}
Order by with numbers
```json
{ "$orderby": {"SALARY": -1,"ENAME": 1} }
y ($asof)
### With SCN (Implicit)
```json
{
"$asof": 1273919
}
With SCN (Explicit)
{
"$asof": {"$scn": "1273919"}
}
With Date (Implicit)
{
"$asof": "2014-06-30T00:00:00Z"
}
With Date (Explicit)
{
"$asof": {"$date": "2014-06-30T00:00:00Z"}
}
EQUALS operator ($eq)
(Implicit and explicit equality supported._
Implicit (Support String and Dates too)
{
"SALARY": 1000
}
Explicit
{
"SALARY": {"$eq": 1000}
}
Strings
{
"ENAME": {"$eq":"SMITH"}
}
Dates
{
"HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}
NOT EQUALS operator ($ne)
Number
{
"SALARY": {"$ne": 1000}
}
String
```json
{ "ENAME": {"$ne":"SMITH"} }
#### Dates
```json
{
"HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}
LESS THAN operator ($lt)
(Supports dates and numbers only)
Numbers
```json
{ "SALARY": {"$lt": 10000} }
#### Dates
```json
{
"SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}
LESS THAN OR EQUALS operator ($lte)
(Supports dates and numbers only)
Numbers
```json
{ "SALARY": {"$lte": 10000} }
#### Dates
```json
{
"HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}
GREATER THAN operator ($gt)
(Supports dates and numbers only)
Numbers
```json
{ "SALARY": {"$gt": 10000} }
#### Dates
```json
{
"SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}
GREATER THAN OR EQUALS operator ($gte)
(Supports dates and numbers only)
Numbers
{
"SALARY": {"$gte": 10000}
}
Dates
{
"HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}
In string operator ($instr)
(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }
#### Not in string operator ($ninstr)
(Supports strings only)
```json
{
"ENAME": {"$ninstr":"MC"}
}
####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
#### Numbers
```json
{
"SALARY": {"$between": [1000,2000]}
}
Dates
```json
{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }
#### Strings
```json
{
"ENAME": {"$between": ["A","C"]}
}
Null Ranges ($lte equivalent)
(Supported by numbers and dates only)
{
"SALARY": {"$between": [null,2000]}
}
Null Ranges ($gte equivalent)
(Supported by numbers and dates only)
{
"SALARY": {"$between": [1000,null]}
}
NULL operator ($null)
{
"ENAME": {"$null": null}
}
NOT NULL operator ($notnull)
{
"ENAME": {"$notnull": null}
}
AND operator ($and)
(Supports all operators, including $and and $or)
Column context delegation
(Operators inside $and will use the closest context defined in the JSON tree.)
{
"SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}
Column context override
(Example: salary greater than 1000 and name like S%)
{
"SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}
Implicit and in columns
{
"SALARY": [{"$gt": 1000},{"$lt":4000}]
}
High order AND
(All first columns and or high order operators -- $and and $ors -- defined at the first level of the JSON will be joined and an implicit AND) (Example: Salary greater than 1000 and name starts with S or T)
{
"SALARY": {"$gt": 1000},
"ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]}
}
Invalid expression (operators $lt and $gt lack column context)
{
"$and": [{"$lt": 5000},{"$gt": 1000}]
}
Valid alternatives for the previous invalid expression
{
"$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}
{
"SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
{
"SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}
OR operator ($or)
(Supports all operators including $and and $or)
Column context delegation
(Operators inside $or will use the closest context defined in the JSON tree)
{
"ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}
Column context override
(Example: name starts with S or salary greater than 1000)
{
"SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}
Sucesso.
Empresa da nota fiscal
Numero da Nota fiscal
Série da nota fiscal
Espécie da nota fiscal
Código da natureza da operação
Estado da natureza da operação
CFOP principal da nota fiscal
Descrição da natureza da operação
Código da condição de pagamento
Descrição da condição de pagamento
Data de emissão da nota fiscal
^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$Data de saida da nota fiscal
^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$Hora da saida da nota fiscal
^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$Data base a ser considerada para o cálculo dos vencimentos das duplicatas.
^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$Informe: (1) - Normal, (2) - Complementar, (3) - Ajuste ou (9) - NFs relacionadas
(0) - Normal ou (1) - Estorno
Os 9 dígitos principais do CNPJ ou CPF
Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF
Os 2 dígitos verificadores do CNPJ ou CPF
Nome/Razão Social
Sequencia do endereço de entrega
Endereço de entrega
Código do representante da nota fiscal
Nome do representante da nota fiscal
Tipo de comissão
Percentual de comissão
Número do registro de exportação fornecido pelo SISCOMEX
Número do despacho de exportação fornecido pelo SISCOMEX
Sequencia do endereço de cobrança
Endereço de cobrança
Código do vendedor
Nome do vendedor
Percentual de comissão do vendedor
Os 9 dígitos principais do CNPJ ou CPF da transportadora
Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF da transportadora
Os 2 dígitos verificadores do CNPJ ou CPF da transportadora
Nome/Razão Social Transportadora
Valor da tarifa de frete
'1 - Terrestre 2 - Aéreo 3 - Marítimo 4 - Ferroviário 5 - Fluvial'
'1 - Frete pago -Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""0"" Emitente, conforme a legislação determina.
2 - Frete a pagar: Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""1"" Dest/Rem , conforme a legislação determina.
3 - Terceiros: Ao ser utilizado esta opção o sistema irá colocar direto para a opção ""2"", ou seja, frete por conta de terceiros.
4 - Frete cortesia: Ao ser utilizado esta opção o sistema irá colocar direto para o tipo ""1"" frete por conta do emitente.
6 - Transporte Próprio por conta do Remetente.
7 - Transporte Próprio por conta do Destinatário.
9 - Sem frete: Esta opção será utilizada quando não houver frete.'
Os 9 dígitos principais do CNPJ ou CPF da transportadora redespacho
Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF da transportadora redespacho
Os 2 dígitos verificadores do CNPJ ou CPF da transportadora redespacho
Nome/Razão Social Transportadora Redespacho
'1 - Frete pago -Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""0"" Emitente, conforme a legislação determina.
2 - Frete a pagar: Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""1"" Dest/Rem , conforme a legislação determina.
3 - Terceiros: Ao ser utilizado esta opção o sistema irá colocar direto para a opção ""2"", ou seja, frete por conta de terceiros.
4 - Frete cortesia: Ao ser utilizado esta opção o sistema irá colocar direto para o tipo ""1"" frete por conta do emitente.
6 - Transporte Próprio por conta do Remetente.
7 - Transporte Próprio por conta do Destinatário.
9 - Sem frete: Esta opção será utilizada quando não houver frete.'
Placa do Veiculo
Marca dos volumes
Espécie dos volumes
Número de volumes
Código do tipo de embalagem para somar ao peso bruto da nota
Descrição do tipo de embalagem
Quantidade de embalagens
Informe O Primeiro Campo Da Tabela De Preço - Coleção
Informe O Segundo Campo Da Tabela De Preço - Mês
Informe O Terceiro Campo Da Tabela De Preço - Sequencia
Peso liquido da nota
Peso bruto da nota
Valor de despesas que incidirem sobre a nota emitida (Quando houver)
Valor do frete da nota emitida (Quando houver)
Valor de seguro incidente sobre a nota emitida (Quando houver)
Valor do ISS
Base de calculo do ICMS
Valor do ICMS
Base de calculo do IPI
Valor do IPI
Base ICMS Substituição Tributária
Valor ICMS Substituição Tributária
'Situação da nota fiscal: 0-CALCULADA - Nota somente digitada 1-EMITIDA - Quando emitida e o código do status da nota for 100-AUTORIZADO O USO DA NFE 1-REJEITADA - Quando emitida e o código do status da nota for diferente de 100 (Ainda não autorizada) 2-CANCELADA - Nota cancelada ou inutilizada 3-VERIFICAR - Processo de cálculo e emissão de nota não foi completado 4-CONFIRMADA - Nota que foi confirmada como entrada em outra empresa 5-INCOMPLETA - Processo de emissão/faturamento da nota ficou incompleto 6-INCOMPLETA - Nota fiscal calculada duplicata no OBRF. Idem à situação ""5"" porém foi calculada a duplicata"'
Valor total da nota
Vlaor dos produtos da nota
Percentual de desconto
'Tipo de desconto: 1 - Desconto Normal - O valor concedido de desconto, influenciará na base de cálculo de ICMS quando for emitida a nota fiscal; 2 - Desconto Condicionado para Propaganda Cooperada - O valor concedido de desconto, não influenciará na base de cálculo de ICMS quando for emitida nota fiscal.'
Percentual de encargos para a nota fiscal.
Código do portador
Nome do portador
Código do histórico contábil
Descrição do histórico contábil
Numero do lançamento contábil da nota fiscal
Código origem do pedido
Origem do pedido
Número da chave de acesso da NFE
Usuário que digitou a nota fiscal
Código do status da NFe
Descrição do status da NFe
Valor Suframa
Valor do desconto
Valor do FCP destinatário
Valro do ICMS destinatário
Valor do ICMS remetente
Número do cupom fiscal
Número de série da ECF
Número de caixa da ECF
Percentual de comissão no faturamento para o Representante
Código da forma de pagamento
Descrição da forma de pagamento
Número de autorização do cartão
Código do pedido de venda que gerou a nota fiscal
Data de atualização da API.
^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$Não autorizado.
Erro de formatação/json/erro do lado do servidor.
Atualizado
Isto foi útil?