API SAX
Acessar nova versão de documentação
Categorias do Produto:
Endpoint: GET {Servidor:Porta}/sax/categoria
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- no_site: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Endpoint: POST {Servidor:Porta}/sax/categoria
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- descricao: String; Obrigatório
- no_site: Boolean; não obrigatório
- ativo: Boolean; não obrigatório
Exemplo do conteúdo da Requisição:
- id : Integer;
Exemplo do conteúdo da Resposta:
Grupos de Produto:
Endpoint: GET {Servidor:Porta}/sax/grupo
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- no_site: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Endpoint: POST {Servidor:Porta}/sax/grupo
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- nome: String; Obrigatório
- nome_reduzido: String; Obrigatório
- no_site: Boolean; não obrigatório
- ativo: Boolean; não obrigatório
Exemplo do conteúdo da Requisição:
- id : Integer;
Exemplo do conteúdo da Resposta:
Subgrupos de Produto:
Endpoint: GET {Servidor:Porta}/sax/subgrupo
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- grupo_id: Integer; Não Obrigatório
- codigo : Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- no_site: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Endpoint: POST {Servidor:Porta}/sax/subgrupo
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- descricao: String; Obrigatório
- descricao_reduzida: String; Obrigatório
- grupo_id: Integer; Obrigatório
- no_site: Boolean; não obrigatório
- ativo: Boolean; não obrigatório
Exemplo do conteúdo da Requisição:
- id : Integer;
Exemplo do conteúdo da Resposta:
Marcas de Produto:
Endpoint: GET {Servidor:Porta}/sax/marca
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- no_site: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Endpoint: POST {Servidor:Porta}/sax/marca
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- descricao: String; Obrigatório
- no_site: Boolean; não obrigatório
- ativo: Boolean; não obrigatório
Exemplo do conteúdo da Requisição:
- id : Integer;
Exemplo do conteúdo da Resposta:
Referências de Produto:
Endpoint: GET {Servidor:Porta}/sax/referencia
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Endpoint: POST {Servidor:Porta}/sax/referencia
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- descricao: String; Obrigatório
Exemplo do conteúdo da Requisição:
- id : Integer;
Exemplo do conteúdo da Resposta:
Produto:
Endpoint: GET {Servidor:Porta}/sax/produto
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- limit:Integer; Obrigatório se parâmetro id não informado
- offset:Integer; Obrigatório se parâmetro id não informado
- ativo:Boolean; Não Obrigatório
- destacar_site:Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_ultima_alteração: String; Não Obrigatório
Estoque de Produto:
Endpoint: GET {Servidor:Porta}/sax/estoque
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- produto_id: Integer; Não Obrigatório
- destacar: boolean; Não Obrigatório
- limit:Integer; Obrigatório se parâmetro produto_id não informado
- offset:Integer; Obrigatório se parâmetro produto_id não informado
- setor_estoque_id:Integer; Não Obrigatório
- marca_id:Integer; Não Obrigatório
- grupo_id:Integer; Não Obrigatório
- subgrupo_id;Integer; Não Obrigatório
Preço de Produto:
Endpoint: GET {Servidor:Porta}/sax/preco
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- produto_id: Integer; Não Obrigatório
- destacar: boolean; Não Obrigatório
- limit:Integer; Obrigatório se parâmetro produto_id não informado
- offset:Integer; Obrigatório se parâmetro produto_id não informado
- tabela_preco_id:Integer; Não Obrigatório
- marca_id:Integer; Não Obrigatório
- grupo_id:Integer; Não Obrigatório
- subgrupo_id;Integer; Não Obrigatório
Foto de Produto:
Endpoint: GET {Servidor:Porta}/sax/foto
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- produto_id: Integer; Obrigatório
Pedido:
Endpoint: GET {Servidor:Porta}/sax/pedido
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- limit:Integer; Obrigatório se parâmetro id não informado
- offset:Integer; Obrigatório se parâmetro id não informado
- cliente_id: Integer; Não Obrigatório
- vendedor_id: Integer; Não Obrigatório
- status_id: Integer; Não Obrigatório
- situacao:String; Não Obrigatório
- periodo_lancamento_inicio: String; Não Obrigatório
- periodo_lancamento_final: String; Não Obrigatório
- periodo_faturamento_inicio: String; Não Obrigatório
- periodo_faturamento_final: String; Não Obrigatório
Endpoint: POST{Servidor:Porta}/sax/pedido
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Exemplo do conteúdo da Requisição:
Campos obrigatórios em Negrito.
Array/Lista de Pedidos.
{
“pedidos”: [
{
“identificacao_interna“: “701861XXXXZ”,
“codigo_externo”: 0,
“situacao“: “AI”,
“cancelado”: false,
“contato”: “”,
“frete”: “S”,
“tabela”: “”,
“destacar”: “N”,
“situacao_separacao”: “N”,
“tipo_pedido_id”: 0,
“status_id”: 26,
“filial_id”: 1,
“vendedor_id“: 87,
“transportadora_id”: 0,
“forma_pagamento_id”: 0,
“setor_id”: 0,
“valor_total_servico“: “0.00”,
“valor_descontos_servico”: “0.00”,
“valor_total_produto“: “0.00”,
“valor_descontos_produto”: “0.00”,
“valor_frete”: “0.00”,
“valor_outra_despesas”: “0.00”,
“valor_total_geral“: “1000.00”,
“peso_bruto”: “0.00”,
“peso_liquido”: “0.00”,
“quantidade_volumes”: “0.00”,
“valor_total_pis”: “0.00”,
“valor_total_cofins”: “0.00”,
“valor_total_fcp”: “0.00”,
“valor_total_icms_recolhido”: “0.00”,
“valor_total_icms_sub”: “0.00”,
“valor_base_icms_sub”: “0.00”,
“valor_base_fcp”: “0.00”,
“tributos”: true,
“endereco“: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “0”,
“codigo_ibge_pais”: “1058”
},
“cliente“: {
“nome“: “CIBELLE CRISTINA OLIVEIRA DOS SANTOS”,
“apelido“: “CIBELLE CRISTINA OLIVEIRA DOS SANTOS”,
“cpf_cnpj“: “705.687.582-34”,
“rg“: “ISENTO”,
“sexo”: “F”,
“data_nascimento”: “1982-12-05”,
“estado_civil”: “”,
“nome_pai”: “”,
“nome_mae”: “”,
“suframa”: “”,
“telefone_comercial”: “(91)03246-4746”,
“telefone_residencial”: “(91)03246-3746”,
“telefone_celular”: “(91)99293-5933”,
“email“: “[email protected]”,
“email_fiscal”: “[email protected]”,
“rede_grupo_id”: 0,
“observacoes”: ” [email protected] “,
“endereco“: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “1058”
},
“endereco_cobranca”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “1058”
},
“endereco_entrega”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “0”
}
},
“data_cadastro”: “2014-01-06”,
“hora_cadastro”: “00:00:00”,
“data_pedido”: “1899-12-30”,
“hora_pedido”: “00:00:00”,
“data_aprovacao”: “1899-12-30”,
“hora_aprovacao”: “00:00:00”,
“data_previsao_entrega”: “1899-12-30”,
“data_prazo_faturamento”: “1899-12-30”,
“data_ultima_atualizacao”: “2020-02-10 15:02:21”,
“data_ultima_atualizacao_integracao”: “1899-12-30 00:00:00”,
“observacoes”: “”,
“observacoes2”: “”,
“produtos“: [
{
“sequencia”: 1,
“produto_id“: 240,
“referencia_produto_id”: 0,
“quantidade“: “6.00”,
“desconto”: “0.00”,
“valor_unitario“: “73.17”,
“valor_total_liquido“: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0,
“regra_icms”: 233,
“aliquota_icms”: “12.00”,
“incidencia_icms”: “100.00”,
“incidencia_icmsst”: “100.00”,
“incidencia_pis”: “100.00”,
“incidencia_cofins”: “100.00”,
“incidencia_icms_subtracao”: “100.00”,
“margem_icmsst”: “0”,
“pauta_icmsst”: “0”
},
{
“sequencia”: 2,
“produto_id”: 186,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
}
],
“parcelas”:[
{
“parcela” : 1,
“valor” : 100,
“vencimento” : “2021-07-01”,
“tipo_recebimento_id” : 1
},
{
“parcela” : 2,
“valor” : 100,
“vencimento” : “2021-08-01”,
“tipo_recebimento_id” : 1
}
]
},
{
“identificacao_interna”: “701861QQQ1”,
“codigo_externo”: 0,
“situacao”: “AI”,
“cancelado”: false,
“contato”: “”,
“frete”: “S”,
“tabela”: “”,
“destacar”: “N”,
“situacao_separacao”: “N”,
“tipo_pedido_id”: 0,
“status_id”: 26,
“filial_id”: 1,
“vendedor_id”: 87,
“transportadora_id”: 0,
“forma_pagamento_id”: 0,
“setor_id”: 0,
“valor_total_servico”: “0.00”,
“valor_descontos_servico”: “0.00”,
“valor_total_produto”: “0.00”,
“valor_descontos_produto”: “0.00”,
“valor_frete”: “0.00”,
“valor_outra_despesas”: “0.00”,
“valor_total_geral”: “1000.00”,
“peso_bruto”: “0.00”,
“peso_liquido”: “0.00”,
“quantidade_volumes”: “0.00”,
“valor_total_pis”: “0.00”,
“valor_total_cofins”: “0.00”,
“valor_total_fcp”: “0.00”,
“valor_total_icms_recolhido”: “0.00”,
“valor_total_icms_sub”: “0.00”,
“valor_base_icms_sub”: “0.00”,
“valor_base_fcp”: “0.00”,
“endereco”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “0”,
“codigo_ibge_pais”: “1058”
},
“cliente”: {
“nome”: “CIBELLE CRISTINA OLIVEIRA DOS SANTOS”,
“apelido”: “CIBELLE CRISTINA OLIVEIRA DOS SANTOS”,
“cpf_cnpj”: “705.687.582-34”,
“rg”: “ISENTO”,
“sexo”: “F”,
“data_nascimento”: “1982-12-05”,
“estado_civil”: “”,
“nome_pai”: “”,
“nome_mae”: “”,
“suframa”: “”,
“telefone_comercial”: “(91)03246-4746”,
“telefone_residencial”: “(91)03246-3746”,
“telefone_celular”: “(91)99293-5933”,
“email”: “[email protected]”,
“email_fiscal”: “[email protected]”,
“rede_grupo_id”: 0,
“data_cadastro”: “2012-01-05”,
“data_ultima_alteracao”: “2018-10-03 00:00:00”,
“observacoes”: ” [email protected] “,
“endereco”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “1058”
},
“endereco_cobranca”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “1058”
},
“endereco_entrega”: {
“logradouro”: “TRA QUINTINO BOCAIUVA”,
“cep”: “66053-240”,
“numero”: “638”,
“bairro”: “REDUTO”,
“cidade”: “BELEM”,
“estado”: “PA”,
“complemento”: “”,
“codigo_ibge_cidade”: “1501402”,
“codigo_ibge_pais”: “0”
}
},
“data_cadastro”: “2014-01-06”,
“hora_cadastro”: “00:00:00”,
“data_pedido”: “1899-12-30”,
“hora_pedido”: “00:00:00”,
“data_aprovacao”: “1899-12-30”,
“hora_aprovacao”: “00:00:00”,
“data_previsao_entrega”: “1899-12-30”,
“data_prazo_faturamento”: “1899-12-30”,
“data_ultima_atualizacao”: “2020-02-10 15:02:21”,
“data_ultima_atualizacao_integracao”: “1899-12-30 00:00:00”,
“observacoes”: “”,
“observacoes2”: “”,
“parcelas”:[
{
“parcela” : 1,
“valor” : 100,
“vencimento” : “2021-07-01”,
“tipo_recebimento_id” : 1
},
{
“parcela” : 2,
“valor” : 100,
“vencimento” : “2021-08-01”,
“tipo_recebimento_id” : 1
}
],
“produtos”: [
{
“sequencia”: 1,
“produto_id”: 240,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
},
{
“sequencia”: 2,
“produto_id”: 186,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
},
{
“sequencia”: 3,
“produto_id”: 258,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
},
{
“sequencia”: 4,
“produto_id”: 204,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
},
{
“sequencia”: 5,
“produto_id”: 276,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
},
{
“sequencia”: 6,
“produto_id”: 221,
“referencia_produto_id”: 0,
“quantidade”: “6.00”,
“desconto”: “0.00”,
“valor_unitario”: “73.17”,
“valor_total_liquido”: “0.00”,
“quantidade_separada”: “0.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“peso”: “0.00”,
“tabela_id”: 0,
“unidade”: “UND”,
“valor_preco_tabela”: “0.00”,
“valor_unitario_origem”: “0.00”,
“valor_custo_medio”: “0.00”,
“valor_ultimo_custo”: “0.00”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“valor_total_minimo”: “0.00”,
“aprovado”: “A”,
“tabela_preco_id”: 7,
“valor_icms”: “0.00”,
“valor_base_icms”: “0.00”,
“aliquota_difal”: “0.00”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_substituicao”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“aliquota_cofins”: “0.00”,
“aliquota_pis”: “0.00”,
“aliquota_fcp”: “0.00”,
“regra_icms”: 0,
“regra_ipi”: 0,
“regra_cofins”: 0,
“regra_fcp”: 0
}
]
}
]
}
Resposta:
{
“pedidos”: [
{
“id”: 35540,
“mensagem”: “sucesso”
},
{
“id”: 35541,
“mensagem”: “sucesso”
}
]
}
Cursos:
Endpoint: GET {Servidor:Porta}/sax/curso
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_alteracao: String; Não Obrigatório
Disciplinas:
Endpoint: GET {Servidor:Porta}/sax/disciplina
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_alteracao: String; Não Obrigatório
Turmas:
Endpoint: GET {Servidor:Porta}/sax/turma
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
- id: Integer; Não Obrigatório
- ativo: Boolean; Não Obrigatório
- data_cadastro: String; Não Obrigatório
- data_alteracao: String; Não Obrigatório
Impostos:
Endpoint: POST {Servidor:Porta}/sax/imposto
Parâmetros do cabeçalho/header:
- token: String; Obrigatório
Conteúdo JSON do Corpo da Requisição:
- filial_id: Integer; Obrigatório
- cliente_id: Integer; Não Obrigatório se campo cliente_cpfcnpj preenchido
- cliente_cpfcnpj: String; Não Obrigatório se campo cliente_id preenchido
- Produtos:
- sequencia : Integer; Não Obrigatório
- produto_id: Integer; Obrigatório
- quantidade: Integer; Obrigatório
- valor_unitario: Number/Double; Obrigatório
- valor_frete: Number/Double; Não Obrigatório
- desconto: Number/Double; Não Obrigatório
- outras_despesas: Number/Double; Não Obrigatório
- valor_total_liquido: Number/Double; Obrigatório
- seguro: Number/Double; Não Obrigatório
- lei_400_ipi: boolean; Não Obrigatório
- incidencia_lei_400_ipi: Number/Double; Não Obrigatório
- fator_quantidade: Number/Double; Não Obrigatório
Exemplo do conteúdo da Requisição:
- base_pis: Number/Double;
- valor_pis: Number/Double;
- base_cofins: Number/Double;
- valor_cofins: Number/Double;
- base_difal: Number/Double;
- valor_difal: Number/Double;
- base_icms: Number/Double;
- valor_icms: Number/Double;
- base_icmsst: Number/Double;
- valor_icmsst: Number/Double;
- base_ipi: Number/Double;
- valor_ipi: Number/Double;
- base_fcp: Number/Double;
- valor_fcp: Number/Double;
- valor_recolhimento: Number/Double;
- produtos:
- item: Integer;
- produto_id: Integer;
-
regra_pis_cofins: Integer;
-
aliquota_pis: Number/Double;
-
incidencia_pis: Number/Double;
- base_pis: Number/Double;
- valor_pis: Number/Double;
-
aliquota_cofins: Number/Double;
-
incidencia_cofins: Number/Double;
- base_cofins: Number/Double;
- valor_cofins: Number/Double;
- aliquota_difal: Number/Double;
- base_difal: Number/Double;
- valor_difal: Number/Double;
-
regra_icms: Integer;
-
aliquota_icms: Number/Double;
-
incidencia_icms: Number/Double;
- base_icms: Number/Double;
- valor_icms: Number/Double;
-
aliquota_icmsst: Number/Double;
-
incidencia_icmsst: Number/Double;
-
margem_icmsst: Number/Double;
-
pauta_icmsst: Number/Double;
- base_icmsst: Number/Double;
- valor_icmsst: Number/Double;
- regra_ipi: Integer;
- base_ipi: Number/Double;
- valor_ipi: Number/Double;
-
regra_fcp: Integer;
-
aliquota_fcp: Number/Double;
- base_fcp: Number/Double;
- valor_fcp: Number/Double;
- valor_recolhimento: Number/Double;
Exemplo do conteúdo da Resposta:
Pedidos de Compra:
Endpoint: GET{Servidor:Porta}/sax/pedidoCompra
Parâmetros do cabeçalho/header:
token: String; Obrigatório
id: Integer; Não Obrigatório
limit:Integer; Obrigatório se parâmetro id não informado
offset:Integer; Obrigatório se parâmetro id não informado
consumido_api: Boolean; Não Obrigatório
fornecedor_id: Integer; Não Obrigatório
vendedor_id: Integer; Não Obrigatório
status_id: Integer; Não Obrigatório
situacao:String; Não Obrigatório
periodo_lancamento_inicio: String; Não Obrigatório
periodo_lancamento_final: String; Não Obrigatório
periodo_faturamento_inicio: String; Não Obrigatório
periodo_faturamento_final: String; Não Obrigatório
Exemplo do conteudo recebido:{
“erro”: false,
“pedidos”: [
{
“id”: 5,
“identificacao_interna”: “”,
“codigo_externo”: 0,
“numero_pedido_fornecedor”: “2680”,
“situacao”: “FI”,
“tipo”: 0,
“faturado”: true,
“cancelado”: false,
“pedido”: false,
“orcamento”: false,
“contato”: “”,
“frete”: “C”,
“quantidade_parcelas”: 1,
“intervalo_parcelas”: 0,
“quantidade_fiscal”: “0.00”,
“destacar”: “S”,
“situacao_separacao”: “N”,
“tipo_pedido_id”: 0,
“status_id”: 0,
“filial_id”: 2,
“comprador_id”: 2,
“transportadora_id”: 0,
“forma_pagamento_id”: 0,
“setor_id”: 1,
“valor_total_servico”: “0.00”,
“valor_descontos_servico”: “0.00”,
“valor_total_produto”: “368.48”,
“valor_descontos_produto”: “0.00”,
“valor_frete”: “0.00”,
“valor_outra_despesas”: “0.00”,
“valor_total_geral”: “368.48”,
“valor_base_icms”: “0.00”,
“valor_total_icms”: “0.00”,
“valor_base_icms_st”: “0.00”,
“valor_total_icms_st”: “0.00”,
“valor_base_ipi”: “0.00”,
“valor_total_ipi”: “0.00”,
“fornecedor”: {
“id”: 16,
“nome_fantasia”: “MOVEIS ALBATROZ”,
“razao_social”: “PALUDETTO E CIA LTDA”,
“cpf_cnpj”: “77.991.552/0001-33”,
“setor_estoque_dropship”: {
“id”: 0,
“descricao”: “”,
“empresa_id”: 0,
“ativo”: false
}
},
“data_cadastro”: “2019-03-29”,
“data_pedido”: “2019-04-01”,
“data_recebimento”: “2019-03-29”,
“observacoes”: “”,
“observacoes2”: “”,
“produtos”: [
{
“sequencia”: 1,
“produto_id”: 2616,
“quantidade”: “1.00”,
“desconto”: “0.00”,
“valor_unitario”: “368.48”,
“quantidade_separada”: “0.00”,
“quantidade_faturada”: “1.00”,
“valor_frete”: “0.00”,
“valor_outras_despesas”: “0.00”,
“unidade”: “UND”,
“complemento”: “”,
“valor_custo_medio”: “375.42”,
“valor_ultimo_custo”: “368.48”,
“fator_valor”: “1.00”,
“fator_quantidade”: “1.00”,
“aprovado”: “A”,
“aliquota_valor_ipi”: “0.00”,
“aliquota_icms”: “0.00”,
“aliquota_icms_st”: “0.00”,
“aliquota_icms_subtracao”: “0.00”,
“creditar_icms”: true,
“creditar_icms_st”: true,
“creditar_ipi”: true,
“cst_icms”: “”,
“cst_ipi”: “”,
“incidencia_icms”: “0.00”,
“incidencia_icms_subtracao”: “0.00”,
“incidencia_icms_st”: “0.00”,
“incidencia_lei_400_ipi”: “0.00”,
“margem_valor_agregado”: “0.00”,
“lei_400_ipi”: false
}
],
“parcelas”: [
{
“parcela”: 1,
“valor”: “368.48”,
“vencimento”: “2019-03-29”
}
]
}
]
}
Pedidos de Compra Lidos:
Endpoint: POST{Servidor:Porta}/sax/pedidoCompraLido
Parâmetros do cabeçalho/header:
token: String; Obrigatório
Parâmetros do body: x-www-form-urlencoded
codigos : String; Obrigatório
Exemplo de valor do parâmetro codigos: [1,2,3]
Exemplo de conteúdo de retorno
Faturar Pedidos de Compra:
Endpoint: POST{Servidor:Porta}/sax/faturarPedidoCompra
Parâmetros do cabeçalho/header:
token: String; Obrigatório
Parâmetros do body: x-www-form-urlencoded
faturamentos: String; Obrigatório
Exemplo de valor do parâmetro faturamentos:
[{“pedido_compra_id”: 1,”chave_nfe” : “21312312”, “xml_nfe” : “21312312”, “danfe_pdf_nfe” : “” },
{“pedido_compra_id”: 2,”chave_nfe” : “11111111”, “xml_nfe” : “33333333”, “danfe_pdf_nfe” : “” }]
Exemplo de conteúdo de retorno