Documentacao Da API de Integracao SuasVendas

DOCUMENTAO DA API DE INTEGRAO SUASVENDAS
Verso: 2.0.1 Junho/2016
www.SuasVendas.com 1
Sumrio
DOCUMENTAO DA API DE INTEGRAO SUASVENDAS ....................................................................................................... 1
Integrao SuasVendas ............................................................................................................................................................. 7
Segurana ................................................................................................................................................................................. 7
Especificao Geral da API ........................................................................................................................................................ 7
Atributos gerais..................................................................................................................................................................... 7
Estrutura ........................................................................................................................................................................... 7
Exemplo ............................................................................................................................................................................ 8
Retorno Padro para POST, PUT e DELETE ........................................................................................................................... 8
Exemplo ............................................................................................................................................................................ 8
Mensagens Padro de sucesso e erro .................................................................................................................................. 8
Exemplo ............................................................................................................................................................................ 9
Enumeradores....................................................................................................................................................................... 9
ColaboradorStatus ............................................................................................................................................................ 9
ColaboradorTipo ............................................................................................................................................................... 9
ContaComissaoPagamento ............................................................................................................................................... 9
ContaStatus ....................................................................................................................................................................... 9
ContaTipo .......................................................................................................................................................................... 9
ContaTipoPessoa............................................................................................................................................................... 9
EstadoCivil ......................................................................................................................................................................... 9
OperacaoBancoDados..................................................................................................................................................... 10
PedidoComissaoStatus.................................................................................................................................................... 10
PedidoMoeda.................................................................................................................................................................. 10
PedidoParcelaStatus ....................................................................................................................................................... 10
PedidoParcelaTipoDocumento ....................................................................................................................................... 10
PedidoTipo ...................................................................................................................................................................... 10
PedidoTipoFrete ............................................................................................................................................................. 10
ProdutoStatus ................................................................................................................................................................. 11
Sexo ................................................................................................................................................................................. 11
Especificao dos Endpoints ................................................................................................................................................... 11
Colaborador ........................................................................................................................................................................ 11
URLs ................................................................................................................................................................................ 11
Parmetros GET .............................................................................................................................................................. 11
Campos do JSON ............................................................................................................................................................. 11
JSON para POST e PUT .................................................................................................................................................... 13
JSON para DELETE ........................................................................................................................................................... 13
Vendedor Indstria ............................................................................................................................................................. 13
URLs ................................................................................................................................................................................ 13
Parmetros GET .............................................................................................................................................................. 14
Campos do JSON ............................................................................................................................................................. 14
JSON para DELETE ........................................................................................................................................................... 15
Vendedor Regio ................................................................................................................................................................ 15
URLs ................................................................................................................................................................................ 15
Parmetros GET .............................................................................................................................................................. 15
Campos do JSON ............................................................................................................................................................. 16
JSON para DELETE ........................................................................................................................................................... 16
Conta ................................................................................................................................................................................... 16
URLs ................................................................................................................................................................................ 16
Parmetros GET .............................................................................................................................................................. 17
Campos do JSON ............................................................................................................................................................. 17
JSON para DELETE ........................................................................................................................................................... 21
Cliente Indstria Desconto ................................................................................................................................................. 22
URLs ................................................................................................................................................................................ 22
Parmetros GET .............................................................................................................................................................. 22
Campos do JSON ............................................................................................................................................................. 22
JSON para DELETE ........................................................................................................................................................... 23
Cliente Vendedor ................................................................................................................................................................ 23
URLs ................................................................................................................................................................................ 23
Parmetros GET .............................................................................................................................................................. 23
Campos do JSON ............................................................................................................................................................. 24
JSON para DELETE ........................................................................................................................................................... 24
Cliente Transportadora ....................................................................................................................................................... 24
URLs ................................................................................................................................................................................ 24
Parmetros GET .............................................................................................................................................................. 25
Campos do JSON ............................................................................................................................................................. 25
JSON para DELETE ........................................................................................................................................................... 25
Indstria Grade ................................................................................................................................................................... 25
URLs ................................................................................................................................................................................ 26
Parmetros GET .............................................................................................................................................................. 26
Campos do JSON ............................................................................................................................................................. 26
JSON para DELETE ........................................................................................................................................................... 26
Produto ............................................................................................................................................................................... 27
URLs ................................................................................................................................................................................ 27
Parmetros GET .............................................................................................................................................................. 27
Campos do JSON ............................................................................................................................................................. 27
JSON para DELETE ........................................................................................................................................................... 30
Produto ST .......................................................................................................................................................................... 30
URLs ................................................................................................................................................................................ 30
Parmetros GET .............................................................................................................................................................. 30
Campos do JSON ............................................................................................................................................................. 30
JSON para DELETE ........................................................................................................................................................... 31
Produto Foto ....................................................................................................................................................................... 31
URLs ................................................................................................................................................................................ 31
Parmetros GET .............................................................................................................................................................. 31
Campos do JSON ............................................................................................................................................................. 32
JSON para DELETE ........................................................................................................................................................... 33
Produto Categoria............................................................................................................................................................... 33
URLs ................................................................................................................................................................................ 33
Parmetros GET .............................................................................................................................................................. 33
Campos do JSON ............................................................................................................................................................. 33
JSON para DELETE ........................................................................................................................................................... 34
Tabela de Preo .................................................................................................................................................................. 34
URLs ................................................................................................................................................................................ 34
Parmetros GET .............................................................................................................................................................. 34
Campos do JSON ............................................................................................................................................................. 34
JSON para DELETE ........................................................................................................................................................... 35
Regio ................................................................................................................................................................................. 35
URLs ................................................................................................................................................................................ 35
Parmetros GET .............................................................................................................................................................. 35
Campos do JSON ............................................................................................................................................................. 36
JSON para DELETE ........................................................................................................................................................... 36
Pedido Status ...................................................................................................................................................................... 36
URLs ................................................................................................................................................................................ 36
Parmetros GET .............................................................................................................................................................. 37
Campos do JSON ............................................................................................................................................................. 37
JSON para DELETE ........................................................................................................................................................... 37
Pedido ................................................................................................................................................................................. 37
URLs ................................................................................................................................................................................ 37
Parmetros GET .............................................................................................................................................................. 38
Campos do JSON ............................................................................................................................................................. 38
JSON para DELETE ........................................................................................................................................................... 42
Pedido Item......................................................................................................................................................................... 42
URLs ................................................................................................................................................................................ 42
Parmetros GET .............................................................................................................................................................. 43
Campos do JSON ............................................................................................................................................................. 43
JSON para DELETE ........................................................................................................................................................... 45
Pedido Item Grade .............................................................................................................................................................. 45
URLs ................................................................................................................................................................................ 45
Parmetros GET .............................................................................................................................................................. 45
Campos do JSON ............................................................................................................................................................. 45
JSON para DELETE ........................................................................................................................................................... 46
Pedido Comisso ................................................................................................................................................................. 46
URLs ................................................................................................................................................................................ 46
Parmetros GET .............................................................................................................................................................. 46
Campos do JSON ............................................................................................................................................................. 47
JSON para DELETE ........................................................................................................................................................... 48
Pedido Parcela .................................................................................................................................................................... 48
URLs ................................................................................................................................................................................ 48
Parmetros GET .............................................................................................................................................................. 48
Campos do JSON ............................................................................................................................................................. 49
JSON para DELETE ........................................................................................................................................................... 49
Dados para contato tcnico: ................................................................................................................................................... 51
Integrao SuasVendas
A integrao com o SuasVendas feita atravs de nossa API em protocolo HTTPS (modelo REST), e os dados so
comunicados em formato JSON. Dessa forma seu sistema poder se comunicar com nossos servidores em um ambiente
seguro, como internet bank e sites de pagamentos, atravs dos mtodos GET e POST padres de fcil utilizao. Assim
seu sistema utilizar esses mtodos para fazer leitura, cadastro e atualizao de registros.
A Integrao SuasVendas se comunica com qualquer linguagem que possua bibliotecas ou componentes que
realizem conexes em HTTP e HTTPS, e leitura/escrita de dados em formato JSON. Atualmente a maioria das linguagens
possuem essas bibliotecas ou componentes prontas para este tipo de operao.
Segurana
A segurana dos seus dados uma das nossas maiores prioridades. Por isso a API possui um mecanismo de
autenticao que impede que outros usurios tenham acesso e faam qualquer tipo de alterao nas informaes dos
seus clientes.
Esse mecanismo de autenticao baseado em tokens. Os tokens so parecidos com uma senha de acesso, mas
com a vantagem de serem nicos dentro do sistema. Eles so gerados automaticamente de tal maneira que nunca se
repetiro. Desta forma, garantimos que todos os clientes e todas as empresas parceiras possuem um token exclusivo que
as identifica.
Ao fazer qualquer operao na API, voc dever enviar duas chaves no header do comando HTTP
1. Authorization: Token nico de autenticao de acesso. Esse parmetro deve ser enviado no
sequinte padro
a. Authorization: Bearer <Token>. Sem a palavra chave Bearer no corpo da chave a API
no validar o Token;
2. Content-Type: Informao ao servidor do tipo de arquivo enviado. Esta API trabalha somente
com arquivos JSON, portanto qualquer outro tipo ser ignorado. Exemplo de chave:
a. Content-Type: application/json.
Ao receber esse token de acesso, ser sua responsabilidade guardar estas chaves em segurana, para garantir
que ningum fora da sua empresa tenha acesso aos dados.
Especificao Geral da API

Abaixo temos a especificao de todos os atributos e dados do JSON do API do SuasVendas.
Atributos gerais
Os campos abaixo estaro contidos em todos os JSON desta API. So campos de controle importante para
auditoria e integrao dos sistemas.
Estrutura
Atributo Tipo Obrigatrio Valor Padro Descrio
ys_cola_id INTEIRO S ID do colaborador que inseriu o registro.
ys_datahora_insercao DATAHORA S Data/Hora em que o registro foi inserido.
Data/Hora em que o registro teve a ltima
ys_datahora_atualizacao DATAHORA N
alterao.
ENUM ltima operao do registro: INSERT, UPDATE
ys_operacao S
OperacaoBancoDados ou DELETE.
ys_integracao_codigo TEXTO N Cdigo do registro no sistema legado.
Exemplo
{
...,
"ys_cola_id": 2,
"ys_datahora_insercao": "2016-06-22T11:40:33.236",
"ys_datahora_atualizacao": "2016-06-22T11:40:33.236",
"ys_operacao": 1,
"ys_integracao_codigo": "250",
"excluido": 1
}
Retorno Padro para POST, PUT e DELETE

O JSON de retorno contm os seguintes campos
Tabela (String): Nome da tabela alterada.

ChavePrimarias: Lista de Objetos
o AutoIncrementavel (Boolean): Informa se o campo alterado auto incrementvel
o Nome (String): Nome do campo;
o ValorAntigo (Object): Devolve o valor antes da alterao Int ou String
o ValorAtual (Object): Devolve o valor depois da alterao Int ou String
Operacao (Integer): Cdigo da Operao (1 POST / 2 PUT / 3 DELETE)
LinhasAfetadas (Integer): Quantidade de linhas afetadas na operao
Exemplo
{
"Tabela": "tabela",
"ChavesPrimarias": [
{
"AutoIncrementavel": true,
"Nome": "id_tabela",
"ValorAntigo": 75,
"ValorAtual": 75
}
],
"Operacao": 1 ou 2 ou 3,
"LinhasAfetadas": 1
}
Mensagens Padro de sucesso e erro

Mensagens de sucesso
HTTP Status: 200 OK (GET, PUT e DELETE)

HTTP Status: 201 Created (POST)
Mensagens de erro:
HTTP Status: 404 Not Found (GET, POST, PUT e DELETE)

HTTP Status: 400 Bad Request (POST, PUT e DELETE)
HTTP Status: 409 Conflict (POST)
Exemplo
{
"Mensagens": [
{
"Codigo": Nmero do erro em string,
"Key": Nome da chave com problema,
"Value": Descrio do erro,
"Detail": Detalhe do erro
}
],
"Item": {
<Trecho do JSON com problema>
}
}
Enumeradores
ColaboradorStatus
0. Ativo / AT;
1. Inativo / IN.
ColaboradorTipo
0. USURIO / COLABORADOR;
1. VENDEDOR / PREPOSTO;
2. CONTATO.
ContaComissaoPagamento
0. Fatura / fatura;
1. Liquidez / liquidez.
ContaStatus
0. Ativo;
1. Inativo;
2. Prospectado;
3. Potencial;
4. SemCrdito;
5. Fechou.
ContaTipo
0. CLIENTE;
1. INDSTRIA / FORNECEDOR;
2. TRANSPORTADORA.
ContaTipoPessoa
0. Fsica / PF;
1. Jurdica / PJ.
EstadoCivil
0. Solteiro;
1. Casado;
2. Vivo;
3. Divorciado;
4. Amasiado.
OperacaoBancoDados
0. NENHUMA;
1. INSERT;
2. UPDATE;
3. DELETE.
PedidoComissaoStatus
0. Comissionado / CO;
1. NoComissionado / NC.
PedidoMoeda
0. Real;
1. Dolar.
PedidoParcelaStatus
0. Pago;
1. NaoPago.
PedidoParcelaTipoDocumento
0. Boleto;
1. Carn;
2. CartodeCrdito / Carto de Crdito;
3. CartodeDbito / Carto de Dbito;
4. Cheque;
5. DepsitoemContaCorrente / Depsito em Conta Corrente;
6. Dinheiro;
7. Duplicata;
8. DbitoemConta / Dbito em Conta;
9. Fatura;
10. NotaPromissria / Nota Promissria;
11. Outros.
PedidoTipo
0. Pedido;
1. Oramento;
2. Bonificao;
3. Brinde;
4. Devoluo;
5. Troca;
6. Mostrurio;
7. Garantia;
8. Amostra.
PedidoTipoFrete
0. CIF;
1. FOB;
2. CIFSP;
3. REDESPACHO;
4. ARETIRAR.
ProdutoStatus
0. Ativo / AT;
1. Inativo / IN.
Sexo
0. Masculino;
1. Feminino.
Especificao dos Endpoints
Colaborador
Se refere a Usurios, Vendedores e Contatos. Nela h informaes como e-mail e senha dos usurios para acesso
ao sistema e tambm seus dados cadastrais. Contatos da agenda e contatos de clientes tambm so cadastrados nesta
entidade.
URLs
GET https://api.suasvendas.com/api/Colaborador
GET https://api.suasvendas.com/api/Colaborador/id?cola_id=
GET https://api.suasvendas.com/api/Colaborador?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/Colaborador
PUT https://api.suasvendas.com/api/Colaborador
DELETE https://api.suasvendas.com/api/Colaborador
Parmetros GET
cola_id (Inteiro): Chave primria;
dataHoraAtualizacao (Data Hora no formato yyyy-MM-ddThh:mm:ss:sss): Data atualizao
(ys_datahora_atualizacao).
Campos do JSON

cola_id* INTEIRO S ID do registro, chave primria.
ENUM Indica o tipo do colaborador USURIO,
cola_tipo S USURIO
ColaboradorTipo VENDEDOR ou CONTATO.
cola_nome TEXTO S Nome do colaborador.
E-mail principal. Usado para acessar o sistema
no caso de vendedores e usurios. Usado para
cola_email TEXTO N
acessar o portal do cliente no caso de
contatos.
cola_email2 TEXTO N Segundo E-mail.
cola_email3 TEXTO N Terceiro E-mail.
Senha para acesso ao sistema ou portal do
cola_senha TEXTO N
cliente.
ENUM
cola_status S Ativo Status do colaborador: Ativo ou Inativo.
ColaboradorStatus
cola_cargo TEXTO N Cargo na empresa.
Telefone celular. Formatos: 0000-0000, 00000-
cola_celular TELEFONE N 0000, (00) 0000-0000, (00) 00000-0000, 0000
000-0000 ou 000000000000.
Telefone principal. Formatos: 0000-0000,
cola_telefone TELEFONE N 00000-0000, (00) 0000-0000, (00) 00000-0000,
0000 000-0000 ou 000000000000.
Telefone secundrio Formatos: 0000-0000,
cola_telefone2 TELEFONE N 00000-0000, (00) 0000-0000, (00) 00000-0000,
0000 000-0000 ou 000000000000.
cola_data_nascimento DATA N Data de nascimento no formato dd/mm/yyyy.
cola_skype TEXTO N Usurio no skype.
ID do CLIENTE em que o colaborador um
cola_cont_id INTEIRO N contato. Aplicvel somente se
cola_tipo='CONTATO'.
Indica se o contato do departamento de
cola_comprador BOOLEANO N compras do cliente. Aplicvel somente se
cola_tipo='CONTATO'.
cola_obs TEXTO N Observaes sobre o colaborador.
cola_nextel TEXTO N Nmero Nextel do colaborador.
cola_twitter TEXTO N Twitter do colaborador.
cola_cpf TEXTO N CPF do colaborador.
RG - Documento de identidade do
cola_rg TEXTO N
colaborador.
Estado Civil: Solteiro, Casado, Vivo,
cola_estado_civil ENUM EstadoCivil N
Divorciado, Amasiado.
cola_sexo ENUM Sexo N Sexo: Masculino ou Feminino.
Atributos gerais conforme descrito
Exemplo
[
{
"cola_id": 60,
"cola_tipo": 2,
"cola_nome": "Paulo Gonalvez Dias",
"cola_email2": "ilumilux@ilumilux.com.br",
"cola_status": 0,
"cola_celular": "(19) 25199999",
"cola_data_nascimento": "1900-01-01T00:00:00",
"cola_cont_id": 61,
"cola_comprador": true,
"ys_cola_id": 2,
"ys_operacao": 1
}
]
JSON para POST e PUT

Todos os campos descritos no quadro sero utilizados para efetuar o POST e o PUT, porm para os Atributos
Gerais teremos que enviar somente o ys_cola_id. Sendo assim o JSON ficar com a estrutura exemplo abaixo.
{
"cola_id": 1,
"cola_tipo": 2,
"cola_nome": "CLAUDIO POST",
"cola_email2": "",
"cola_senha": "123mudar",
"cola_status": 0,
"cola_celular": "",
"cola_cont_id": 61,
"cola_comprador": true,
"ys_cola_id": 46
}
JSON para DELETE

O JSON de DELETE deve conter somente a(s) Chave(s) Primria(s) da tabela em questo.
cola_id (Integer): Chave primria;
{
"cola_id": 75
}
Vendedor Indstria
Responsvel por informar quais indstrias o vendedor pode atender e qual sua comisso PROPORCIONAL em
cada uma delas. Pode ser informado tambm o limite de desconto, acrscimo de tabela de preos e se o vendedor pode
alterar o preo do produto na emisso do pedido.
URLs
GET https://api.suasvendas.com/api/VendedorIndustria
GET https://api.suasvendas.com/api/VendedorIndustria/id?vein_cola_id=&vein_count_id=
GET https://api.suasvendas.com/api/VendedorIndustria?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/VendedorIndustria
PUT https://api.suasvendas.com/api/VendedorIndustria
DELETE https://api.suasvendas.com/api/VendedorIndustria
Parmetros GET
vein_cola_id (Integer): Chave primria;
vein_count_id (Integer): Chave primria;
Campos do JSON

ID do Vendedor representado pelo atributo
vein_cola_id* INTEIRO S cola_id da entidade COLABORADOR onde
cola_tipo='VENDEDOR'.
ID da Indstria representado pelo atributo

vein_cont_id* INTEIRO S cont_id da entidade CONTA onde
cont_tipo='INDSTRIA'.
Comisso proporcional comisso que a

indstria paga a empresa. Por exemplo, se o
vein_comissao DECIMAL S
vendedor recebe a metade da comisso que a
indstria paga a empresa, informe 50%.
Percentual de acrscimo da tabela preos dos

vein_acrescimo_tabela DECIMAL S 100 produtos da indstria que ser mostrada ao
vendedor.
Indica se o vendedor pode alterar o preo dos

vein_alterar_preco_tabela BOOLEANO S TRUE produtos da indstria no momento da emisso
do pedido.
Limite de desconto em percentual que o

vein_limite_desconto DECIMAL S 100 vendedor pode conceder na emisso de um
pedido para a Indstria.
Exemplo
[
{
"vein_cola_id": 1,
"vein_cont_id": 61,
"vein_comissao": 0,
"vein_acrescimo_tabela": 0,
"vein_alterar_preco_tabela": true,
"vein_limite_desconto": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"vein_cola_id": 3,
"vein_cont_id": 61,
"vein_comissao": 0,
"vein_acrescimo_tabela": 10,
"vein_alterar_preco_tabela": true,
"vein_limite_desconto": 0,
"ys_cola_id": 2
}
JSON para DELETE

vein_cola_id (Integer): Chave primria;

vein_count_id (Inteiro): Chave primria;
{
"vein_cola_id": 3,
"vein_cont_id": 1379
}
Vendedor Regio
Responsvel por informar quais regies o vendedor pode atuar. Uma vez definido ele poder vender somente
para clientes destas regies.
URLs
GET https://api.suasvendas.com/api/VendedorRegiao
GET https://api.suasvendas.com/api/VendedorRegiao/id?vein_cola_id=&vere_regi_id=
GET https://api.suasvendas.com/api/VendedorRegiao?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/VendedorRegiao
PUT https://api.suasvendas.com/api/VendedorRegiao
DELETE https://api.suasvendas.com/api/VendedorRegiao
Parmetros GET
vere_cola_id (Integer): Chave primria;
vere_regi_id (Integer): Chave primria;
Campos do JSON

vere_cola_id* INTEIRO S cola_id da entidade COLABORADOR onde
ID da Regio representado pelo atributo
vere_regi_id* INTEIRO S
regi_id da entidade REGIAO.
Exemplo
[
{
"vere_cola_id": 2,
"vere_regi_id": 1,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"vere_cola_id": 2,
"vere_regi_id": 1,
"ys_cola_id": 2
}
JSON para DELETE

vere_cola_id (Integer): Chave primria;

vere_regi_id (Integer): Chave primria;
{
"vere_cola_id": 2,
"vere_regi_id": 7
}
Conta
Refere-se CLIENTES, INDSTRIAS e TRANSPORTADORAS. Contm os dados cadastrais e algumas configuraes
para emisso de pedidos e preferncias.
URLs
GET https://api.suasvendas.com/api/Conta
GET https://api.suasvendas.com/api/Conta/id?cont_id=
GET https://api.suasvendas.com/api/Conta?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/Conta
PUT https://api.suasvendas.com/api/Conta
DELETE https://api.suasvendas.com/api/Conta
Parmetros GET
cont_id (Inteiro): Chave primria;
Campos do JSON
Valor
Atributo Tipo Obrigatrio Descrio
Padro
cont_id* INTEIRO S ID do registro. Chave primria.
Indica o tipo da conta: CLIENTE, INDSTRIA
cont_tipo ENUM ContaTipo S CLIENTE
ou TRANSPORTADORA.
Tipo de pessoa: PJ para pessoa jurdica ou
cont_pessoa ENUM ContaTipoPessoa S PJ
PF para pessoa fsica.
Nome Fantasia em caso de pessoa jurdica
cont_nome_fantasia TEXTO S (cont_pessoa='PJ') ou nome da pessoa em
caso de Pessoa Fsica (cont_pessoa='PF').
Razo Social em caso de pessoa jurdica
cont_razao_social TEXTO N (cont_pessoa='PJ') ou nome da pessoa em
caso de Pessoa Fsica (cont_pessoa='PF').
cont_endereco TEXTO N Endereo: Logradouro.
cont_numero TEXTO N Endereo: Nmero.
cont_bairro TEXTO N Endereo: Bairro.
cont_complemento TEXTO N Endereo: Complemento.
cont_cep TEXTO N Endereo: CEP.
cont_cidade TEXTO N Endereo: Cidade.
cont_estado ENUM N Endereo: Estado. GO, SP, AC, RJ, ETC.
cont_pais TEXTO N Endereo: Pas.
CNPJ ou CPF da conta. Formatos:
cont_cnpj_cpf TEXTO N
00.000.000/0000-00 ou 000.000.000-00.
cont_inscricao_estadual TEXTO N Inscrio Estadual.
cont_inscricao_municipal TEXTO N Inscrio Municipal.
cont_website TEXTO N Website da conta.
cont_email TEXTO N E-mail da conta.
cont_obs TEXTO N Observaes sobre a conta.
Telefone principal. Formatos: 0000-0000,
cont_telefone TELEFONE N 00000-0000, (00) 0000-0000, (00) 00000-
0000, 0000 000-0000 ou 000000000000.
Telefone secundrio. Formatos: 0000-0000,
cont_telefone2 TELEFONE N 00000-0000, (00) 0000-0000, (00) 00000-
0000, 0000 000-0000 ou 000000000000.
FAX. Formatos: 0000-0000, 00000-0000,
cont_fax TELEFONE N (00) 0000-0000, (00) 00000-0000, 0000 000-
0000 ou 000000000000.
Para CLIENTE: Ativo, Inativo, Prospectado,
Potencial, Sem Crdito, Fechou e Jurdico.
cont_status ENUM ContaStatus S Ativo
Para INDSTRIA ou TRANSPORTADORA:
Ativo e Inativo.
Atributos aplicveis somente a Indstrias (cont_tipo='INDSTRIA')
Comisso que a Indstria paga ao
representante ou empresa que a
cont_comissao DECIMAL N
representa em percentual. Aplicvel
somente quando cont_tipo='INDSTRIA'.
Nmero de casas decimais que a indstria
utiliza nos preos dos seus produtos.
cont_casas_decimais INTEIRO N
Aplicvel somente quando
Indica se a indstria usa cores em seus
cont_usa_cores BOOLEANO S FALSO produtos para emisso de vendas. Aplicvel
somente quando cont_tipo='INDSTRIA'.
Cores padres que a indstria trabalha
separados por ponto-e-vrgula (;). Ex:
AZUL;PRETO;VERDE;AMARELO. No produto
cont_cores TEXTO N poder ser especificada as cores para
aquele produto, os demais usaro esse
campo como referncia. Aplicvel somente
quando cont_tipo='INDSTRIA'.
Indica se a indstria usa grades de tamanho
para emisso de vendas. Geralmente so
cont_usa_grades BOOLEANO S FALSO usadas em indstrias de calados e roupas.
Indica se o pagamento da comisso feito
ENUM na Fatura ou na Liquidez. Valores possveis:
cont_comissao_pagamento N
ContaComissaoPagamento Fatura, Liquidez. Aplicvel somente quando
Atributos aplicveis somente a Clientes (cont_tipo='CLIENTE')
ID da conta Matriz. Somente em contas
FILIAIS dever ser preenchido informando o
cont_cont_i INTEIRO N
ID da conta Matriz. Aplicvel somente
quando cont_tipo='CLIENTE'.
Informaes comerciais sobre o cliente.
cont_info_omercial TEXTO N Aplicvel somente quando
cont_tipo='CLIENTE'.
Endereo completo de cobrana. Aplicvel
cont_endreco_cobranca TEXTO N
somente quando cont_tipo='CLIENTE'.
Endereo completo de entrega. Aplicvel
cont_enereco_entrega TEXTO N
Segmento do Cliente. Aplicvel somente
cont_sgmento TEXTO N
cont_uframa TEXTO N Cdigo SUFRAMA do cliente.
ID da Regio em que o cliente se encontra.
As regies so definidas por meio da
contregi_id INTEIRO N
entidade REGIO. Aplicvel somente
Informaes bancrias do cliente. Campo
con_info_bancaria TEXTO N informativo. Aplicvel somente quando
RG - Documento de identidade. Aplicvel
cont_rg TEXTO N
somente quando cont_pessoa='PF'.
Estado Civil: Solteiro, Casado, Vivo,
cont_estado_civil ENUM EstadoCivil N Divorciado, Amaziado. Aplicvel somente
quando cont_pessoa='PF'.
Sexo: Masculino ou Feminino. Aplicvel
cont_sexo ENUM Sexo N
somente quando cont_pessoa='PF'.
E-mail para recebimento da NF-e. Aplicvel
cont_email_nfe TEXTO N
Nmero de dias em que o cliente deve ficar
sem comprar para ser inativado
cont_dias_desativacao INTEIRO N
automaticamente pelo sistema. Aplicvel
Cdigo do Cliente, usado para informar o
cdigo do cliente dentro da empresa.
cont_codigo_cliente TEXTO N
cont_marca TEXTO N Marca usada nos produtos para esse cliente.
Exemplo
[
{
"cont_id": 2,
"cont_tipo": 0,
"cont_pessoa": 1,
"cont_nome_fantasia": "CLIENTE 3",
"cont_razao_social": "CLIENTE 3",
"cont_endereco": "",
"cont_bairro": "",
"cont_cep": "_____-___",
"cont_cidade": "CAMPINAS",
"cont_estado": "SP",
"cont_cnpj_cpf": "__.___.___/____-__",
"cont_inscricao_estadual": "",
"cont_website": "",
"cont_email": "",
"cont_obs": "",
"cont_telefone": "(11) 5458-7458",
"cont_fax": "(__) ____-____",
"cont_status": 1,
"cont_comissao": 0,
"cont_casas_decimais": 2,
"cont_usa_cores": false,
"cont_usa_grades": false,
"cont_info_comercial": "",
"cont_endereco_cobranca": "",
"cont_endereco_entrega": "",
"cont_dias_desativado": 0,
"ClienteIndustriaDesconto": [
{
"clid_clie_id": 2,
"clid_forn_id": 1414,
"clid_tapr_id": 0,
"clid_desconto_padrao": 20,
"ys_cola_id": 2
}
],
"ClienteVendedor": [
{
"clve_cont_id": 2,
"clve_cola_id": 2,
"ys_cola_id": 2
}
],
"ys_cola_id": 2,
"ys_operacao": 1
}
]
{
"cont_id": 2,
"cont_tipo": 0,
"cont_pessoa": 1,
"cont_nome_fantasia": "CLIENTE 3",
"cont_razao_social": "CLIENTE 3",
"cont_endereco": "",
"cont_bairro": "",
"cont_cep": "_____-___",
"cont_cidade": "CAMPINAS",
"cont_estado": "SP",
"cont_cnpj_cpf": "__.___.___/____-__",
"cont_inscricao_estadual": "",
"cont_website": "",
"cont_email": "",
"cont_obs": "",
"cont_telefone": "(11) 5458-7458",
"cont_fax": "(__) ____-____",
"cont_status": 1,
"cont_comissao": 0,
"cont_casas_decimais": 2,
"cont_usa_cores": false,
"cont_usa_grades": false,
"cont_info_comercial": "",
"cont_endereco_cobranca": "",
"cont_endereco_entrega": "",
"cont_dias_desativado": 0,
"ClienteIndustriaDesconto": [
{
"clid_clie_id": 2,
"clid_forn_id": 1414,
"clid_tapr_id": 0,
"ys_cola_id": 2
}
],
"ClienteVendedor": [
{
"clve_cont_id": 2,
"clve_cola_id": 2,
"ys_cola_id": 2
}
],
"ys_cola_id": 2
}
JSON para DELETE

cont_id (Integer): Chave primria;
{
"cont_id": 77
}
Cliente Indstria Desconto
Armazena qual o desconto ou acrscimo padro (pode ser alterado na emisso do pedido) que o cliente ter em
cada indstria ou em cada tabela de preo. Esse mesmo relacionamento define quais indstrias e tabelas de preo o
cliente poder ter acesso no Portal do Cliente.
URLs
GET https://api.suasvendas.com/api/ClienteIndustriaDesconto
GET https://api.suasvendas.com/api/ClienteIndustriaDesconto/id?clid_clie_id=&clid_forn_id=
GET https://api.suasvendas.com/api/ClienteIndustriaDesconto?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ClienteIndustriaDesconto
PUT https://api.suasvendas.com/api/ClienteIndustriaDesconto
DELETE https://api.suasvendas.com/api/ClienteIndustriaDesconto
Parmetros GET
clid_clie_id (Inteiro): Chave primria;
clid_forn_id (Inteiro): Chave primria;
Campos do JSON

ID do Cliente representado pelo atributo
clid_clie_id* INTEIRO S cont_id da entidade CONTA onde

clid_forn_id* INTEIRO S cont_id da entidade CONTA onde
ID da tabela de preo representada pela

clid_tapr_id INTEIRO N
entidade TABELA_PRECO.
Desconto (Ex. 10) ou Acrscimo (Ex. -10) em

clid_desconto_padrao DECIMAL S percentual do valor dos produtos da indstria
e tabela de preos (se indicada).
Exemplo
[
{
"clid_clie_id": 61,
"clid_forn_id": 61,
"clid_tapr_id": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"clid_clie_id": 61,
"clid_forn_id": 61,
"clid_tapr_id": 0,
"ys_cola_id": 2
}
JSON para DELETE

clid_clie_id (Integer): Chave primria;

clid_forn_id (Integer): Chave primria.
{
"clid_clie_id": 62,
"clid_forn_id": 62
}
Cliente Vendedor
Responsvel por informar quais vendedores podem atender o cliente.
URLs
GET https://api.suasvendas.com/api/ClienteVendedor
GET https://api.suasvendas.com/api/ClienteVendedor/id?clve_cont_id=&clve_cola_id=
GET https://api.suasvendas.com/api/ClienteVendedor?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ClienteVendedor
PUT https://api.suasvendas.com/api/ClienteVendedor
DELETE https://api.suasvendas.com/api/ClienteVendedor
Parmetros GET
clve_cont_id (Inteiro): Chave primria;
clve_cola_id (Inteiro): Chave primria;
Campos do JSON

clve_cont_id* INTEIRO S cont_id da entidade CONTA onde
clve_cola_id* INTEIRO S cola_id da entidade COLABORADOR onde
Exemplo
[
{
"clve_cont_id": 61,
"clve_cola_id": 2,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"clve_cont_id": 62,
"clve_cola_id": 2,
"ys_cola_id": 2
}
JSON para DELETE

clve_cont_id (Inteiro): Chave primria;

clve_cola_id (Inteiro): Chave primria;
{
"clve_cont_id": 62,
"clve_cola_id": 2,
"ys_cola_id": 2
}
Cliente Transportadora
Armazena quais transportadoras podem ser usadas pelo cliente.
URLs
GET https://api.suasvendas.com/api/ClienteTransportadora
GET https://api.suasvendas.com/api/ClienteTransportadora/id?cltr_clie_id=&cltr_tran_id=
GET https://api.suasvendas.com/api/ClienteTransportadora?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ClienteTransportadora
PUT https://api.suasvendas.com/api/ClienteTransportadora
DELETE https://api.suasvendas.com/api/ClienteTransportadora
Parmetros GET
cltr_clie_id (Inteiro): Chave primria;
cltr_tran_id (Inteiro): Chave primria;
Campos do JSON

cltr_clie_id* INTEIRO S cont_id da entidade CONTA onde
ID da Transportadora representado pelo
cltr_tran_id* INTEIRO S atributo cont_id da entidade CONTA onde
cont_tipo=TRANSPORTADORA.
Exemplo
[Corrigir Posio
{
"cltr_clie_id": 61,
"cltr_tran_id": 61,
"ys_cola_id": 0,
"ys_operacao": 1
}
]

{
"cltr_clie_id": 1396,
"cltr_tran_id": 141,
"ys_cola_id": 2
}
JSON para DELETE

cltr_clie_id (Inteiro): Chave primria;

cltr_tran_id (Inteiro): Chave primria;
{
"cltr_clie_id": 61,
"cltr_tran_id": 61,
"ys_cola_id": 2
}
Indstria Grade
Referente s grades de tamanho que as indstrias trabalham. Exemplo: P, M, G ou 30, 31, 32, 33, 34, 35.
Geralmente so usadas por indstrias de roupas e calados.
URLs
GET https://api.suasvendas.com/api/IndustriaGrade
GET https://api.suasvendas.com/api/IndustriaGrade/id?ingr_id=
GET https://api.suasvendas.com/api/IndustriaGrade?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/IndustriaGrade
PUT https://api.suasvendas.com/api/IndustriaGrade
DELETE https://api.suasvendas.com/api/IndustriaGrade
Parmetros GET
Ingr_id (Inteiro): Chave primria;
Campos do JSON

ingr_id* INTEIRO S ID do registro, chave primria.
Nome da Grade. Exemplo: INFANTIL, ADULTO,
ingr_grade TEXTO S 33 ao 40
ingr_opcao TEXTO S Opo da grade. Exemplo: 33, P, M, GG
cont_id da entidade CONTA onde
ingr_cont_id INTEIRO S cont_tipo='INDUSTRIA'.
Exemplo
[
{
"ingr_id": 3,
"ingr_grade": "ELEGANCE POST",
"ingr_opcao": "PLT POST",
"ingr_cont_id": 61,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"ingr_id": 75,
"ingr_grade": "ELEGANCE POST",
"ingr_opcao": "PLT POST",
"ingr_cont_id": 62,
"ys_cola_id": 2
}
JSON para DELETE

ingr_id (Inteiro): Chave primria;
{
"ingr_id": 7
}
Produto
Produtos do sistema e seus atributos. Os produtos devem ser relacionados com uma indstria, o relacionamento
com uma tabela de preos opcional.
URLs
GET https://api.suasvendas.com/api/Produto
GET https://api.suasvendas.com/api/Produto/id?prod_id=
GET https://api.suasvendas.com/api/Produto?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/Produto
PUT https://api.suasvendas.com/api/Produto
DELETE https://api.suasvendas.com/api/Produto
Parmetros GET
prod_id (Inteiro): Chave primria;
Campos do JSON

prod_id* INTEIRO S ID do registro, chave primria.
ID da Indstria que o produto pertence.
prod_cont_id INTEIRO S
Indstria representada pela entidade CONTA.
ID da Linha que o produto pertence. Linha
prod_linh_id INTEIRO N
representada pela entidade LINHA.
prod_codigo TEXTO S Cdigo do produto.
prod_nome TEXTO S Nome do produto.
prod_preco DECIMAL S Preo de venda do produto.
Quantidade de produtos que vem em uma
prod_embalagem TEXTO N
embalagem.
Unidade de medida do produto. Exemplo: UN,
prod_unidade_medida TEXTO N
KG, PCT, CX, FARDO.
prod_obs TEXTO Observaes gerais do produto.
ENUM
prod_status S Ativo
ProdutoStatus Status do produto: Ativo ou Inativo.
prod_ipi DECIMAL N IPI do produto em percentual.
Comisso que o vendedor receber pela venda
do produto. Se preenchido substitui a comisso
prod_comissao DECIMAL N
da indstria definido pelo atributo
cont_comissao da entidade CONTA.
prod_codigo_barras TEXTO N Cdigo de Barras (GTIN) do produto.
ID da categoria do produto representada pela
prod_prca_id INTEIRO N
entidade PRODUTO_CATEGORIA.
ID da Tabela de Preo em que o produto se
encontra. O uso de tabelas de preo no
SuasVendas no obrigatrio. Quando usada
mais de uma tabela de preo, o produto
duplicado no banco mantendo o mesmo
cdigo (prod_codigo) e o mesmo ID da
prod_tapr_id INTEIRO N
Indstria (prod_cont_id). Essa duplicao
ocorre pois alguns clientes necessitam alterar
no s o preo do produto mas tambm a
descrio, fotos, detalhes, comisso,
promoo, etc. Tabelas de Preo so
representadas pela entidade TABELA_PRECO.
Nome da grade de tamanho Padro utilizada
por esse produto. As grades de tamanho no
prod_ingr_grade TEXTO N
sistema so representadas pela entidade
INDUSTRIA_GRADE.
Estoque mnimo desse produto. O sistema gera
alertas de estoque baixo e relatrios de
prod_estoque_minimo INTEIRO N
produtos com estoque baixo atravs desse
campo.
Cores que esse produto possui separados por
ponto-e-vrgula (;). Se preenchido substitui o
prod_cores TEXTO N
atributo cont_cores da entidade CONTA. Ex:
AZUL;PRETO;VERDE;AMARELO.
prod_ncm TEXTO N Cdigo NCM do produto.
IPI do produto quando cobrado em reais e no
prod_ipi_reais DECIMAL N percentual. Se preenchido o atributo prod_ipi
ser ignorado.
prod_peso_bruto DECIMAL N Peso Bruto do produto em KG.
prod_peso_liquido DECIMAL N Peso Lquido do produto em KG.
Preo do produto quando ele se encontra em
prod_preco_promocao DECIMAL N
promoo.
Cdigo original do produto. Pode ser usado
prod_codigo_original TEXTO N
como um segundo cdigo do produto.
prod_altura DECIMAL N Altura do produto.
prod_largura DECIMAL N Largura do produto.
prod_comprimento DECIMAL N Comprimento do produto.
prod_marca TEXTO N Marca do produto.
prod_detalhes TEXTO N Detalhes do produto.
prod_especificacao TEXTO N Especificaes do produto.
prod_modelo TEXTO N Modelo do produto.
prod_codigo_industria TEXTO N Cdigo do produto na indstria.
prod_estoque DECIMAL N Estoque atual do produto. Campo informativo.
Coleo de produtos que este produto
prod_colecao TEXTO N pertence. Campo informativo para filtros e
buscas.
ProdutoST ProdutoST N Lista de Produto ST
ProdutoFoto ProdutoFoto N Lista de Produto Foto
Exemplo
[
{
"prod_id": 9120,
"prod_cont_id": 60,
"prod_codigo": "PS1LPC",
"prod_nome": "Plafon Sipri 1 Luz com Pingentes Cristal",
"prod_preco": 138.6,
"prod_embalagem": "1",
"prod_unidade_medida": "CX",
"prod_obs": "Tipo de Lmpada: Fluorescente - Incandescente - LED\r\r\nQuantidade
de Lmpadas: 1\r\r\nSoquete das Lmpadas: E27\r\r\nVoltagem: BIVOLT\r\r\nPotncia Mx.
de cada Lmpada (Watts): 60",
"prod_status": 0,
"prod_ipi": 15,
"prod_tapr_id": 1,
"prod_estoque_minimo": 50,
"prod_cores": "Branco\r\r\nPreto",
"prod_ncm": "94051099",
"prod_peso_liquido": 0,
"prod_peso_bruto": 0,
"prod_preco_promocao": 126.67,
"prod_altura": 0.31,
"prod_largura": 0.22,
"prod_comprimento": 0,
"prod_marca": "Cobrearte",
"prod_modelo": "Plafon",
"ProdutoST": [
{ ... }
],
"ProdutoFoto": [
{ ... }
],
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"prod_id": 21871,
"prod_cont_id": 1306,
"prod_codigo": "BASE DIR S",
"prod_nome": "POSTMAN UPDATE",
"prod_preco": 26,
"prod_embalagem": "1",
"prod_unidade_medida": "P",
"prod_status": 0,
"prod_ipi": 0,
"prod_comissao": 5,
"prod_estoque_minimo": 0,
"prod_peso_bruto": 0,
"prod_estoque": 0,
"ys_cola_id": 46
}
JSON para DELETE
prod_id (Inteiro): Chave primria;
{
"prod_id": 21871
}
Produto ST
Informaes sobre Substituio Tributria dos produtos.
URLs
GET https://api.suasvendas.com/api/ProdutoST
GET https://api.suasvendas.com/api/ProdutoST/id?prst_prod_id=&prst_estado=
GET https://api.suasvendas.com/api/ProdutoST?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ProdutoST
PUT https://api.suasvendas.com/api/ProdutoST
DELETE https://api.suasvendas.com/api/ProdutoST
Parmetros GET
prst_prod_id (Inteiro): Chave primria;
prst_estado (Texto): Chave primria;
Campos do JSON

ID do produto representado pela entidade
prst_prod_id* INTEIRO S
PRODUTO. Chave primria.
Estado, em dois caracteres (GO, SP, RJ, ETC),
prst_estado* TEXTO S para onde o produto ser vendido, ou seja,
estado do cliente. Chave Primria.
Percentual do ST que ser aplicado ao valor do
produto. Esse valor calculado
prst_st DECIMAL S
automaticamente pelo SuasVendas sendo
ento um atributo somente leitura.
Alquota do ICMS em percentual para operao
prst_icms_interestadual DECIMAL N
interestadual.
Percentual da Margem de Valor Agregado
prst_mva DECIMAL N
(MVA) do produto.
Alquota do ICMS em percentual para operao
prst_icms_intraestadual DECIMAL N
interna.
Exemplo
[
{
"prst_prod_id": 1,
"prst_estado": "MT",
"prst_st": 9,
"prst_icms_interestadual": 0,
"prst_mva": 0,
"prst_icms_intraestadual": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"prst_prod_id": 1,
"prst_estado": "MT",
"prst_st": 9,
"prst_icms_interestadual": 0,
"prst_mva": 0,
"prst_icms_intraestadual": 0,
"ys_cola_id": 2
}
JSON para DELETE

prst_prod_id (Inteiro): Chave primria;

prst_estado (Texto): Chave primria;
{
"prst_prod_id": 21871,
"prst_estado": "MT01"
}
Produto Foto
Armazena informaes sobre as fotos dos produtos. As fotos no SuasVendas so armazenadas na nuvem usando
o servio Microsoft Azure.
URLs
GET https://api.suasvendas.com/api/ProdutoFoto
GET https://api.suasvendas.com/api/ProdutoFoto/id?prfo_id=
GET https://api.suasvendas.com/api/ProdutoFoto?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ProdutoFoto
PUT https://api.suasvendas.com/api/ProdutoFoto
DELETE https://api.suasvendas.com/api/ProdutoFoto
Parmetros GET
prfo_id (Inteiro): Chave primria;
Campos do JSON

prfo_id* INTEIRO S ID do registro, chave primria.
prfo_nome_arquivo TEXTO S Nome do arquivo com extenso no Azure.
ID do produto do qual a foto pertence.
prfo_prod_id INTEIRO S Produto representado pela entidade
PRODUTO.
prfo_tamanho INTEIRO S Tamanho em bytes do arquivo.
URL do arquivo em tamanho normal. Altura
prfo_url TEXTO S
mxima: 600px, Largura mxima: 800px;
URL do arquivo em tamanho reduzido. Altura
prfo_url_thumb TEXTO S
mxima: 200px, Largura mxima: 200px;
Array de Bytes da foto para envio aos nossos
servidores. Este atributo usado somente para
prfo_bytes BINRIO N
enviar ou atualizar fotos, em caso de consulta
retornar como NULO.
Exemplo
[
{
"prfo_id": 2,
"prfo_nome_arquivo": "5e76ba19-34a4-4c30-b2a9-b4a704cc5410.jpg",
"prfo_prod_id": 9111,
"prfo_tamanho": 59343,
"prfo_url": "https://suasvendasimg.blob.core.windows.net/produto/28607/5e76ba19-
34a4-4c30-b2a9-b4a704cc5410.jpg",
"prfo_url_thumb":
"https://suasvendasimg.blob.core.windows.net/produto/28607/thumb/5e76ba19-34a4-4c30-
b2a9-b4a704cc5410.jpg",
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"prfo_id": 1,
"prfo_nome_arquivo": "1c02db94-7647-46e1-aeab-9c7eabd9c908.jpg",
"prfo_prod_id": 1,
"prfo_tamanho": 9120,
"prfo_bytes":
"iVBORw0KGgoAAAANSUhEUgAAA8YAAAAnCAIAAABCA8YsAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAA
AJcEhZcwAADsMAAA7DAcdvqGQAABOSSURBVHhe7Z09riXH0URpyqSpBXATMsUlcBvahcDtaCt0CMjRImjKHBWRQ
jAY+SAAAAAASUVORK5CYII=",
"ys_cola_id": 2
}
JSON para DELETE
prfo_id (Inteiro): Chave primria;
{
"prfo_id": 3
}
Produto Categoria
As categorias de produto so criadas para organizar os produtos no Catlogo Online e no SuasVendas Mvel.
Exemplo de categorias: Calados, Camisetas, Bermudas.
URLs
GET https://api.suasvendas.com/api/ProdutoCategoria
GET https://api.suasvendas.com/api/ProdutoCategoria/id?prca_id=
GET https://api.suasvendas.com/api/ProdutoCategoria?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/ProdutoCategoria
PUT https://api.suasvendas.com/api/ProdutoCategoria
DELETE https://api.suasvendas.com/api/ProdutoCategoria
Parmetros GET
prca_id (Inteiro): Chave primria;
Campos do JSON

prca_id* INTEIRO S ID do registro, chave primria.
prca_nome TEXTO S Nome da categoria.
prca_obs TEXTO N Observaes da categoria.
ID da categoria pai, representada pela
prca_prca_id INTEIRO N
entidade PRODUTO_CATEGORIA.
Exemplo
[
{
"prca_id": 2,
"prca_nome": "CAT2",
"prca_obs": "OBS",
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"prca_nome": "CAT2",
"prca_obs": "OBS",
"ys_cola_id": 2
}
JSON para DELETE

prca_id (Inteiro): Chave primria;
{
"prca_id": 1
}
Tabela de Preo
Tabelas de preo so geralmente criadas para organizar produtos com preos diferenciados. Alm do preo,
pode-se mudar tambm a descrio, foto e outros atributos dos produtos. Um bom exemplo so tabelas para Varejo e
Atacado onde o preo para atacado menor que para varejo.
URLs
GET https://api.suasvendas.com/api/TabelaPreco
GET https://api.suasvendas.com/api/TabelaPreco/id?tapr_id=
GET https://api.suasvendas.com/api/TabelaPreco?DataHoraAtualizacao=
POST https://api.suasvendas.com/api/TabelaPreco
PUT https://api.suasvendas.com/api/TabelaPreco
DELETE https://api.suasvendas.com/api/TabelaPreco
Parmetros GET
tapr_id (Inteiro): Chave primria;
Campos do JSON
tapr_id* INTEIRO S ID do registro, chave primria.
ID da Indstria da qual a tabela pertence. A
tapr_cont_id INTEIRO S indstria representada pela entidade
CONTA.
Nome da tabela de preos. Ex.: Varejo,
tapr_nome TEXTO S
Atacado.
Exemplo
[Corrigir Posio
{
"tapr_id": 1,
"tapr_cont_id": 60,
"tapr_nome": "Atacado",
"ys_operacao": 1
}
]

{
"tapr_id": 496,
"tapr_cont_id": 1443,
"tapr_nome": "ROBUST POST API",
"ys_cola_id": 2
}
JSON para DELETE

tapr_id (Inteiro): Chave primria;
{
"tapr_id": 496
}
Regio
Regies de atuao dos vendedores e onde os clientes se encontram. Possibilita que um vendedor possa atuar
somente com clientes de determinada regio usando a entidade associativa VENDEDOR_REGIAO.
URLs
GET https://api.suasvendas.com/api/Regiao
GET https://api.suasvendas.com/api/Regiao/id?regi_id=
GET https://api.suasvendas.com/api/Regiao?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/Regiao
PUT https://api.suasvendas.com/api/Regiao
DELETE https://api.suasvendas.com/api/Regiao
Parmetros GET
regi_id (Inteiro): Chave primria;
Campos do JSON

regi_id* INTEIRO S ID do registro, chave primria.
ID da regio pai, regio superior a essa. No
regi_regi_id INTEIRO N
caso de ser uma regio raiz o valor NULO.
regi_codigo TEXTO S Cdigo da regio definido pela empresa.
regi_nome TEXTO S Nome da regio definido pela empresa.
Exemplo
[
{
"regi_id": 2,
"regi_codigo": "R1",
"regi_nome": "REGIO 01",
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"regi_id": 7,
"regi_codigo": "R1",
"regi_nome": "REGIO 123",
"ys_cola_id": 46
}
JSON para DELETE

regi_id (Inteiro): Chave primria;
{
"regi_id": 7
}
Pedido Status
Armazena Status de Pedido personalizados pelo cliente. Alguns status so disponveis por padro, porm o cliente
pode cadastrar novos Status. Os padres so: 1 Em Aberto, 2 Em Andamento, 3 Atendido. Com Status possvel
gerar relatrios customizados e organizar melhor o andamento da venda.
URLs
GET https://api.suasvendas.com/api/PedidoStatus
GET https://api.suasvendas.com/api/PedidoStatus/id?pest_id=
GET https://api.suasvendas.com/api/PedidoStatus?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/PedidoStatus
PUT https://api.suasvendas.com/api/PedidoStatus
DELETE https://api.suasvendas.com/api/PedidoStatus
Parmetros GET
pest_id (Inteiro): Chave primria;
Campos do JSON

pest_id* INTEIRO S ID do registro, chave primria.
pest_nome TEXTO S Nome ou descrio do Status do Pedido.
Exemplo
[
{
"pest_id": 1,
"pest_nome": "1 - Em Aberto",
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"pest_nome": "API POST",
"ys_cola_id": 2
}
JSON para DELETE

pest_id (Inteiro): Chave primria;
{
"pest_id": 7
}
Pedido
Os pedidos de venda contm vrios atributos que o definem. Eles podem ser gerados com produtos de uma nica
indstria ou vrias indstrias.
URLs
GET https://api.suasvendas.com/api/Pedido
GET https://api.suasvendas.com/api/Pedido/id?pedi_id=
GET https://api.suasvendas.com/api/Pedido?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/Pedido
PUT https://api.suasvendas.com/api/Pedido
DELETE https://api.suasvendas.com/api/Pedido
Parmetros GET
pedi_id (Inteiro): Chave primria;
Campos do JSON
Valor
Padro
pedi_id* INTEIRO S ID do registro, chave primria.

pedi_clie_id INTEIRO S cont_id da entidade CONTA onde
ID do Contato Comprador representado pelo

atributo cola_id da entidade COLABORADOR
pedi_cola_id INTEIRO N
onde cola_tipo='CONTATO' e
cola_comprador='VERDADEIRO'.
ID da Transportadora representado pelo

pedi_tran_id INTEIRO N atributo cont_id da entidade CONTA onde
cont_tipo='TRANSPORTADORA'.
Condio de pagamento na forma de texto.

pedi_condicao_pagamento TEXTO N
Exemplo: vista, 30/60/90.
Comisso paga a empresa ou escritrio de

representao por este pedido. Por padro
pedi_comissao DECIMAL S traz a comisso da Indstria (cont_comissao)
informado na entidade CONTA onde
cont_tipo='INDUSTRIA'.
Indica se o pedido foi enviado por e-mail ao

pedi_status_envio_email BOOLEANO S FALSO
cliente ou no.
Observaes gerais do pedido. Essas so

pedi_obs TEXTO N mostradas ao cliente no pedido quando
enviado por e-mail ou impresso.
pedi_data_emissao DATA S Data da emisso do pedido.
Status do comissionamento do pedido. Se

comissionado integralmente, ou seja, todas
ENUM No as parcelas de comisso foram pagas ao
pedi_status_comissionamento S
PedidoComissaoStatus Comissionado vendedor ou escritrio de representao o
valor ser 'Comissionado'. Se no, 'No
Comissionado'.
pedi_data_fatura DATA N Data em que o pedido foi faturado.
Comisso PROPORCIONAL paga ao vendedor
por este pedido. Por padro traz o valor
informado no relacionamento
pedi_comissao_vendedor DECIMAL S 100 VENDEDOR_INDUSTRIA. Por exemplo, se o
vendedor recebe a metade da comisso que a
indstria paga a empresa ou escritrio de
representao, informe 50%.
Nmero da Nota Fiscal referente ao pedido

pedi_nota_fiscal TEXTO N somente nos casos em que o pedido gerar
apenas uma nota.
pedi_endereco_cobranca TEXTO N Endereo completo de cobrana.
Endereo completo de entrega da

pedi_endereco_entrega TEXTO N
mercadoria.
pedi_acrescimo DECIMAL S 0 Acrscimo no valor total do pedido.
pedi_desconto DECIMAL S 0 Desconto no valor total do pedido.
ENUM Tipo do frete. Os valores podem ser: CIF, FOB,

pedi_tipo_frete N
PedidoTipoFrete CIF/SP, REDESPACHO ou A RETIRAR.
pedi_previsao_entrega DATA N Data da previso de entrega da mercadoria.
Nmero do pedido no sistema da Indstria.

pedi_numero_industria TEXTO N No caso de integrao esse valor ser igual ao
informado no sistema legado.
Nmero do pedido no talo de papel caso

pedi_numero_talao TEXTO N
ainda sejam utilizados.
ID do Status do Pedido representado pelo

pedi_pest_id INTEIRO S atributo 'pest_id' da entidade
PEDIDO_STATUS.
Cotao do dlar para esse pedido. O valor

afetar o total do pedido, sendo multiplicado
pedi_cotacao_dolar DECIMAL S 1
pelo mesmo. Sempre que no utilizado o
valor deve ser 1.
pedi_valor_frete DECIMAL N Valor do frete para o pedido.
Desconto encadeado aplicado ao pedido.

Campo informativo. Exemplo: 10,00#5,50.
pedi_desconto_encadeado TEXTO N
Nesse caso foram aplicados 10% + 5,5% de
desconto.
Informa se o pedido est bloqueado para

pedi_bloqueado BOOLEANO S FALSE
edio ou alteraes.
ID do usurio que digitou o pedido. Nem

sempre o vendedor digita o pedido, ele pode
pedi_cola_id_digitou INTEIRO S
repassar para uma secretria ou qualquer
usurio do sistema.
Observaes gerais do pedido. Essas so NO
pedi_obs_privada TEXTO N
sero mostradas ao cliente.
Informa o tipo do pedido. Esse atributo afeta

os relatrios e financeiro do SuasVendas.
Alguns tipos no so contabilizados. Os
pedi_tipo ENUM PedidoTipo S Pedido
valores aceitos so: Pedido, Oramento,
Bonificao, Brinde, Devoluo, Troca,
Mostrurio, Garantia e Amostra.
pedi_marca TEXTO N Marca usada nos produtos para esse pedido.
Exemplo
[
{
"pedi_id": 3,
"pedi_clie_id": 64,
"pedi_cola_id": 63,
"pedi_condicao_pagamento": "",
"pedi_comissao": 100,
"pedi_comissao_padrao": 100,
"pedi_status_envio_email": false,
"pedi_obs": "Oramento para o cliente referente ligao.",
"pedi_data_emissao": "2016-06-19T00:00:00",
"pedi_status_comissionamento": 1,
"pedi_data_fatura": "2016-06-20T00:00:00",
"pedi_acrescimo": 0,
"pedi_desconto": 0,
"pedi_pest_id": 2,
"pedi_cotacao_dolar": 1,
"pedi_valor_frete": 424.63,
"pedi_desconto_encadeado": "0#0#0#0#0#0#0#",
"pedi_bloqueado": false,
"pedi_cola_id_digitou": 2,
"pedi_tipo": 1,
"PedidoItem": [
{...}
],
"PedidoComissao": [
{...}
],
"PedidoParcela": [
{...}
],
"ys_cola_id": 2,
"ys_operacao": 1
}
]
{
"pedi_id": 14510,
"pedi_clie_id": 61,
"pedi_cola_id": 1,
"pedi_tran_id": 61,
"pedi_condicao_pagamento": " Vista",
"pedi_comissao": 5,
"pedi_comissao_padrao": 5,
"pedi_status_envio_email": true,
"pedi_obs": "\"CONFIRA E CONFIRME OS DADOS DE SEU PEDIDO POR E-MAIL\" \r\nSOMENTE
ASSIM ELE SER ENVIADO PARA A INDUSTRIA.\r\n\r\nAPLICADO DESC EXTRA DE 3%
\r\nTRANSPORTADORA VAI COLETAR NA INDSTRIA",
"pedi_data_emissao": "2016-02-03T00:00:00",
"pedi_status_comissionamento": 1,
"pedi_data_fatura": "2016-02-03T00:00:00",
"pedi_endereco_cobranca": "",
"pedi_endereco_entrega": "",
"pedi_acrescimo": 0,
"pedi_desconto": 0,
"pedi_tipo_frete": 1,
"pedi_cotacao_dolar": 1,
"pedi_valor_frete": 0,
"pedi_desconto_encadeado": "5,00#58,00#3,00#3,00#0,00#0,00#0,00#",
"pedi_bloqueado": false,
"pedi_cola_id_digitou": 2383,
"pedi_tipo": 1,
"PedidoItem": [
{
...
}
],
"PedidoComissao": [
{
...
}
],
"ys_cola_id": 2
}
JSON para DELETE

pedi_id (Inteiro): Chave primria;
{
"pedi_id": 359
}
Pedido Item
Itens do pedido.
URLs
GET https://api.suasvendas.com/api/PedidoItem
GET https://api.suasvendas.com/api/PedidoItem/id?peit_id=
GET https://api.suasvendas.com/api/PedidoItem?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/PedidoItem
PUT https://api.suasvendas.com/api/PedidoItem
DELETE https://api.suasvendas.com/api/PedidoItem
Parmetros GET
peit_id (Inteiro): Chave primria;
Campos do JSON

peit_id* INTEIRO S ID do registro, chave primria.
ID do Pedido representado pelo atributo
peit_pedi_id INTEIRO S
pedi_id da entidade PEDIDO.
ID do Produto representado pelo atributo
peit_prod_id INTEIRO S
prod_id da entidade PRODUTO.
peit_preco DECIMAL S Preo unitrio de venda do produto.
peit_qtde DECIMAL S Quantidade de venda.
peit_obs TEXTO N Observaes sobre o item no pedido.
Valor IPI em percentual do item no pedido.
peit_ipi DECIMAL N
Busca no cadastro do produto.
Cor do produto nesse item do pedido. As cores
so informadas no cadastro da Indstria
peit_cor TEXTO N
atravs do atributo cont_cores ou no produto
atravs do atributo prod_cores.
Comisso paga por esse item do pedido. No
peit_comissao DECIMAL N SuasVendas possvel ter uma comisso
diferenciada por item do pedido.
Percentual do ST que ser aplicado ao valor do
produto. Por padro o sistema obtm essa
peit_st DECIMAL N informao da entidade PRODUTO_ST quando
selecionado o cliente do pedido. Pode ser
alterado item a item.
Preo real do produto (sem descontos
peit_preco_real DECIMAL S
aplicados).
Quantidade de produtos faturados nesse item
peit_qtde_faturada DECIMAL N do pedido. Usado para faturamento parcial de
pedido.
Quantidade de produtos na embalagem. Traz
peit_embalagem TEXTO N
automaticamente do cadastro do produto.
peit_peso_bruto DECIMAL N Peso bruto unitrio do produto.
Desconto encadeado aplicado a este item do
peit_desconto TEXT N
pedido.
Valor IPI em reais do item no pedido. Quando
peit_ipi_reais DECIMAL N
utilizado o atributo peit_ipi ignorado.
peit_peso_liquido DECIMAL N Peso lquido unitrio do produto.
peit_altura DECIMAL N Altura do produto.
peit_largura DECIMAL N Largura do produto.
peit_comprimento DECIMAL N Comprimento do produto.
Moeda utilizada para comercializar esse
peit_moeda ENUM S R$ item/produto. Atualmente temos as opes:
R$ e US$.
Data em que este item foi faturado. Usado no
peit_data_fatura DATA N
faturamento parcial de pedido.
Nmero da Nota Fiscal referente aos itens
peit_nota_fiscal TEXTO N faturados. Usado no faturamento parcial de
pedido.
Cotao da moeda utilizada para comercializar
peit_cotacao DECIMAL S 1 esse produto. Sempre que utilizado R$ como
moeda o valor ser 1.
Exemplo
[Corrigir Posio
{
"peit_id": 239,
"peit_pedi_id": 2,
"peit_prod_id": 9116,
"peit_preco": 155.9,
"peit_qtde": 50,
"peit_ipi": 13,
"peit_cor": "BRANCO",
"peit_st": 0,
"peit_preco_real": 155.9,
"peit_qtde_faturada": 0,
"peit_embalagem": "1 CX",
"peit_peso_bruto": 0,
"peit_desconto": "0+0+0+0+0+0+0",
"peit_peso_liquido": 0,
"peit_altura": 0.08,
"peit_largura": 0.22,
"peit_comprimento": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"peit_id": 90606,
"peit_pedi_id": 3,
"peit_prod_id": 9120,
"peit_preco": 157.82,
"peit_qtde": 4,
"peit_ipi": 5,
"peit_cor": "POST T05- FACTO*DUNAS PRETO",
"peit_comissao": 5,
"peit_st": 0,
"peit_preco_real": 420.38,
"peit_qtde_faturada": 4,
"peit_embalagem": "CX UM",
"peit_peso_bruto": 0,
"peit_desconto": "5+58+3+3+0,00+0,00+0,00",
"ys_cola_id": 2
}
JSON para DELETE
peit_id (Inteiro): Chave primria;
{
"peit_id": 251
}
Pedido Item Grade

Grades de tamanho dos itens dos pedidos. Caso no utilize grade de tamanho em seus produtos esta pode ser
desconsiderada.
URLs
GET https://api.suasvendas.com/api/PedidoItemGrade
GET
https://api.suasvendas.com/api/PedidoItemGrade/id?peig_peit_id=&peig_grade=&peig_opcao=
GET https://api.suasvendas.com/api/PedidoItemGrade?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/PedidoItemGrade
PUT https://api.suasvendas.com/api/PedidoItemGrade
DELETE https://api.suasvendas.com/api/PedidoItemGrade
Parmetros GET
peig_peit_id (Inteiro): Chave primria;
peig_grade (Inteiro): Chave primria;
peig_opcao (Inteiro): Chave primria;
Campos do JSON

ID do Item do Pedido representado pelo
peig_peit_id* INTEIRO S
atributo peit_id da entidade PEDIDO_ITEM.
Nome da grade representada pelo atributo
peig_grade* TEXTO S
ingr_grade da entidade INDUSTRIA_GRADE.
Nome da opo da grade representada pelo
peig_opcao* TEXTO S atributo ingr_valor da entidade
INDUSTRIA_GRADE.
Quantidade de produtos na grade e opo
peig_qtde INTEIRO S
definida nos campos acima.
Ordem das opes da grade para serem
peig_ordem INTEIRO S
mostradas no pedido.
Exemplo
[
{
"peig_peit_id": 239,
"peig_grade": "ELEGANCE POST",
"peig_opcao": "PLT POST",
"peig_qtde": 1,
"peig_ordem": 64,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"peig_opcao": "PLT POST",
"peig_qtde": 1,
"peig_ordem": 64,
"ys_cola_id": 2
}
JSON para DELETE

peig_peit_id (Inteiro): Chave primria;

peig_grade (Inteiro): Chave primria;
peig_opcao (Inteiro): Chave primria;
{
"peig_opcao": "PLT POST"
}
Pedido Comisso
Parcelas de comisso pagas para os escritrios de representao ou vendedores.
URLs
GET https://api.suasvendas.com/api/PedidoComissao
GET https://api.suasvendas.com/api/PedidoComissao/id?peco_id=
GET https://api.suasvendas.com/api/PedidoComissao?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/PedidoComissao
PUT https://api.suasvendas.com/api/PedidoComissao
DELETE https://api.suasvendas.com/api/PedidoComissao
Parmetros GET
peco_id (Inteiro): Chave primria;
Campos do JSON

peco_id* INTEIRO S ID do registro, chave primria.
peco_pedi_id INTEIRO S
Data prevista do pagamento dessa parcela de
peco_data_prevista DATA S
comisso.
Valor previsto proporcional do pedido
referente ao pagamento dessa parcela de
peco_valor_previsto DECIMAL S comisso. Desse valor ser pago o percentual
definido no atributo 'pedi_comissao' da
entidade PEDIDO.
Status do comissionamento dessa parcela. Se
ENUM No
peco_status S comissionada o valor ser 'Comissionado'. Se
PedidoComissaoStatus Comissionado
no, 'No Comissionado'.
Data real do pagamento dessa parcela de
peco_data_recebimento DATA N
comisso.
Valor real proporcional do pedido referente ao
peco_valor_recebido DECIMAL N
pagamento dessa parcela de comisso.
Nmero da Nota Fiscal de prestao de
servios emitida pelo vendedor ou escritrio
peco_nota_fiscal TEXTO N
de representao pelo recebimento desta
parcela de comisso.
peco_obs TEXTO N Observaes gerais sobre esta parcela.
Exemplo
[Corrigir Posio
{
"peco_id": 352,
"peco_pedi_id": 2,
"peco_data_prevista": "2015-11-11T00:00:00",
"peco_valor_previsto": 16790.5,
"peco_status": 1,
"peco_valor_recebido": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"peco_id": 1,
"peco_pedi_id": 2,
"peco_data_prevista": "2010-11-10T00:00:00",
"peco_valor_previsto": 549.49,
"peco_status": 1,
"peco_valor_recebido": 0,
"ys_cola_id": 2
}
JSON para DELETE

peco_id (Inteiro): Chave primria;
{
"peco_id": 359
}
Pedido Parcela
Refere-se ao parcelamento do pedido indicada na condio de pagamento.
URLs
GET https://api.suasvendas.com/api/PedidoParcela
GET https://api.suasvendas.com/api/PedidoParcela/id?pepa_id=
GET https://api.suasvendas.com/api/PedidoParcela?dataHoraAtualizacao=
POST https://api.suasvendas.com/api/PedidoParcela
PUT https://api.suasvendas.com/api/PedidoParcela
DELETE https://api.suasvendas.com/api/PedidoParcela
Parmetros GET
pepa_id (Inteiro): Chave primria;
Campos do JSON
Valor
Padro
pepa_id* INTEIRO S ID do registro, chave primria.
pepa_pedi_id INTEIRO S
pepa_data_prevista DATA S Data prevista de recebimento da parcela.
pepa_valor_previsto DECIMAL S Valor previsto de recebimento da parcela.
Tipo do documento de cobrana que a parcela
foi recebida. Valores aceitos: Boleto, Carn,
ENUM Carto de Crdito, Carto de Dbito, Cheque,
pepa_tipo_documento N
PedidoParcelaTipoDocumento Depsito em Conta Corrente, Dinheiro,
Duplicata, Dbito em Conta, Fatura, Nota
Promissria e Outros.
Nmero do documento de cobrana como por
pepa_numero_documento TEXTO N exemplo: nmero do cheque ou nmero da
nota fiscal.
pepa_valor_recebido DECIMAL N Valor real recebido.
No Status do pagamento da parcela. Valores
pepa_status ENUM PedidoParcelaStatus S
Pago aceitos: Pago, No Pago.
pepa_data_recebimento DATA N Data do recebimento desta parcela.
Exemplo
[Corrigir Posio
{
"pepa_id": 1,
"pepa_pedi_id": 10,
"pepa_data_prevista": "0001-01-01T00:00:00",
"pepa_valor_previsto": 0,
"pepa_status": 0,
"ys_cola_id": 2,
"ys_operacao": 1
}
]

{
"pepa_id": 2,
"pepa_pedi_id": 10,
"pepa_valor_previsto": 0,
"pepa_status": 0,
"ys_cola_id": 2
}
JSON para DELETE

pepa_id (Inteiro): Chave primria;
{
"pepa_id": 2
}
Dados para contato tcnico:
Pedro Henrique M. Felix
pedro@suasvendas.com
(62) 3923-4084 ou (62) 9919-6080
Av. 136, 797, Edifcio New York, Sala 1505-A

Setor Sul, Goinia-GO, CEP 74093-250

Documentacao Da API de Integracao SuasVendas

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Documentacao Da API de Integracao SuasVendas

Hochgeladen von

Copyright:

Verfügbare Formate

DOCUMENTAO DA API DE INTEGRAO SUASVENDAS

Verso: 2.0.1 Junho/2016

Especificao Geral da API

Retorno Padro para POST, PUT e DELETE

Tabela (String): Nome da tabela alterada.

Mensagens Padro de sucesso e erro

HTTP Status: 200 OK (GET, PUT e DELETE)

HTTP Status: 404 Not Found (GET, POST, PUT e DELETE)

Especificao dos Endpoints

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

cola_id (Integer): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

ID da Indstria representado pelo atributo

Comisso proporcional comisso que a

Percentual de acrscimo da tabela preos dos

Indica se o vendedor pode alterar o preo dos

Limite de desconto em percentual que o

Atributos gerais conforme descrito

JSON para POST e PUT

JSON para DELETE

vein_cola_id (Integer): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

vere_cola_id (Integer): Chave primria;

JSON para POST e PUT

JSON para DELETE

cont_id (Integer): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

ID da Indstria representado pelo atributo

ID da tabela de preo representada pela

Desconto (Ex. 10) ou Acrscimo (Ex. -10) em

Atributos gerais conforme descrito

JSON para POST e PUT

JSON para DELETE

clid_clie_id (Integer): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

clve_cont_id (Inteiro): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

cltr_clie_id (Inteiro): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

prod_id (Inteiro): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

prst_prod_id (Inteiro): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

prfo_id (Inteiro): Chave primria;

Atributo Tipo Obrigatrio Valor Padro Descrio

JSON para POST e PUT

JSON para DELETE

prca_id (Inteiro): Chave primria;