Titulos a Receber por Representante

get

relatorio/v1/titulo/repres/{representante}/{grupo_economico}

API Titulos a Receber 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

base_calc_comisnumber · máx: 17Opcional

Base Cálculo Comissao

Example: 0

bolepixvarchar2 · máx: 400Opcional

Boleto Pix

Example: -

clientevarchar2 · máx: 40Opcional

Nome Cliente

Example: Exemplo Cliente

cnpj_cpf_clivarchar2 · máx: 17Opcional

CPF/CNPJ Cliente

Example: 000000001/0002-03

cod_barrasvarchar2 · máx: 80Opcional

Código de Barras

Example: 34199944900015375801090000717312938540912354

cod_represnumber · máx: 5Opcional

Código Representante

Example: 0

data_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))$

data_pagamentodateOpcional

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))$

data_vencimentodateOpcional

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))$

forma_pagtovarchar2 · máx: 35Opcional

Forma de Pagamento

Example: 00 - BOLETO

grupo_economico_descricaovarchar2 · máx: 30Opcional

Descrição Grupo Econômico

Example: JEANNETH

grupo_economico_idnumber · máx: 5Opcional

Código Grupo Econômico

Example: 0

linha_digitavelvarchar2 · máx: 80Opcional

Linha Digitável

Example: 34191.09008 00717.312938 85409.330009 9 94490001512345

link_pagamentovarchar2 · máx: 255Opcional

Link Pagamento

Example: -

nome_representantevarchar2 · máx: 40Opcional

Nome Representante

Example: Nome Representante Exemplo

num_duplicatanumber · máx: 9Opcional

Número Duplicata

Example: 0

parcelanumber · máx: 2Opcional

Parcela

Example: 0

pedido_vendanumber · máx: 9Opcional

Pedido de Venda

Example: 0

percentual_comisnumber · máx: 17Opcional

Percentual Comissão

Example: 0

pix_copiacolavarchar2 · máx: 400Opcional

Chave Pix Copia e Cola

Example: -

portadorvarchar2 · máx: 21Opcional

Portador

Example: 246 - BANCO ABC

posicao_duplicvarchar2 · máx: 20Opcional

Portador

Example: 1 - COBRANCA

saldo_duplicatanumber · máx: 15Opcional

Saldo Duplicata

Example: 0

situacao_duplicvarchar2 · máx: 17Opcional

Posição Duplicata

Example: 01 - PAGO TOTAL

valor_comisnumber · máx: 15Opcional

Valor Comissão

Example: 0

valor_descontonumber · máx: 15Opcional

Valor Desconto

Example: 0

valor_duplicatanumber · máx: 15Opcional

Valor Duplicata

Example: 0

valor_jurosnumber · máx: 15Opcional

Valor Juros

Example: 0

valor_pagonumber · máx: 15Opcional

Valor Pago

Example: 0

get

relatorio/v1/titulo/repres/{representante}/{grupo_economico}

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

200

Sucesso.

[
  {
    "base_calc_comis": 0,
    "bolepix": "-",
    "cliente": "Exemplo Cliente",
    "cnpj_cpf_cli": "000000001/0002-03",
    "cod_barras": "34199944900015375801090000717312938540912354",
    "cod_repres": 0,
    "data_emissao": "2025-04-06T03:00:00Z",
    "data_pagamento": "2025-04-06T03:00:00Z",
    "data_vencimento": "2025-04-06T03:00:00Z",
    "forma_pagto": "00 - BOLETO",
    "grupo_economico_descricao": "JEANNETH",
    "grupo_economico_id": 0,
    "linha_digitavel": "34191.09008 00717.312938 85409.330009 9 94490001512345",
    "link_pagamento": "-",
    "nome_representante": "Nome Representante Exemplo",
    "num_duplicata": 0,
    "parcela": 0,
    "pedido_venda": 0,
    "percentual_comis": 0,
    "pix_copiacola": "-",
    "portador": "246 - BANCO ABC",
    "posicao_duplic": "1 - COBRANCA",
    "saldo_duplicata": 0,
    "situacao_duplic": "01 - PAGO TOTAL",
    "valor_comis": 0,
    "valor_desconto": 0,
    "valor_duplicata": 0,
    "valor_juros": 0,
    "valor_pago": 0
  }
]

AnteriorRoteiro PróximoCarteira de Pedidos por Representante

Atualizado há 25 dias

Isto foi útil?

hashtagTitulos a Receber 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

Titulos a Receber por Representante