Fornecedor

Consulta Fornecedor

get

/pessoa/v1/fornecedor

API para integração de consulta Fornecedor/Transportadora. 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

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

Os 9 dígitos principais do CNPJ ou CPF

Example: 5164989

cnpj_4_fornecedornumber · máx: 4Opcional

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

Example: 1

cnpj_2_fornecedornumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 92

nome_fornecedorstring · máx: 40Opcional

Nome/Razão Social

Example: ACRONSOFT GESTAO DA INFORMACAO LTDA

nome_fantasiastring · máx: 40Opcional

Nome fantasia do fornecedor

Example: ACRONSOFT SOLUCOES

tipo_fornecedor_idnumber · máx: 2Opcional

Código do tipo de fornecedor

Example: 81

tipo_fornecedor_descricaostring · máx: 20Opcional

Descrição do tipo de fornecedor

Example: SV SUP TEC INFORMATI

tipo_fornecedor_agrup_idnumber · máx: 9Opcional

Código do agrupador do tipo de fornecedor

Example: 0

tipo_fornecedor_agrup_descstring · máx: 20Opcional

Descrição do agrupador do tipo de fornecedor

Example: SERV BENEFICIAMENTO

codigo_fornecedorstring · máx: 15Opcional

Código do fornecedor

Example: 305999200

nome_contato_padrao_fornecedorstring · máx: 20Opcional

Nome do contato do fornecedor

cep_fornecedornumber · máx: 8Opcional

CEP do fornecedor

Example: 7020010

endereco_fornecedorstring · máx: 60Opcional

Endereço do fornecedor

Example: AV. EMILIO RIBAS

numero_fornecedorstring · máx: 5Opcional

Numero do endereço do fornecedor

Example: 152

bairro_fornecedorstring · máx: 20Opcional

Bairro do fornecedor

Example: GOPOUVA

complemento_fornecedorstring · máx: 20Opcional

Complemento do fornecedor

Example: SALA 809

cidade_fornecedor_idnumber · máx: 5Opcional

Código da cidade do fornecedor

Example: 3702

cidade_fornecedor_descricaostring · máx: 25Opcional

Nome da cidade do fornecedor

Example: GUARULHOS

codigo_ibge_fornecedornumber · máx: 7Opcional

Código do IBGE da cidade

Example: 3518800

estado_fornecedorstring · máx: 2Opcional

Estado do fornecedor

Example: SP

caixa_postal_fornecedorstring · máx: 7Opcional

Caixa postal do fornecedor

telex_fornecedornumber · máx: 8Opcional

Telex do fornecedor

Example: 0

call_free_fornecedorstring · máx: 15Opcional

Call Free do fornecedor

telefone_fornecedornumber · máx: 8Opcional

Telefone do fornecedor

Example: 43781114

ddd_celular_fornecedornumber · máx: 4Opcional

DDD do celular do fornecedor

celular_fornecedornumber · máx: 9Opcional

Celular do fornecedor

Example: 91721244

fax_fornecedornumber · máx: 8Opcional

Fax do fornecedor

Example: 99936304

site_fornecedorstring · máx: 30Opcional

Site do fornecedor

email_nfe_fornecedorstring · máx: 100Opcional

E-mail nfe do fornecedor

Example: [email protected]

email_fornecedorstring · máx: 4000Opcional

E-mail do fornecedor

Example: [email protected]

inscricao_estadual_fornecedorstring · máx: 14Opcional

Inscrição Estadual do fornecedor

Example: 796124858119

inscricao_municipal_fornecedorstring · máx: 15Opcional

Inscrição Municipal do fornecedor

inscricao_inss_fornecedorstring · máx: 12Opcional

Inscrição do fornecedor no INSS

observacoes_fornecedorstring · máx: 50Opcional

Observações do fornecedor

data_cadastro_fornecedorstring · date-timeOpcional

Data do cadastro do fornecedor

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

situacao_fornecedornumber · máx: 1Opcional

Informe: (1) - Ativo, (2) - Inativo, (3) - Não qualificado ou (9) - Pré_cadastro

Example: 1

codigo_contabil_idnumber · máx: 6Opcional

Código Contábil do fornecedor

Example: 710

codigo_contabil_descricaostring · máx: 45Opcional

Descrição do código Contábil do fornecedor

Example: FORNECEDORES MATRIZ

codigo_contabil_irrf_idnumber · máx: 6Opcional

Código Contábil do IRRF do fornecedor

Example: 0

codigo_contabil_irrf_descricaostring · máx: 45Opcional

Descrição do Código Contábil do IRRF do fornecedor

tipo_pagamento_fornecedor_idnumber · máx: 2Opcional

Código do tipo de pagamento para o fornecedor

Example: 2

tipo_pagamento_fornecedor_descricaostring · máx: 60Opcional

Descrição do tipo de pagamento para o fornecedor

Example: BOLETO

idioma_pedido_compranumber · máx: 3Opcional

(0) - Para não usar o parâmetro, (1) - Para idioma espanhol ou (2) - Para idioma inglês

Example: 0

cancelamento_fornecedor_idnumber · máx: 2Opcional

Código do motivo para cancelamento de fornecedor

Example: 0

cancelamento_fornecedor_descricaostring · máx: 20Opcional

Descrição do motivo para cancelamento de fornecedor

Example: Teste

data_cancelamento_fornecedorstring · date-timeOpcional

Data de cancelamento de fornecedor

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

incide_imposto_fornecedorstring · máx: 5Opcional

Informe: True - Incide Imposto da retenção (ISS) ou False - Não incide imposto.

Example: true

tipo_frete_fornecedornumber · máx: 1Opcional

(1)-Frete por conta do emitente ou (2)-Por conta do destinatário ou (3)-Terceiros ou (4)-Cortesia ou (9)-Sem Frete.

Example: 1

condicao_pagamento_fornecedor_idnumber · máx: 3Opcional

Condição de pagamento para o Fornecedor

Example: 2

condicao_pagamento_fornecedor_descricaostring · máx: 20Opcional

Descrição da condição de pagamento para o fornecedor

Example: 30 DIAS

cnpj_9_transportadora_fornecedornumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF da transportadora do fornecedor

Example: 0

cnpj_4_transportadora_fornecedornumber · máx: 4Opcional

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

Example: 0

cnpj_2_transportadora_fornecedornumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF da transportadora do fornecedor

Example: 0

nome_transportadora_fornecedorstring · máx: 40Opcional

Nome da Transportadora do fornecedor

Example: ACRONSOFT GESTAO DA INFORMACAO LTDA

codigo_relacionamento_sped_contabilnumber · máx: 2Opcional

'(0) - Fornecedor sem relacionamento (default) (1) - Matriz no exterior (2) - Filial, inclusive agência ou dependência, no exterior (3) - Coligada, inclusive equiparada (4) - Controladora (5) - Controladora(exceto subsidiária integral); (6) - Subsidiária integral (7) - Controlada em conjunto (8) - Entidade de propósito específico(conforme definição da CVM) (9) - Participante do conglomerado, conforme norma específica do órgão regulador, exceto as que se enquadrem nos tipos precedentes (10) - Vinculadas (Art. 23 da Lei 9.430/96), exceto as que se enquadrem nos tipos precedentes (11) - Localizada em país com tributação favorecida (Art. 24 da lei 9.430/96), exceto as que se enquadrem nos tipos precedentes.'

Example: 0

fornecedor_optante_simplesstring · máx: 5Opcional

Fornecedor é optante do simples. Informe true ou false.

Example: true

fornecedor_considera_ttdstring · máx: 5Opcional

Fornecedor participa das regras do TTD para produtos nacionais importados. Informe true ou false.

Example: true

permite_substituir_cnpj9string · máx: 5Opcional

Permite Substituição de Títulos para CNPJ9 diferentes deste? Informe true ou false.

Example: true

data_atualizacao_apistring · date-timeOpcional

Data de cancelamento de fornecedor

Pattern: ^\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

/pessoa/v1/fornecedor

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

{
  "cnpj_9_fornecedor": 5164989,
  "cnpj_4_fornecedor": 1,
  "cnpj_2_fornecedor": 92,
  "nome_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
  "nome_fantasia": "ACRONSOFT SOLUCOES",
  "tipo_fornecedor_id": 81,
  "tipo_fornecedor_descricao": "SV SUP TEC INFORMATI",
  "tipo_fornecedor_agrup_id": 0,
  "tipo_fornecedor_agrup_desc": "SERV BENEFICIAMENTO",
  "codigo_fornecedor": 305999200,
  "nome_contato_padrao_fornecedor": null,
  "cep_fornecedor": 7020010,
  "endereco_fornecedor": "AV. EMILIO RIBAS",
  "numero_fornecedor": 152,
  "bairro_fornecedor": "GOPOUVA",
  "complemento_fornecedor": "SALA 809",
  "cidade_fornecedor_id": 3702,
  "cidade_fornecedor_descricao": "GUARULHOS",
  "codigo_ibge_fornecedor": 3518800,
  "estado_fornecedor": "SP",
  "caixa_postal_fornecedor": null,
  "telex_fornecedor": 0,
  "call_free_fornecedor": null,
  "telefone_fornecedor": 43781114,
  "ddd_celular_fornecedor": null,
  "celular_fornecedor": 91721244,
  "fax_fornecedor": 99936304,
  "site_fornecedor": null,
  "email_nfe_fornecedor": "[email protected]",
  "email_fornecedor": "[email protected]",
  "inscricao_estadual_fornecedor": 796124858119,
  "inscricao_municipal_fornecedor": null,
  "inscricao_inss_fornecedor": null,
  "observacoes_fornecedor": null,
  "data_cadastro_fornecedor": "2021-04-23T03:00:00Z",
  "situacao_fornecedor": 1,
  "codigo_contabil_id": 710,
  "codigo_contabil_descricao": "FORNECEDORES MATRIZ",
  "codigo_contabil_irrf_id": 0,
  "codigo_contabil_irrf_descricao": null,
  "tipo_pagamento_fornecedor_id": 2,
  "tipo_pagamento_fornecedor_descricao": "BOLETO",
  "idioma_pedido_compra": 0,
  "cancelamento_fornecedor_id": 0,
  "cancelamento_fornecedor_descricao": "Teste",
  "data_cancelamento_fornecedor": null,
  "incide_imposto_fornecedor": "true",
  "tipo_frete_fornecedor": 1,
  "condicao_pagamento_fornecedor_id": 2,
  "condicao_pagamento_fornecedor_descricao": "30 DIAS",
  "cnpj_9_transportadora_fornecedor": 0,
  "cnpj_4_transportadora_fornecedor": 0,
  "cnpj_2_transportadora_fornecedor": 0,
  "nome_transportadora_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
  "codigo_relacionamento_sped_contabil": 0,
  "fornecedor_optante_simples": "true",
  "fornecedor_considera_ttd": "true",
  "permite_substituir_cnpj9": "true",
  "data_atualizacao_api": null,
  "contatos": [],
  "portadores": [],
  "informacoes_gerais": [],
  "socios": [],
  "produtos_fornecidos": [],
  "coligados": [],
  "atributo": {
    "empresa_id": 1,
    "empresa_descricao": "SYSTEXTIL TES WEB DEVS",
    "transportadora_envia_arquivo": "true",
    "layout_remessa_arquivo": "inte_expedi_004",
    "gera_registro_314": "false",
    "nivel_produto_frete": 1,
    "grupo_produto_frete_id": 1,
    "subgrupo_produto_frete_id": 1,
    "item_produto_frete_id": 1,
    "envia_consignacao": "true",
    "centro_custo_frete_id": 0,
    "centro_custo_frete_descricao": "ALMOXARIFE",
    "natureza_frete": 0,
    "estado_natureza_frete": null,
    "descricao_natureza_frete": null,
    "especie_documento_frete": null,
    "condicao_pagamento_frete_id": 0,
    "condicao_pagamento_frete_descricao": null,
    "portador_frete_id": 0,
    "portador_frete_descricao": "CARTEIRA",
    "tipo_titulo_frete_id": 0,
    "tipo_titulo_frete_descricao": null,
    "preenchimento_coluna_livre": "true",
    "duplicata_unica": "false",
    "origem_chave_cte": "false",
    "agrupamento_notas_conhecimento": "false"
  },
  "pix": [],
  "imposto": {
    "aliquota_irrf": 1,
    "codigo_retencao_irrf": 1,
    "aliquota_iss": 1,
    "codigo_retencao_iss": 1,
    "aliquota_inss": 1,
    "codigo_retencao_inss": 1,
    "aliquota_pis": 1,
    "codigo_retencao_pis": 1,
    "aliquota_cofins": 1,
    "codigo_retencao_cofins": 1,
    "aliquota_csl": 1,
    "codigo_retencao_csl": 1,
    "aliquota_csrf": 1,
    "codigo_retencao_csrf": 1,
    "natureza_rendimento": 1
  },
  "tipo_materia_prima": []
}

Cadastro Fornecedor

post

/pessoa/v1/fornecedor

API para integração de POST de Fornecedor.

(*) - Campos obrigatórios/campos chave (cnpj_9_fornecedor, cnpj_4_fornecedor, cnpj_2_fornecedor, tipo_fornecedor_id, cep_fornecedor, endereco_fornecedor, numero_fornecedor, bairro_fornecedor, cidade_fornecedor_id, nome_contato_fornecedor, banco_fornecedor_id, data_informacao, sequencia_informacao, tipo_socio, nivel_produto, grupo_id, subgrupo_id, item_estrutura_id, tipo_chave_pix)

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

201

Sucesso na inclusão.

application/json

400

Erro em validação de negócio.

application/json

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

409

Requisição não aceita, envio já cadastrado.

application/json

500

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

application/json

post

/pessoa/v1/fornecedor

POST /pessoa/v1/fornecedor HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3380

{
  "items": [
    {
      "cnpj_9_fornecedor": 5164989,
      "cnpj_4_fornecedor": 1,
      "cnpj_2_fornecedor": 92,
      "nome_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
      "nome_fantasia": "ACRONSOFT SOLUCOES",
      "tipo_fornecedor_id": 81,
      "tipo_fornecedor_descricao": "SV SUP TEC INFORMATI",
      "tipo_fornecedor_agrup_id": 0,
      "tipo_fornecedor_agrup_desc": "SERV BENEFICIAMENTO",
      "codigo_fornecedor": 305999200,
      "nome_contato_padrao_fornecedor": null,
      "cep_fornecedor": 7020010,
      "endereco_fornecedor": "AV. EMILIO RIBAS",
      "numero_fornecedor": 152,
      "bairro_fornecedor": "GOPOUVA",
      "complemento_fornecedor": "SALA 809",
      "cidade_fornecedor_id": 3702,
      "cidade_fornecedor_descricao": "GUARULHOS",
      "codigo_ibge_fornecedor": 3518800,
      "estado_fornecedor": "SP",
      "caixa_postal_fornecedor": null,
      "telex_fornecedor": 0,
      "call_free_fornecedor": null,
      "telefone_fornecedor": 43781114,
      "ddd_celular_fornecedor": null,
      "celular_fornecedor": 91721244,
      "fax_fornecedor": 99936304,
      "site_fornecedor": null,
      "email_nfe_fornecedor": "[email protected]",
      "email_fornecedor": "[email protected]",
      "inscricao_estadual_fornecedor": 796124858119,
      "inscricao_municipal_fornecedor": null,
      "inscricao_inss_fornecedor": null,
      "observacoes_fornecedor": null,
      "data_cadastro_fornecedor": "2021-04-23T03:00:00Z",
      "situacao_fornecedor": 1,
      "codigo_contabil_id": 710,
      "codigo_contabil_descricao": "FORNECEDORES MATRIZ",
      "codigo_contabil_irrf_id": 0,
      "codigo_contabil_irrf_descricao": null,
      "tipo_pagamento_fornecedor_id": 2,
      "tipo_pagamento_fornecedor_descricao": "BOLETO",
      "idioma_pedido_compra": 0,
      "cancelamento_fornecedor_id": 0,
      "cancelamento_fornecedor_descricao": "Teste",
      "data_cancelamento_fornecedor": null,
      "incide_imposto_fornecedor": "true",
      "tipo_frete_fornecedor": 1,
      "condicao_pagamento_fornecedor_id": 2,
      "condicao_pagamento_fornecedor_descricao": "30 DIAS",
      "cnpj_9_transportadora_fornecedor": 0,
      "cnpj_4_transportadora_fornecedor": 0,
      "cnpj_2_transportadora_fornecedor": 0,
      "nome_transportadora_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
      "codigo_relacionamento_sped_contabil": 0,
      "fornecedor_optante_simples": "true",
      "fornecedor_considera_ttd": "true",
      "permite_substituir_cnpj9": "true",
      "data_atualizacao_api": null,
      "contatos": [],
      "portadores": [],
      "informacoes_gerais": [],
      "socios": [],
      "produtos_fornecidos": [],
      "coligados": [],
      "atributo": {
        "empresa_id": 1,
        "empresa_descricao": "SYSTEXTIL TES WEB DEVS",
        "transportadora_envia_arquivo": "true",
        "layout_remessa_arquivo": "inte_expedi_004",
        "gera_registro_314": "false",
        "nivel_produto_frete": 1,
        "grupo_produto_frete_id": 1,
        "subgrupo_produto_frete_id": 1,
        "item_produto_frete_id": 1,
        "envia_consignacao": "true",
        "centro_custo_frete_id": 0,
        "centro_custo_frete_descricao": "ALMOXARIFE",
        "natureza_frete": 0,
        "estado_natureza_frete": null,
        "descricao_natureza_frete": null,
        "especie_documento_frete": null,
        "condicao_pagamento_frete_id": 0,
        "condicao_pagamento_frete_descricao": null,
        "portador_frete_id": 0,
        "portador_frete_descricao": "CARTEIRA",
        "tipo_titulo_frete_id": 0,
        "tipo_titulo_frete_descricao": null,
        "preenchimento_coluna_livre": "true",
        "duplicata_unica": "false",
        "origem_chave_cte": "false",
        "agrupamento_notas_conhecimento": "false"
      },
      "pix": [],
      "imposto": {
        "aliquota_irrf": 1,
        "codigo_retencao_irrf": 1,
        "aliquota_iss": 1,
        "codigo_retencao_iss": 1,
        "aliquota_inss": 1,
        "codigo_retencao_inss": 1,
        "aliquota_pis": 1,
        "codigo_retencao_pis": 1,
        "aliquota_cofins": 1,
        "codigo_retencao_cofins": 1,
        "aliquota_csl": 1,
        "codigo_retencao_csl": 1,
        "aliquota_csrf": 1,
        "codigo_retencao_csrf": 1,
        "natureza_rendimento": 1
      },
      "tipo_materia_prima": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Alteração Fornecedor

put

/pessoa/v1/fornecedor

API para integração de PUT de Fornecedor.

(*) - Campos obrigatórios/campos chave (cnpj_9_fornecedor, cnpj_4_fornecedor, cnpj_2_fornecedor, nome_contato_fornecedor, banco_fornecedor_id, data_informacao, sequencia_informacao, cpf_9_socio, cpf_2_socio, tipo_chave_pix)

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

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

application/json

put

/pessoa/v1/fornecedor

PUT /pessoa/v1/fornecedor HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3380

{
  "items": [
    {
      "cnpj_9_fornecedor": 5164989,
      "cnpj_4_fornecedor": 1,
      "cnpj_2_fornecedor": 92,
      "nome_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
      "nome_fantasia": "ACRONSOFT SOLUCOES",
      "tipo_fornecedor_id": 81,
      "tipo_fornecedor_descricao": "SV SUP TEC INFORMATI",
      "tipo_fornecedor_agrup_id": 0,
      "tipo_fornecedor_agrup_desc": "SERV BENEFICIAMENTO",
      "codigo_fornecedor": 305999200,
      "nome_contato_padrao_fornecedor": null,
      "cep_fornecedor": 7020010,
      "endereco_fornecedor": "AV. EMILIO RIBAS",
      "numero_fornecedor": 152,
      "bairro_fornecedor": "GOPOUVA",
      "complemento_fornecedor": "SALA 809",
      "cidade_fornecedor_id": 3702,
      "cidade_fornecedor_descricao": "GUARULHOS",
      "codigo_ibge_fornecedor": 3518800,
      "estado_fornecedor": "SP",
      "caixa_postal_fornecedor": null,
      "telex_fornecedor": 0,
      "call_free_fornecedor": null,
      "telefone_fornecedor": 43781114,
      "ddd_celular_fornecedor": null,
      "celular_fornecedor": 91721244,
      "fax_fornecedor": 99936304,
      "site_fornecedor": null,
      "email_nfe_fornecedor": "[email protected]",
      "email_fornecedor": "[email protected]",
      "inscricao_estadual_fornecedor": 796124858119,
      "inscricao_municipal_fornecedor": null,
      "inscricao_inss_fornecedor": null,
      "observacoes_fornecedor": null,
      "data_cadastro_fornecedor": "2021-04-23T03:00:00Z",
      "situacao_fornecedor": 1,
      "codigo_contabil_id": 710,
      "codigo_contabil_descricao": "FORNECEDORES MATRIZ",
      "codigo_contabil_irrf_id": 0,
      "codigo_contabil_irrf_descricao": null,
      "tipo_pagamento_fornecedor_id": 2,
      "tipo_pagamento_fornecedor_descricao": "BOLETO",
      "idioma_pedido_compra": 0,
      "cancelamento_fornecedor_id": 0,
      "cancelamento_fornecedor_descricao": "Teste",
      "data_cancelamento_fornecedor": null,
      "incide_imposto_fornecedor": "true",
      "tipo_frete_fornecedor": 1,
      "condicao_pagamento_fornecedor_id": 2,
      "condicao_pagamento_fornecedor_descricao": "30 DIAS",
      "cnpj_9_transportadora_fornecedor": 0,
      "cnpj_4_transportadora_fornecedor": 0,
      "cnpj_2_transportadora_fornecedor": 0,
      "nome_transportadora_fornecedor": "ACRONSOFT GESTAO DA INFORMACAO LTDA",
      "codigo_relacionamento_sped_contabil": 0,
      "fornecedor_optante_simples": "true",
      "fornecedor_considera_ttd": "true",
      "permite_substituir_cnpj9": "true",
      "data_atualizacao_api": null,
      "contatos": [],
      "portadores": [],
      "informacoes_gerais": [],
      "socios": [],
      "produtos_fornecidos": [],
      "coligados": [],
      "atributo": {
        "empresa_id": 1,
        "empresa_descricao": "SYSTEXTIL TES WEB DEVS",
        "transportadora_envia_arquivo": "true",
        "layout_remessa_arquivo": "inte_expedi_004",
        "gera_registro_314": "false",
        "nivel_produto_frete": 1,
        "grupo_produto_frete_id": 1,
        "subgrupo_produto_frete_id": 1,
        "item_produto_frete_id": 1,
        "envia_consignacao": "true",
        "centro_custo_frete_id": 0,
        "centro_custo_frete_descricao": "ALMOXARIFE",
        "natureza_frete": 0,
        "estado_natureza_frete": null,
        "descricao_natureza_frete": null,
        "especie_documento_frete": null,
        "condicao_pagamento_frete_id": 0,
        "condicao_pagamento_frete_descricao": null,
        "portador_frete_id": 0,
        "portador_frete_descricao": "CARTEIRA",
        "tipo_titulo_frete_id": 0,
        "tipo_titulo_frete_descricao": null,
        "preenchimento_coluna_livre": "true",
        "duplicata_unica": "false",
        "origem_chave_cte": "false",
        "agrupamento_notas_conhecimento": "false"
      },
      "pix": [],
      "imposto": {
        "aliquota_irrf": 1,
        "codigo_retencao_irrf": 1,
        "aliquota_iss": 1,
        "codigo_retencao_iss": 1,
        "aliquota_inss": 1,
        "codigo_retencao_inss": 1,
        "aliquota_pis": 1,
        "codigo_retencao_pis": 1,
        "aliquota_cofins": 1,
        "codigo_retencao_cofins": 1,
        "aliquota_csl": 1,
        "codigo_retencao_csl": 1,
        "aliquota_csrf": 1,
        "codigo_retencao_csrf": 1,
        "natureza_rendimento": 1
      },
      "tipo_materia_prima": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Exclusão Fornecedor

delete

/pessoa/v1/fornecedor

API para integração de exclusão de fornecedor.

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

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.

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

{
  "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

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

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

application/json

delete

/pessoa/v1/fornecedor

DELETE /pessoa/v1/fornecedor HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

AnteriorUsuario Centro Custo PróximoGrupo Economico

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Fornecedor

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

hashtagCadastro Fornecedor

hashtagAPI para integração de POST de Fornecedor.

hashtagAlteração Fornecedor

hashtagAPI para integração de PUT de Fornecedor.

hashtagExclusão Fornecedor

hashtagAPI para integração de exclusão de fornecedor.

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

Consulta Fornecedor

Cadastro Fornecedor

API para integração de POST de Fornecedor.

Alteração Fornecedor

API para integração de PUT de Fornecedor.

Exclusão Fornecedor

API para integração de exclusão de fornecedor.