Consulta crédito

Consulta Crédito

get

https://qa-api-cliente.systextilapps.com.brhttps://api-cliente.systextilapps.com.br

/credito/v1/consulta

API para integração de consulta de crédito. 1- Devido a limitação do Swagger na quantidade de caracters que podem ser retornadas, foram criados os campos abaixo para limitar a quantidade de registros quando necessário. O erro retornado quando o limite de caracteres é ultrapassado é "413 - request entity too large".

Autorizações

oAuth2ClientCredentialsApiKeyAuth

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_9number · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 29911640

cnpj_4number · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 1

cnpj_2number · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 35

nome_clientestring · máx: 40Opcional

Nome/Razão Social

Example: L FLORENCIO DA SILVA CONFECCOES

pedido_liberado_avista_numeronumber · máx: 6Opcional

Quantidade de pedidos liberados com pagamento a vista

pedido_liberado_avista_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos liberados com pagamento a vista

pedido_liberado_avista_valornumber · máx: 15Opcional

Valor dos pedidos liberados com pagamento a vista

pedido_liberado_aprazo_numeronumber · máx: 6Opcional

Quantidade de pedidos liberados com pagamento a prazo

pedido_liberado_aprazo_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos liberados com pagamento a prazo

pedido_liberado_aprazo_valornumber · máx: 15Opcional

Valor dos pedidos liberados com pagamento a prazo

pedido_liberado_cartao_numeronumber · máx: 6Opcional

Quantidade de pedidos liberados com pagamento em cartão

pedido_liberado_cartao_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos liberados com pagamento em cartão

pedido_liberado_cartao_valornumber · máx: 15Opcional

Valor dos pedidos liberados com pagamento em cartão

pedido_bloqueado_avista_numeronumber · máx: 6Opcional

Quantidade de pedidos bloqueados com pagamento a vista

pedido_bloqueado_avista_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos bloqueados com pagamento a vista

pedido_bloqueado_avista_valornumber · máx: 15Opcional

Valor dos pedidos bloqueados com pagamento a vista

pedido_bloqueado_aprazo_numeronumber · máx: 6Opcional

Quantidade de pedidos bloqueados com pagamento a prazo

pedido_bloqueado_aprazo_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos bloqueados com pagamento a prazo

pedido_bloqueado_aprazo_valornumber · máx: 15Opcional

Valor dos pedidos bloqueados com pagamento a prazo

pedido_bloqueado_cartao_numeronumber · máx: 6Opcional

Quantidade de pedidos bloqueados com pagamento em cartão

pedido_bloqueado_cartao_quantidadenumber · máx: 15Opcional

Quantidade produtos nos pedidos bloqueados com pagamento em cartão

pedido_bloqueado_cartao_valornumber · máx: 15Opcional

Valor dos pedidos bloqueados com pagamento em cartão

titulos_vencidos_numeronumber · máx: 6Opcional

Número de titulos vencidos

Example: 0

titulos_vencidos_quantidadenumber · máx: 6Opcional

Quantidade de titulos vencidos

titulos_vencidos_valornumber · máx: 15Opcional

Valor dos titulos vencidos

Example: 0

titulos_avencer_numeronumber · máx: 6Opcional

Numero de titulos a vencer

Example: 0

titulos_avencer_quantidadenumber · máx: 15Opcional

Quantidade de titulos a vencer

titulos_avencer_valornumber · máx: 15Opcional

Valor dos titulos a vencer

Example: 0

nr_cartao_creditonumber · máx: 6Opcional

Quantidade de parcelas de cartão de crédito

valor_cartao_creditonumber · máx: 15Opcional

Valor das parcelas de cartão de crédito

devolucao_mercadoria_numeronumber · máx: 6Opcional

Quantidade de devoluções de mercadoria

Example: 0

devolucao_mercadoria_valornumber · máx: 15Opcional

Valor das devoluções de mercadoria

Example: 0

cheques_associados_numeronumber · máx: 6Opcional

Quantidade de cheques associados ao cliente

cheques_associados_valornumber · máx: 15Opcional

Valor dos cheques associados ao cliente

Example: 0

limite_credito_numeronumber · máx: 6Opcional

Quantidade de limite de crédito gravados para o cliente

Example: 1

limite_credito_quantidadenumber · máx: 15Opcional

Limite crédito de quantidade para o cliente

Example: 0

limite_credito_valornumber · máx: 15Opcional

Limite crédito de valor para o cliente

Example: 0

limite_credito_grupo_numeronumber · máx: 6Opcional

Quantidade de limite de crédito para o grupo economico gravados para o cliente

limite_credito_grupo_quantidadenumber · máx: 15Opcional

Limite crédito de quantidade para o grupo economico do cliente

Example: 0

limite_credito_grupo_valornumber · máx: 15Opcional

Limite crédito de valor para o grupo economico do cliente

Example: 0

saldo_adiantamento_numeronumber · máx: 6Opcional

Quantidade de adiantamentos do cliente

Example: 8

saldo_adiantamento_valornumber · máx: 15Opcional

Valor total dos adiantamentos do cliente

Example: 0

saldo_limite_numeronumber · máx: 6Opcional

Quantidade de saldo de limite

Example: 1

saldo_limite_quantidadenumber · máx: 15Opcional

Saldo de limite de crédito por quantidade

Example: 0

saldo_limite_valornumber · máx: 15Opcional

Saldo de limite de crédito por valor

Example: 0

saldo_limite_grupo_numeronumber · máx: 6Opcional

Quantidade de saldo de limite

saldo_limite_grupo_quantidadenumber · máx: 15Opcional

Saldo de limite de crédito por quantidade

Example: 0

saldo_limite_grupo_valornumber · máx: 15Opcional

Saldo de limite de crédito por valor

Example: 0

total_faturado_numeronumber · máx: 6Opcional

Quantidade de notas faturadas para o cliente

Example: 0

total_faturado_quantidadenumber · máx: 15Opcional

Quantidade de produtos faturados para o cliente

Example: 0

total_faturado_valornumber · máx: 15Opcional

Valor dos produtos faturados para o cliente

Example: 0

valor_maior_titulonumber · máx: 15Opcional

Valor do maior titulo

Example: 0

data_maior_titulostring · date-timeOpcional

Data do maior titulo

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_maior_acumulonumber · máx: 15Opcional

Valor do maior acumulo

Example: 0

data_maior_acumulostring · date-timeOpcional

Data do maior acumulo

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_maior_pedidonumber · máx: 15Opcional

Maior valor de pedido

Example: 0

data_maior_pedidostring · date-timeOpcional

Data do maior pedido

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_ultima_compranumber · máx: 15Opcional

Valor do ultimo pedido

Example: 0

data_ultima_comprastring · date-timeOpcional

Data do ultimo pedido

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

data_ultimo_pedido_aprovadostring · date-timeOpcional

Data do ultimo pedido aprovado

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_ultimo_pedido_aprovadonumber · máx: 15Opcional

Valor do ultimo pedido aprovado

Example: 0

data_ultimo_atrasostring · date-timeOpcional

Data do ultimo atraso

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_ultimo_atrasonumber · máx: 15Opcional

Valor do ultimo atraso

Example: 0

valor_maior_faturanumber · máx: 15Opcional

Valor da maior fatura

Example: 0

data_maior_faturastring · date-timeOpcional

Data da maior fatura

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_ultimo_faturamentonumber · máx: 15Opcional

Valor do ultimo faturamento

Example: 0

data_ultimo_faturamentostring · date-timeOpcional

Data do ultimo faturamento

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

dias_maior_atrasonumber · máx: 5Opcional

Número de dias do maior atraso

Example: 0

data_maior_atrasostring · date-timeOpcional

Data do maior atraso

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

prazo_medionumber · máx: 6Opcional

Prazo médio

Example: 0

qtde_dias_atraso_medionumber · máx: 7Opcional

Número de dias para o atraso médio

Example: 0

data_cadastrostring · date-timeOpcional

Data de cadastro do cliente

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

situacao_creditonumber · máx: 1Opcional

(1) - Normal ou (2) - Suspenso

Example: 1

dias_atrasonumber · máx: 7Opcional

Número de dias de atraso

Example: 0

validade_limite_clientestring · date-timeOpcional

Data de cadastro do cliente

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

validade_limite_grupostring · date-timeOpcional

Data de cadastro do cliente

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

401

Não autorizado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

get

/credito/v1/consulta

HTTPcURLJavaScriptPython

GET /credito/v1/consulta HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "cnpj_9": 29911640,
  "cnpj_4": 1,
  "cnpj_2": 35,
  "nome_cliente": "L FLORENCIO DA SILVA CONFECCOES",
  "pedido_liberado_avista_numero": null,
  "pedido_liberado_avista_quantidade": null,
  "pedido_liberado_avista_valor": null,
  "pedido_liberado_aprazo_numero": null,
  "pedido_liberado_aprazo_quantidade": null,
  "pedido_liberado_aprazo_valor": null,
  "pedido_liberado_cartao_numero": null,
  "pedido_liberado_cartao_quantidade": null,
  "pedido_liberado_cartao_valor": null,
  "pedido_bloqueado_avista_numero": null,
  "pedido_bloqueado_avista_quantidade": null,
  "pedido_bloqueado_avista_valor": null,
  "pedido_bloqueado_aprazo_numero": null,
  "pedido_bloqueado_aprazo_quantidade": null,
  "pedido_bloqueado_aprazo_valor": null,
  "pedido_bloqueado_cartao_numero": null,
  "pedido_bloqueado_cartao_quantidade": null,
  "pedido_bloqueado_cartao_valor": null,
  "titulos_vencidos_numero": 0,
  "titulos_vencidos_quantidade": null,
  "titulos_vencidos_valor": 0,
  "titulos_avencer_numero": 0,
  "titulos_avencer_quantidade": null,
  "titulos_avencer_valor": 0,
  "nr_cartao_credito": null,
  "valor_cartao_credito": null,
  "devolucao_mercadoria_numero": 0,
  "devolucao_mercadoria_valor": 0,
  "cheques_associados_numero": null,
  "cheques_associados_valor": 0,
  "limite_credito_numero": 1,
  "limite_credito_quantidade": 0,
  "limite_credito_valor": 0,
  "limite_credito_grupo_numero": null,
  "limite_credito_grupo_quantidade": 0,
  "limite_credito_grupo_valor": 0,
  "saldo_adiantamento_numero": 8,
  "saldo_adiantamento_valor": 0,
  "saldo_limite_numero": 1,
  "saldo_limite_quantidade": 0,
  "saldo_limite_valor": 0,
  "saldo_limite_grupo_numero": null,
  "saldo_limite_grupo_quantidade": 0,
  "saldo_limite_grupo_valor": 0,
  "total_faturado_numero": 0,
  "total_faturado_quantidade": 0,
  "total_faturado_valor": 0,
  "valor_maior_titulo": 0,
  "data_maior_titulo": null,
  "valor_maior_acumulo": 0,
  "data_maior_acumulo": null,
  "valor_maior_pedido": 0,
  "data_maior_pedido": null,
  "valor_ultima_compra": 0,
  "data_ultima_compra": "2022-03-17T03:00:00Z",
  "data_ultimo_pedido_aprovado": null,
  "valor_ultimo_pedido_aprovado": 0,
  "data_ultimo_atraso": null,
  "valor_ultimo_atraso": 0,
  "valor_maior_fatura": 0,
  "data_maior_fatura": null,
  "valor_ultimo_faturamento": 0,
  "data_ultimo_faturamento": null,
  "dias_maior_atraso": 0,
  "data_maior_atraso": null,
  "prazo_medio": 0,
  "qtde_dias_atraso_medio": 0,
  "data_cadastro": "2022-03-10T03:00:00Z",
  "situacao_credito": 1,
  "dias_atraso": 0,
  "validade_limite_cliente": "2022-03-10T03:00:00Z",
  "validade_limite_grupo": "2022-03-10T03:00:00Z"
}