Carteira de Pedidos por Representante

get

relatorio/v1/carteira/repres/{representante}

API Carteira de Pedidos por Representante

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

limitinteger · int32 · mín: 1 · máx: 100Opcional

Quantidade máxima de items retornados.

Default: 20

offsetinteger · int32Opcional

Quantidade de items para ignorar antes de retornar resultado.

Default: 0

qstringOpcional

O 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%"}} ] }
}

Respostas

200

Sucesso.

application/json

cnpj_cpfvarchar2 · máx: 17Opcional

CPF/CNPJ

Example: 000000001/0002-03

cod_cancelnumber · máx: 3Opcional

O código do Cancelamento

Example: 0

cod_represnumber · máx: 5Opcional

O código do Representante

Example: 0

colnumber · máx: 3Opcional

O código da Coleção

Example: 0

colecaovarchar2 · máx: 20Opcional

Descrição da Coleção

Example: PRODUTO CRU/ACABADO

cond_pgtonumber · máx: 3Opcional

Condição de Pagamento

Example: 0

cpf_cnpj_remessavarchar2 · máx: 17Opcional

CPF/CNPJ

Example: 000000001/0002-03

dsc_cond_pgtovarchar2 · máx: 30Opcional

Descrição da Condição de Pagamento

Example: PRODUTO CRU/ACABADO

dsc_produtovarchar2 · máx: 65Opcional

Descrição do Produto

Example: ALGARVE ANGEL BLUE

dt_cancel_linhadateOpcional

Data Início

Example: 2025-04-06T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

dt_embarquedateOpcional

Data Início

Example: 2025-04-06T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

dt_emissaodateOpcional

Data Início

Example: 2025-04-06T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

grupo_economico_descricaovarchar2 · máx: 30Opcional

Descrição do Grupo Econômico

Example: VANELISE

grupo_economico_idnumber · máx: 5Opcional

Código do Grupo Econômico

Example: 0

mot_cancel_lnvarchar2 · máx: 20Opcional

Motivo de Canelamento LN

Example: .

nf_datavarchar2 · máx: 4000Opcional

Nota Fiscal - Data

Example: 23516 - 14/12/2023

nome_clientevarchar2 · máx: 40Opcional

Nome do Cliente

Example: Cliente Exemplo

nome_cliente_remessavarchar2 · máx: 3981Opcional

Nome do Cliente Remessa

Example: Cliente Exemplo Remessa

nome_represvarchar2 · máx: 40Opcional

Nome do Representante

Example: Representante Exemplo

notas_fiscaisvarchar2 · máx: 40000Opcional

Notas Fiscais

Example: 123456, 654321

ordem_compravarchar2 · máx: 30Opcional

Ordem de Compra

Example: 1626

ordem_compra_itemvarchar2 · máx: 30Opcional

Ordem de Compra Item

Example: 1626

pedidonumber · máx: 9Opcional

Pedido

Example: 0

pedido_clientevarchar2 · máx: 30Opcional

Pedido Cliente

Example: 1626

pedido_devarchar2 · máx: 16Opcional

Pedido De

Example: 2 - TECIDOS

perc_desc_lnnumber · máx: 6Opcional

Percentual de Desconto LN

Example: 0

prazo_medionumber · máx: 6Opcional

Prazo Médio

Example: 0

produtovarchar2 · máx: 18Opcional

Pedido De

Example: 2.00000.000.000000

qtde_faturadanumber · máx: 15Opcional

Quantidade Faturada

Example: 0

qtde_pednumber · máx: 15Opcional

Quantidade Pedida

Example: 0

saldonumber · máx: 25Opcional

Saldo

Example: 0

situacaovarchar2 · máx: 23Opcional

Situação

Example: 10 - FATURADO

sit_lnvarchar2 · máx: 16Opcional

Situação LN

Example: FATURADO TOTAL

tp_pedidovarchar2 · máx: 18Opcional

Tipo Pedido

Example: 0 - PROGRAMADO

tp_prod_pedidovarchar2 · máx: 22Opcional

Tipo Produto Pedido

Example: 1 - PRIMEIRA QUALIDADE

ult_nf_datadateOpcional

Data Início

Example: 2025-04-06T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

vlr_tot_liqnumber · máx: 17Opcional

Valor Total Líquido

Example: 0

vlr_unitnumber · máx: 17Opcional

Valor Unitário

Example: 0

vlr_unit_liqnumber · máx: 17Opcional

Valor Unitário Líquido

Example: 0

get

relatorio/v1/carteira/repres/{representante}

GET relatorio/v1/carteira/repres/{representante} HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Sucesso.

[
  {
    "cnpj_cpf": "000000001/0002-03",
    "cod_cancel": 0,
    "cod_repres": 0,
    "col": 0,
    "colecao": "PRODUTO CRU/ACABADO",
    "cond_pgto": 0,
    "cpf_cnpj_remessa": "000000001/0002-03",
    "dsc_cond_pgto": "PRODUTO CRU/ACABADO",
    "dsc_produto": "ALGARVE ANGEL BLUE",
    "dt_cancel_linha": "2025-04-06T03:00:00Z",
    "dt_embarque": "2025-04-06T03:00:00Z",
    "dt_emissao": "2025-04-06T03:00:00Z",
    "grupo_economico_descricao": "VANELISE",
    "grupo_economico_id": 0,
    "mot_cancel_ln": ".",
    "nf_data": "23516 - 14/12/2023",
    "nome_cliente": "Cliente Exemplo",
    "nome_cliente_remessa": "Cliente Exemplo Remessa",
    "nome_repres": "Representante Exemplo",
    "notas_fiscais": "123456, 654321",
    "ordem_compra": "1626",
    "ordem_compra_item": "1626",
    "pedido": 0,
    "pedido_cliente": "1626",
    "pedido_de": "2 - TECIDOS",
    "perc_desc_ln": 0,
    "prazo_medio": 0,
    "produto": "2.00000.000.000000",
    "qtde_faturada": 0,
    "qtde_ped": 0,
    "saldo": 0,
    "situacao": "10 - FATURADO",
    "sit_ln": "FATURADO TOTAL",
    "tp_pedido": "0 - PROGRAMADO",
    "tp_prod_pedido": "1 - PRIMEIRA QUALIDADE",
    "ult_nf_data": "2025-04-06T03:00:00Z",
    "vlr_tot_liq": 0,
    "vlr_unit": 0,
    "vlr_unit_liq": 0
  }
]

AnteriorTitulos a Receber por Representante PróximoTracking Pedido

Atualizado há 25 dias

Isto foi útil?

hashtagCarteira de Pedidos por Representante

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Column context override

Carteira de Pedidos por Representante