Considerações iniciais
A API de integração permite a comunicação de qualquer sistema (em qualquer linguagem) com o ERP EXCIA.
A integração com a API é feita através do protocolo HTTP (modelo REST) e os dados são comunicados em formato JSON.
Dependendo da linguagem que for utilizada para desenvolver a aplicação que irá consumir a API, pode ser necessário definir o “content encoding” com o valor “raw”.
As datas devem ser informadas como string, no formato DD/MM/YYYY. O mesmo formato será utilizado nos retornos.
Os valores numéricos devem ser informados usando o “.” (ponto) como separador decimal. Ou com “,” (virgula), se o valor for informado como string (Entre aspas).
Todos os métodos possuem os devidos retornos, tanto para sucesso quanto para erro.
Os dados de acesso, como endereço e porta, devem ser informados pelo cliente.
Os métodos do tipo GET, exibem por padrão até 300 registros. O parâmetro pagina (Integer) está disponível em todos os métodos para efetuar a paginação.
Autenticação
Para obter o acesso à API, é necessário primeiramente obter o token de acesso, para isso, entre em contato com a EXCIA através do e-mail: suporte@exciasistemas.com.br
IMPORTANTE:
O token deve ser passado no header de todas as requisições.
Sugerimos o uso do valor "application/json" no Content-Type.
Headers:
Content-Type: application/json
Token: 7bda5b50e9bb04d3ae3fa89c81b7b6be
O token informado acima não é válido, é apenas um exemplo.
Limite de requisições
A API possui limitação na quantidade de requisições que podem ser efetuadas por um IP no intervalo de 1 segundo.
Caso o limite seja excedido, será retornado status 429 (too many requests) e um objeto JSON com descritivo do erro.
Exemplo de retorno quando o limite de requisições é excedido
[
{
"error": "Limite de requisições excedido. Tente novamente mais tarde."
}
]
A quantidade de requisições permitidas no período varia de acordo com a parametrização de cada instância da API. 4 headers estão disponíveis na resposta das requisições para auxiliar a manter o controle da quantidade de chamadas dentro do limite, são eles:
| Header | Descrição |
|---|---|
| X-RateLimit-Limit | Quantidade total de requisições permitidas no período de 1 segundo |
| X-RateLimit-Remaining | Quantidade restantes de requisições permitidas no ciclo atual |
| X-RateLimit-Reset | Tempo restante para reinício do ciclo, em milissegundos |
| Retry-After | Tempo de espera necessário para tentar novamente, em milissegundos |
Cliente
Incluir ou alterar cliente
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Inclusão efetuada com sucesso",
"codcli": "11019",
"cnpj": "09.365.785/0009-85"
}
]
Ou, em caso de alteração:
[
{
"resultado": "Alteração efetuada com sucesso",
"codcli": "11019",
"cnpj": "09.365.785/0009-85"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Não foi possível processar entidade: cnpj inválido"
}
]
Exemplo do corpo da requisição:
[
{
"nome": "INDUSTRIA TESTE S.A.",
"inscricao": "ISENTO",
"cnpj": "00.000.000/0000-00",
"endereco": "RUA TESTE",
"complemento": "",
"ativo": "S",
"bairro": "BAIRRO TESTE",
"cep": "89130000",
"cep_cob": "89130000",
"cep_ent": "89130000",
"cnpj_cob": "00.000.000/0000-00",
"cnpj_ent": "00.000.000/0000-00",
"data_cad": "30/12/2020",
"email": "teste@email.com",
"end_cob": "RUA TESTE COB",
"end_ent": "RUA TESTE ENT",
"fax": "47 9999-9999",
"insc_cob": "ISENTO",
"insc_ent": "ISENTO",
"telefone": "47 8888-8888",
"fantasia": "EMP TESTE",
"bairro_ent": "BAIRRO TESTE ENT",
"bairro_cob": "BAIRRO TESTE COB",
"cod_pais": "1055",
"num_end": "01",
"num_ent": "01",
"num_cob": "01",
"grupo": "001",
"classe": "001",
"historico": "001",
"sit_dup": "01",
"tipo_entidade": "C",
"natureza": "5.101",
"transporte": "0004",
"obs": "TESTE OBS CLIENTE",
"obs_finan": "TESTE OBS FINANCEIRA",
"banco": "237",
"agencia": "9999",
"conta": "9999999-9",
"tabela": "001",
"data_fund": "30/12/2020",
"codrep": [
"001",
"002",
"003",
"004"
],
"contatos": [
{
"email": "contato@email.com.br",
"nome": "Contato 1",
"tipo": "1",
"fone": "(47) 9999-9999",
"dt_nasc": "05/07/1989",
"obs": "Observação teste",
"ordem": 1
},
{
"email": "contato2@email.com.br",
"nome": "Contato 2",
"tipo": "2",
"fone": "(47) 9999-9999",
"dt_nasc": "01/01/1999",
"obs": "Observação teste",
"ordem": 2
}
],
"classificacao": [
{
"codcert": "001",
"dt_validade": "01/01/2024"
},
{
"codcert": "002",
"dt_validade": "01/01/2024"
}
]
}
]
Método responsável pela inclusão ou alteração de clientes.
A alteração de um cliente se dará pelo mesmo método de inclusão, caso o CNPJ já exista na base de dados, o cliente será atualizado.
URL
POST http://{ip_cliente}/Entidade
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| nome | string / 80 | Sim | Nome do cliente |
| fantasia | string / 70 | Não | Nome fantasia do cliente |
| cnpj | string / 18 | Sim | CNPJ ou CPF do cliente devidamente formatado |
| inscricao | string / 18 | Sim | Inscrição estadual do cliente. Caso não exista, passar o valor ISENTO |
| ativo | string / 1 | Sim | Define se o cliente está ativo ou não |
| string / 100 | Sim | E-mail do cliente | |
| telefone | string / 30 | Sim | Telefone do cliente |
| fax | string / 18 | Não | Telefone secundário do cliente |
| tipo_entidade | string / 5 | Sim | Informar o valor “C” |
| endereco | string / 50 | Sim | Endereço principal do cliente |
| complemento | string / 50 | Não | Complemento do endereço principal |
| cep | string / 8 | Sim | CEP do cliente |
| bairro | string / 35 | Sim | Bairro do cliente |
| num_end | string / 7 | Sim | Número do endereço do cliente |
| cod_pais | string / 4 | Sim | Código do país do cliente |
| cnpj_cob | string / 18 | Não | CNPJ de cobrança devidamente formatado |
| fone_cob | string / 30 | Não | Telefone de cobrança |
| cep_cob | string / 8 | Sim | CEP de cobrança |
| end_cob | string / 50 | Sim | Endereço de cobrança |
| insc_cob | string / 18 | Não | Inscrição estadual de cobrança |
| bairro_cob | string / 35 | Sim | Bairro do endereço de cobrança |
| num_cob | string / 7 | Sim | Número do endereço de cobrança |
| cnpj_ent | string / 18 | Não | CNPJ de entrega devidamente formatado |
| cep_ent | string / 8 | Sim | CEP de entrega |
| end_ent | string / 50 | Sim | Endereço de entrega |
| insc_ent | string / 18 | Não | Inscrição estadual de entrega |
| bairro_ent | string / 35 | Sim | Bairro de entrega |
| num_ent | string / 15 | Sim | Número do endereço de entrega |
| comp_ent | string / 50 | Não | Complemento do endereço de entrega |
| data_cad | date | Não | Data de cadastro do cliente (DD/MM/YYYY) |
| grupo | string / 6 | Sim | Código do grupo |
| classe | string / 6 | Não | Código da classe gerencial |
| natureza | string / 7 | Não | CFOP / Natureza |
| historico | string / 4 | Não | Código do histórico |
| sit_dup | string / 2 | Não | Código da situação da duplicata |
| codrep | array | Não | Código do representante e prepostos. Será esperado o representante na primeira posição e os prepostos nas demais |
| transporte | string / 4 | Não | Código da transportadora |
| obs | blob | Não | Observação do cliente |
| obs_finan | blob | Não | Observação financeira |
| banco | string / 3 | Não | Código do banco |
| conta | string / 13 | Não | Conta bancária |
| agencia | string / 6 | Não | Agência da conta bancária |
| tabela | string / 5 | Não | Código da tabela de preço/região |
| cod_cid | string / 7 | Não | Código do munícipio (IBGE) para endereço padrão |
| cod_cid_cob | string / 7 | Não | Código do munícipio (IBGE) para endereço de cobrança |
| cod_cid_ent | string / 7 | Não | Código do munícipio (IBGE) para endereço de entrega |
| nome_cid | string / 50 | Não | Nome do município para endereço padrão |
| nome_cid_cob | string / 50 | Não | Nome do município para endereço de cobrança |
| nome_cid_ent | string / 50 | Não | Nome do município para endereço de entrega |
| uf | string / 2 | Não | Sigla do estado para endereço padrão |
| uf_cob | string / 2 | Não | Sigla do estado para endereço de cobrança |
| uf_ent | string / 2 | Não | Sigla do estado para o endereço de entrega |
| data_fund | date | Não | Data da fundação (DD/MM/YYYY) |
| contatos | Objeto | Não | Contatos do cliente |
| string / 50 | Não | Endereço de E-mail | |
| fone | string / 15 | Não | Número de telefone |
| nome | string / 50 | Sim | Nome |
| tipo | string / 1 | Sim | Tipo do contato 1 - Diretoria 2 - Comercial 3 - Financeiro 4 - NFe 5 - Outro 6 - Compras 7 - Desenvolvimento |
| dt_nasc | date | Não | Data de nascimento |
| obs | string / 50 | Não | Observação do contato |
| ordem | integer | Não | Ordem do contato. Será utilizado como chave para alteração do registro. |
| classificacao | Objeto | Não | Classificação e certificados do cliente |
| codcert | string / 3 | Sim | Código da classificação / certificado |
| dt_validade | date | Não | Data de validade |
Atributos Alteráveis
Caso o CNPJ já exista na base de dados, é possível realizar a alteração da entidade através dos atributos abaixo. No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos com valor vazio serão ignorados na alteração.
| Parâmetro | Tipo/Tamanho | Descrição |
|---|---|---|
| agencia | string / 6 | Agência da conta bancária |
| ativo | string / 1 | Define se o cliente está ativo ou não |
| bairro | string / 35 | Bairro do cliente |
| bairro_cob | string / 35 | Bairro do endereço de cobrança |
| bairro_ent | string / 35 | Bairro de entrega |
| banco | string / 3 | Código do banco |
| cep | string / 8 | CEP do cliente |
| cep_cob | string / 8 | CEP de cobrança |
| cep_ent | string / 8 | CEP de entrega |
| classe | string / 6 | Código da classe gerencial |
| cod_pais | string / 4 | Código do país do cliente |
| codrep | array | Código do representante e prepostos. Será esperado o representante na primeira posição e os prepostos nas demais |
| comp_ent | string / 50 | Complemento do endereço de entrega |
| complemento | string / 50 | Complemento do endereço principal |
| conta | string / 13 | Conta bancária |
| string / 100 | E-mail do cliente | |
| end_cob | string / 50 | Endereço de cobrança |
| end_ent | string / 50 | Endereço de entrega |
| endereco | string / 50 | Endereço principal do cliente |
| fantasia | string / 70 | Nome fantasia do cliente |
| fax | string / 18 | Telefone secundário do cliente |
| fone_cob | string / 30 | Telefone de cobrança |
| grupo | string / 6 | Código do grupo |
| historico | string / 4 | Código do histórico |
| natureza | string / 7 | CFOP / Natureza |
| num_cob | string / 7 | Número do endereço de cobrança |
| num_end | string / 7 | Número do endereço do cliente |
| num_ent | string / 15 | Número do endereço de entrega |
| obs | blob | Observação do cliente |
| obs_finan | blob | Observação financeira |
| sit_dup | string / 2 | Código da situação da duplicata |
| tabela | string / 5 | Código da tabela de preço/região |
| telefone | string / 30 | Telefone do cliente |
| transporte | string / 4 | Código da transportadora |
| cod_cid | string / 7 | Código do munícipio (IBGE) para endereço padrão |
| cod_cid_cob | string / 7 | Código do munícipio (IBGE) para endereço de cobrança |
| cod_cid_ent | string / 7 | Código do munícipio (IBGE) para endereço de entrega |
| nome_cid | string / 50 | Nome do município para endereço padrão |
| nome_cid_cob | string / 50 | Nome do município para endereço de cobrança |
| nome_cid_ent | string / 50 | Nome do município para endereço de entrega |
| uf | string / 2 | Sigla do estado para endereço padrão |
| uf_cob | string / 2 | Sigla do estado para endereço de cobrança |
| uf_ent | string / 2 | Sigla do estado para o endereço de entrega |
| credito | number / 11,2 | Limite de crédito |
| contatos | Objeto | Não |
| string / 50 | Endereço de E-mail | |
| fone | string / 15 | Número de telefone |
| dt_nasc | date | Data de nascimento |
| obs | string / 50 | Observação do contato |
| ordem | integer | Ordem do contato. Será utilizado como chave para alteração do registro. |
| classificacao | Objeto | Não |
| dt_validade | date | Data de validade |
Caso já exista para o cliente um contato com a mesma ordem, os campos nome, tipo, email, fone, dt_nasc e obs serão atualizados conforme o informado.
Se a ordem não for informada, mas existir com mesmo nome e tipo, os campos email, fone, dt_nasc e obs serão atualizados conforme o informado.
Se algum campo do objeto contatos for omitido, o mesmo não sofrerá alterações. Se o campo estiver informado, mas vazio, será gravado vazio.
Consultar cliente
Método responsável por retornar os dados de um determinado cliente a partir de um CNPJ.
Exemplo de retorno OK:
http://{ip_cliente}/BuscarEntidade?cnpj=00.000.000/0000-00
[
{
"nome": "EMPRESA EXEMPLO",
"fantasia": "EXEMPLO EMPRESA",
"telefone": "(47) 3380-5400",
"telefone2": "(47) 3380-5400",
"email": "email@exemplo.com",
"endereco": "RUA EXEMPLO",
"bairro": "CENTRO",
"cep": "89130000",
"cod_cid": "0000000",
"nome_cid": "INDAIAL",
"cod_est": "SC",
"num_end": "475",
"complemento": "COMPLEMENTO",
"cnpj": "00.000.000/0001-00",
"codcli": "00001",
"data_cad": "27/06/2024",
"sit_cli": "10",
"grupo": "1377",
"inscricao": "ISENTO",
"insc_mun": "",
"ativo": "S",
"bloqueio": "N",
"dt_altera": "05/03/2026",
"condicao": " ",
"motivo": "",
"transporte": "0007",
"obs": "",
"obs_finan": "",
"banco": "999",
"agencia": "",
"conta": "",
"tabela": "",
"data_fund": "01/06/2000",
"cod_pais": "1058",
"cep_cob": "89130000",
"cnpj_cob": "00.000.000/0001-00",
"end_cob": "RUA EXEMPLO",
"insc_cob": "ISENTO",
"bairro_cob": "CENTRO",
"num_cob": "475",
"fone_cob": "",
"cep_ent": "89130000",
"cnpj_ent": "00.000.000/0001-00",
"end_ent": "RUA EXEMPLO",
"insc_ent": "ISENTO",
"bairro_ent": "CENTRO",
"num_ent": "1",
"comp_ent": "",
"dias": 5,
"tipo": "2",
"nome_cid_cob": "INDAIAL",
"cod_est_cob": "SC",
"sit_dup": "01",
"cif": "1",
"desconto": 0.0,
"suframa": "",
"simples": "A",
"historico": "0001",
"dt_nasc": "",
"cod_atvd": "001",
"frete": 0.0,
"classe": "4164",
"prazo": "00",
"credito": 45000.0,
"credito_utilizado": 0.0,
"codrep": ["0001", "0002"],
"inadimplente": "N",
"contatos": [
{
"email": "exemplo@exemplo.com",
"nome": "CONTATO EXEMPLO",
"tipo": "1",
"fone": "4798765432",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo",
"ordem": 1
},
{
"email": "exemplo2@exemplo.com",
"nome": "CONTATO EXEMPLO 2",
"tipo": "5",
"fone": "4723456789",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo 2",
"ordem": 2
}
],
"classificacao": [
{
"tipo": "P",
"desc_tipo": "Produção",
"codcert": "001",
"descricao": "Descrição abcd"
},
{
"tipo": "E",
"desc_tipo": "Perfil",
"codcert": "002",
"descricao": "Descrição 1234"
}
]
}
]
URL
GET http://{ip_cliente}/BuscarEntidade
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
O parâmetro de CNPJ devem ser passado no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/BuscarEntidade?cnpj=00.000.000/0000-00
Caso seja necessário consultar um cliente através do CPF, deve-se utilizar o mesmo parâmetro cnpj, com o valor devidamente formatado para CPF.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| cnpj | string / 18 | Sim (Caso não informado o parâmetro codcli) |
CNPJ ou CPF do cliente a ser consultado, devidamente formatado. |
| codcli | string / 5 | Sim (Caso não informado o parâmetro cnpj) |
Código da entidade |
Consultar lista de clientes
Método responsável por disponibilizar uma lista de clientes atualizados a partir de uma determinada data.
Exemplo de retorno OK:
http://{ip_cliente}/EntidadeLista?data=01/10/2021
[
{
"nome": "EMPRESA EXEMPLO",
"fantasia": "EXEMPLO EMPRESA",
"telefone": "(47) 3380-5400",
"telefone2": "(47) 3380-5400",
"email": "email@exemplo.com",
"endereco": "RUA EXEMPLO",
"bairro": "CENTRO",
"cep": "89130000",
"cod_cid": "0000000",
"nome_cid": "INDAIAL",
"cod_est": "SC",
"num_end": "475",
"complemento": "COMPLEMENTO",
"cnpj": "00.000.000/0001-00",
"codcli": "00001",
"data_cad": "27/06/2024",
"sit_cli": "10",
"grupo": "1377",
"inscricao": "ISENTO",
"insc_mun": "",
"ativo": "S",
"bloqueio": "N",
"dt_altera": "05/03/2026",
"condicao": " ",
"motivo": "",
"transporte": "0007",
"obs": "",
"obs_finan": "",
"banco": "999",
"agencia": "",
"conta": "",
"tabela": "",
"data_fund": "01/06/2000",
"cod_pais": "1058",
"cep_cob": "89130000",
"cnpj_cob": "00.000.000/0001-00",
"end_cob": "RUA EXEMPLO",
"insc_cob": "ISENTO",
"bairro_cob": "CENTRO",
"num_cob": "475",
"fone_cob": "",
"cep_ent": "89130000",
"cnpj_ent": "00.000.000/0001-00",
"end_ent": "RUA EXEMPLO",
"insc_ent": "ISENTO",
"bairro_ent": "CENTRO",
"num_ent": "1",
"comp_ent": "",
"dias": 5,
"tipo": "2",
"nome_cid_cob": "INDAIAL",
"cod_est_cob": "SC",
"sit_dup": "01",
"cif": "1",
"desconto": 0.0,
"suframa": "",
"simples": "A",
"historico": "0001",
"dt_nasc": "",
"cod_atvd": "001",
"frete": 0.0,
"classe": "4164",
"prazo": "00",
"credito": 45000.0,
"credito_utilizado": 0.0,
"codrep": ["0001", "0002"],
"inadimplente": "N",
"contatos": [
{
"email": "exemplo@exemplo.com",
"nome": "CONTATO EXEMPLO",
"tipo": "1",
"fone": "4798765432",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo",
"ordem": 1
},
{
"email": "exemplo2@exemplo.com",
"nome": "CONTATO EXEMPLO 2",
"tipo": "5",
"fone": "4723456789",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo 2",
"ordem": 2
}
],
"classificacao": [
{
"tipo": "P",
"desc_tipo": "Produção",
"codcert": "001",
"descricao": "Descrição abcd"
},
{
"tipo": "E",
"desc_tipo": "Perfil",
"codcert": "002",
"descricao": "Descrição 1234"
}
]
},
{
"nome": "EMPRESA EXEMPLO 2",
"fantasia": "EXEMPLO EMPRESA 2",
"telefone": "(47) 3380-5400",
"telefone2": "(47) 3380-5400",
"email": "email@exemplo2.com",
"endereco": "RUA EXEMPLO",
"bairro": "CENTRO",
"cep": "89130000",
"cod_cid": "0000000",
"nome_cid": "INDAIAL",
"cod_est": "SC",
"num_end": "475",
"complemento": "COMPLEMENTO",
"cnpj": "00.000.000/0001-01",
"codcli": "00002",
"data_cad": "27/06/2025",
"sit_cli": "10",
"grupo": "1377",
"inscricao": "ISENTO",
"insc_mun": "",
"ativo": "S",
"bloqueio": "N",
"dt_altera": "05/03/2026",
"condicao": " ",
"motivo": "",
"transporte": "0007",
"obs": "",
"obs_finan": "",
"banco": "999",
"agencia": "",
"conta": "",
"tabela": "",
"data_fund": "01/06/2000",
"cod_pais": "1058",
"cep_cob": "89130000",
"cnpj_cob": "00.000.000/0001-00",
"end_cob": "RUA EXEMPLO",
"insc_cob": "ISENTO",
"bairro_cob": "CENTRO",
"num_cob": "475",
"fone_cob": "",
"cep_ent": "89130000",
"cnpj_ent": "00.000.000/0001-00",
"end_ent": "RUA EXEMPLO",
"insc_ent": "ISENTO",
"bairro_ent": "CENTRO",
"num_ent": "1",
"comp_ent": "",
"dias": 5,
"tipo": "2",
"nome_cid_cob": "INDAIAL",
"cod_est_cob": "SC",
"sit_dup": "01",
"cif": "1",
"desconto": 0.0,
"suframa": "",
"simples": "A",
"historico": "0001",
"dt_nasc": "",
"cod_atvd": "001",
"frete": 0.0,
"classe": "4164",
"prazo": "00",
"credito": 45000.0,
"credito_utilizado": 0.0,
"codrep": ["0001", "0002"],
"inadimplente": "N",
"contatos": [
{
"email": "exemplo@exemplo.com",
"nome": "CONTATO EXEMPLO",
"tipo": "1",
"fone": "4798765432",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo",
"ordem": 1
},
{
"email": "exemplo2@exemplo.com",
"nome": "CONTATO EXEMPLO 2",
"tipo": "5",
"fone": "4723456789",
"dt_nasc": "01/01/2000",
"obs": "Observação exemplo 2",
"ordem": 2
}
],
"classificacao": [
{
"tipo": "P",
"desc_tipo": "Produção",
"codcert": "001",
"descricao": "Descrição abcd"
},
{
"tipo": "E",
"desc_tipo": "Perfil",
"codcert": "002",
"descricao": "Descrição 1234"
}
]
}
]
Consulta onde nenhum cliente foi encontrado:
http://{ip_cliente}/EntidadeLista?data=01/10/2023
[
{
"method-error-400": "Não foi possível buscar entidade: Nenhum registro encontrado."
}
]
Consulta onde será retornado erro:
http://{ip_cliente}/EntidadeLista?data=01/21/2023
[
{
"method-error-400": "Não foi possível buscar entidade: '01/21/2023' is not a valid date and time"
}
]
URL
GET http://{ip_cliente}/EntidadeLista
Retorno
A consulta irá considerar os clientes atualizados com a data maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/EntidadeLista?data=07/01/2021
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente devidamente formatado, ou a raiz do CNPJ devidamente formatada. |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
| ativo | string / 1 | Não | Status do cadastro do cliente S = Ativo N = Inativo |
| tipo_entidade | string / 1 | Não | Tipo do cadastro do cliente C - Cliente F - Fornecedor T - Terceiro P - Prospect |
| empresa | string / 3 | Não | Número da empresa |
| codrep | string / 5 | Não | Código do representante |
| nome | string / 80 | Não | Nome / Razão social |
| nome_cid | string / 50 | Não | Nome da cidade |
| cod_est | string / 2 | Não | Sigla do estado / UF |
| endereco | string / 50 | Não | Endereço / logradouro |
| cod_atvd | string / 4 | Não | Código do ramo de atividade |
Consultar Contatos
Método responsável por buscar contatos através do número do telefone.
Exemplo de retorno OK:
http://{ip_cliente}/BuscarContato?telefone=(99) 99999-9999
[
{
"codcli": "00001",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"grupo": "0001",
"contatos": [
{
"nome": "Contato 1",
"tipo": "1",
"email": "teste@email.com",
"fone": "(99) 99999-9999",
"dt_nasc": "01/01/2000",
"obs": "OBSERVAÇÃO TESTE",
"ordem": 1
},
{
"nome":"Contato 2",
"tipo": "6",
"email": "teste2@email.com",
"fone": "(99) 99999-9999",
"dt_nasc": "01/01/2000",
"obs": "OBSERVAÇÃO TESTE",
"ordem": 2
}
]
},
{
"codcli": "00002",
"nome": "CLIENTE EXEMPLO2",
"cnpj": "00.000.000/0001-02",
"grupo": "0007",
"contatos": [
{
"nome": "Contato 1",
"tipo": "2",
"email": "teste@email.com",
"fone": "(99) 99999-9999",
"dt_nasc": "01/01/1999",
"obs": "OBSERVAÇÃO TESTE",
"ordem": 1
},
{
"nome":"Contato 2",
"tipo": "4",
"email": "teste2@email.com",
"fone": "(99) 99999-9999",
"dt_nasc": "01/01/1999",
"obs": "OBSERVAÇÃO TESTE",
"ordem": 2
}
]
}
]
Consulta onde nenhum registro foi encontrado:
http://{ip_cliente}/BuscarContato?telefone=(99) 99999-0000
[
{
"method-error-400": "Não foi possível buscar contato: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/BuscarContato
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
A consulta será feita considerando apenas os números. Para efetuar a consulta na base de dados a API fará automaticamente a remoção dos caracteres que não forem numéricos.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/BuscarContato?telefone=(99) 99999-9999
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| telefone | string / 16 | Sim | Número de telefone para consulta |
Pedido
Incluir pedido
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Pedido cadastrado com sucesso",
"pedido": "00001"
}
]
O controle de pedidos já existentes será feito através do atributo “ped_cli”, caso o pedido enviado já exista, será retornada a seguinte mensagem:
[
{
"method-error-400": "Erro ao processar pedido: Pedido 112233 já está registrado no sistema EXCIA com o número 01234"
}
]
Caso o campo “validar_estoque” estiver sendo informado com o valor “S”, todos os itens do pedido terão suas quantidades validadas antes da inserção. Se algum item não possuir quantidade suficiente para atender o pedido, será retornada a seguinte mensagem:
[
{
"method-error-400": "Pedido inválido, Item com estoque insuficiente: ",
"itens": [
{
"codigo": "123456",
"cor": "0",
"tam": "P"
},
{
"codigo": "123456",
"cor": "0",
"tam": "M"
},
{
"codigo": "123456",
"cor": "0",
"tam": "G"
}
]
}
]
Caso a API encontre algum item que não exista no ERP EXCIA, será retornada a seguinte mensagem:
[
{
"method-error-400": "Erro ao processar pedido: Item não existe Codigo: 123456 Cor: 001 Tam: G"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Erro ao processar Pedido: Pedido não pode ser gravado sem itens"
}
]
Exemplo do corpo da requisição:
[
{
"ped_cli": "112233",
"cnpj": "00.000.000/0000-00",
"dtdigita": "08/09/2021",
"dt_emissao": "08/09/2021",
"dt_fatura": "08/10/2021",
"entrega": "09/10/2021",
"codrep": "0000",
"com1": "3",
"com2": "2",
"per_desc": "5",
"tab_trans": "001",
"cif": "0",
"tab_redes": "002",
"redesp_cif": "0",
"colecao": "00",
"tab_pre": "015",
"pgto": "30 60 90 120150",
"obs": "Pedido teste",
"obs_producao": "",
"frete": "0",
"tipo": "P",
"periodo": "0000",
"periodo_prod": "0000",
"moeda": "3",
"sit_dup": "01",
"colecao_estoque": ["001", "002"],
"validar_estoque": "S",
"calcular_comissao": "S",
"itens": [
{
"qtde": "2",
"preco": "74,98",
"tam": "42",
"cor": "AZ",
"codigo": "201014600",
"qtde_packs": "1",
"qualidade": "1",
"qtde_orig": "2",
"preco_orig": "74,98",
"tipo": "P",
"dt_entrega": "09/10/2021",
"deposito": "0000"
},
{
"qtde": "4",
"preco": "74,98",
"tam": "44",
"cor": "AZ",
"codigo": "201014600",
"qtde_packs": "1",
"qualidade": "1",
"qtde_orig": "2",
"preco_orig": "74,98",
"tipo": "P",
"dt_entrega": "09/10/2021",
"deposito": "0000"
}
],
"agendamento": {
"obs_05": "123456",
"dt_entrega": "01/10/2021",
"obs_04": "09:25",
"valor_frete": 10.2,
"obs_10": "JOAO JOSE",
"cnpj_ent": "0",
"insc_ent": "ISENTO",
"cep_ent": "89130000",
"end_ent": "RUA TESTE",
"num_ent": "10",
"bairro_ent": "CENTRO",
"comp_ent": "complemento",
"agendamento": "Observação exemplo"
}
}
]
Método responsável pela inclusão ou alteração de pedidos.
A alteração de um pedido se dará pelo mesmo método de inclusão, caso o campo numero for informado e já existir no banco de dados.
URL
POST http://{ip_cliente}/Pedido
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ped_cli | string / 30 | Sim | Número do pedido da plataforma |
| codcli | string / 5 | Não | Código do cliente: Utilizar se não for informado o CNPJ |
| cnpj | string / 18 | Sim | CNPJ do cliente |
| codrep | string / 5 | Sim | Representante |
| com1 | number / 5,2 | Não | Comissão de Faturamento |
| com2 | number / 5,2 | Não | Comissão de recebimento |
| dtdigita | date | Não | Data de Digitação (DD/MM/YYYY) |
| dt_emissao | date | Sim | Data de Emissão (DD/MM/YYYY) |
| dt_fatura | date | Sim | Data de Fatura (DD/MM/YYYY) |
| entrega | date | Sim | Data de Entrega (DD/MM/YYYY) |
| frete | number / 9,2 | Não | Valor de frete |
| tab_trans | string / 4 | Sim | Transportadora |
| cif | string / 1 | Não | Modalidade de Frete: 1 = CIF 2 = FOB 3 = Terceiro 4 = Sem Frete 5 = Próprio (Rem.) 6 = Próprio (Dest.) |
| tab_redes | string / 4 | Não | Campo Redespacho |
| redesp_cif | string / 1 | Não | Modalidade de frete: 1 = CIF 2 = FOB 3 = Terceiro 4 = Sem Frete 5 = Próprio (Rem.) 6 = Próprio (Dest.) |
| colecao | string / 4 | Não | Coleção do pedido |
| pgto | string / 36 | Não | Condição de pagamento. Informar considerando três posições para cada parcela, por exemplo: 30 60 90 120150180 |
| tab_pre | string / 5 | Não | Tabela de preços do pedido |
| per_desc | number / 5,2 | Não | Percentual de desconto |
| obs | blob | Não | Observação comercial do pedido |
| obs_producao | blob | Não | Observação de produção e expedição do pedido |
| periodo | string / 4 | Não | Código do período de entrega |
| periodo_prod | string / 4 | Não | Código do período de entrega produtivo |
| moeda | string / 2 | Não | Código da moeda |
| sit_dup | string / 2 | Não | Código da situação da duplicata |
| financeiro | string / 1 | Não | Define o status financeiro do pedido: "0" = Bloqueado "1" = Liberado Se não informado, será assumido o valor "1" automaticamente |
| empresa | string / 3 | Não | Define a empresa em que o pedido será gravado. Se não informado, o pedido será gravado na empresa principal |
| colecao_estoque | string / 4 | Não | Código da coleção do pedido. Caso informado, na validação do estoque será considerado para cálculo do saldo apenas os pedidos da coleção informada |
| validar_estoque | string / 1 | Não | Informar “S” para validar o estoque antes da inclusão do pedido. Caso este atributo não seja informado, ou caso seja informado com um valor inválido, o estoque não será validado. |
| calcular_comissao | string / 1 | Não | Informar "S" para calcular a comissão do pedido de acordo com os parâmetros do cadastro de grupo de comissões do ERP. |
| cfop | string / 8 | Não | CFOP para ser utilizada no faturamento |
| tipo | string / 1 | Não | Informar o valor "P" |
| itens | objeto | Sim | Itens do pedido |
| barra | string / 13 | Não | EAN13 do item. Informar somente se não forem informados os campos de codigo, cor e tam |
| codigo | string / 15 | Sim | Código do item |
| cor | string / 6 | Sim | Código da cor do item |
| tam | string / 4 | Sim | Tamanho do item |
| qtde | number / 10,3 | Sim | Quantidade do item |
| preco | number / 13,5 | Sim | Preço do item |
| tipo | string / 1 | Sim | Tipo do item: P: Produto M: Material |
| dt_entrega | date | Sim | Data de entrega do item (DD/MM/YYYY) |
| qualidade | string / 1 | Não | Informar o valor “1” |
| qtde_packs | integer | Não | Quantidade de packs do item |
| desc_pack | string / 10 | Não | Descrição do pack |
| preco_orig | number / 13,5 | Sim | Preço original do item |
| qtde_orig | number / 10,3 | Sim | Quantidade original do item |
| deposito | string / 6 | Não | Depósito para validação de estoque do item |
| perc_comissao | number | Não | Percentual de comissão do item. |
| agendamento | objeto | Não | Dados de agendamento / entrega |
| obs_05 | string / 30 | Não | Senha |
| dt_entrega | date | Não | Data de entrega |
| obs_04 | string / 30 | Não | Hora de entrega |
| valor_frete | number / 9,2 | Não | Valor do frete |
| obs_10 | string / 30 | Não | Contato |
| cnpj_ent | string / 18 | Não | CNPJ de entrega |
| insc_ent | string / 18 | Não | Inscrição estadual de entrega |
| cep_ent | string / 8 | Não | CEP de entrega |
| end_ent | string / 50 | Não | Endereço de entrega |
| num_ent | string / 7 | Não | Número de entrega |
| bairro_ent | string / 35 | Não | Bairro de entrega |
| comp_ent | string / 50 | Não | Complemento de endereço de entrega |
| agendamento | blob | Não | Observação |
Atributos alteráveis
Caso o número já exista na base de dados, é possível realizar a alteração do pedido através dos atributos abaixo. No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos não informados serão ignorados na alteração.
Para ser considerado uma alteração, deve-se informar no corpo da requisição o campo "numero" com um número de pedido existente na base de dados. Pode-se informar, também, o campo "empresa", caso o pedido esteja em uma empresa diferente da 001.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tab_trans | string / 4 | Não | Transportadora |
| frete | number / 9,2 | Não | Valor de frete |
| entrega | date | Não | Data de Entrega (DD/MM/YYYY) |
| periodo | string / 4 | Não | Código do período de entrega |
| obs | blob | Não | Observação comercial do pedido |
Consultar pedido
Método responsável por retornar os dados de um determinado pedido, a partir de um numero de pedido ou pedido do cliente.
Consulta com retorno OK:
http://{ip_cliente}/BuscarPedido?numero=07939
[
{
"numero": "00001",
"ped_cli": "ABC1234",
"dt_emissao": "01/01/2026",
"dt_fatura": "01/02/2026",
"codcli": "00001",
"cnpj": "00.000.000/0001-00",
"nome": "CLIENTE EXEMPLO",
"codrep": "0001",
"nome_rep": "REPRESENTANTE EXEMPLO",
"motivo": "",
"cfop": "",
"tab_trans": "0001",
"desc_tab_trans": "TRANSPORTADORA EXEMPLO",
"cif": "1",
"colecao": "01",
"desc_colecao": "COLECAO EXEMPLO",
"tab_pre": "0001",
"desc_tab_pre": "TABELA PADRÃO",
"per_desc": 10.0,
"pgto": "120150180 ",
"obs": "OBSERVAÇÃO EXEMPLO",
"bloqueio": "1",
"financeiro": "1",
"entrega": "02/02/2026",
"com1": 6.0,
"com2": 2.0,
"periodo": "0001",
"sit_dup": "00",
"moeda": "0",
"desc_moeda": "DINHEIRO",
"vlr_desc": 0.0,
"frete": 0.0,
"codcond": 0,
"desc_cond": "",
"ris": "",
"tab_pre2": "00",
"existe_reserva": "N",
"reserva_liberada": "N",
"itens": [
{
"codigo": "ABC123",
"tipo": "P",
"codigo2": "",
"peso_l": 0.162,
"descricao": "PRODUTO EXEMPLO",
"cor": "999999",
"desc_cor": "SORTIDO",
"tam": "P",
"preco": 56.9,
"preco_orig": 56.9,
"qtde": 0.0,
"faturado": 2.0,
"cancelado": 0.0,
"dt_entrega": "02/02/2026",
"perc_comissao": 0.0,
"ordem": 1,
"qtde_packs": 1,
"desc_pack": "",
"estampa": "",
"desc_estampa": "",
"observacao": "",
"desconto": "0,00",
"expedido": 0.0,
"reservado": 0.0,
"barra": "0000000000000",
"barra28": "000000",
"local": ""
},
{
"codigo": "ABC123",
"tipo": "P",
"codigo2": "",
"peso_l": 0.162,
"descricao": "PRODUTO EXEMPLO",
"cor": "999999",
"desc_cor": "SORTIDO",
"tam": "M",
"preco": 56.9,
"preco_orig": 56.9,
"qtde": 2.0,
"faturado": 0.0,
"cancelado": 0.0,
"dt_entrega": "02/02/2026",
"perc_comissao": 0.0,
"ordem": 1,
"qtde_packs": 1,
"desc_pack": "",
"estampa": "",
"desc_estampa": "",
"observacao": "",
"desconto": "0,00",
"expedido": 0.0,
"reservado": 0.0,
"barra": "0000000000000",
"barra28": "000000",
"local": ""
}
],
"notas": [
{
"fatura": "112233",
"dt_emissao": "02/02/2026",
"dt_expedicao": "01/02/2026",
"dt_entrega": "02/02/2026",
"dt_despacho": "02/02/2026",
"valor_frete": 50,
"obs": "",
"transportadora": "0001"
}
]
}
]
URL
GET http://{ip_cliente}/BuscarPedido
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
Para consultar os dados de um pedido através do número do ERP EXCIA, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/BuscarPedido?numero=07939
Para consultar os dados de um pedido através do pedido do cliente, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/BuscarPedido?ped_cli=112246
Os parâmetros que forem informados com a nomenclatura diferente da informada na tabela abaixo serão ignorados na consulta.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 12 | Sim (Caso não informado o parâmetro ped_cli) |
Número do pedido |
| ped_cli | string / 30 | Sim (Caso não informado o parâmetro numero) |
Número do pedido do cliente |
| empresa | string / 3 | Não | Número da empresa |
Consultar lista de pedidos
Método responsável por disponibilizar uma lista de pedidos emitidos a partir de uma determinada data.
Exemplo de retorno OK:
http://{ip_cliente}/PedidoLista?emissao=01/06/2021
[
{
"numero": "000001",
"ped_cli": "ABC123",
"dt_emissao": "01/01/2026",
"codcli": "00001",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"codrep": "0001",
"nome_rep": "REPRESENTANTE EXEMPLO",
"per_desc": 1.0,
"vlr_desc": 0.0,
"pgto": "120150180 ",
"entrega": "01/01/2026",
"bloqueio": "1",
"financeiro": "1",
"empresa": "_001",
"qtde": 0.0,
"preco": 2892.0,
"valor": 0.0,
"faturado": 66.0,
"cancelado": 0.0,
"sit_dup": "00",
"colecao": "01",
"valor_total_liq": 2504.3312,
"valor_total_fat": 3194.3,
"valor_total_pen": 0.0,
"valor_total_bruto": 3194.3,
"obs": "OBSERVAÇÃO EXEMPLO",
"dt_altera": "14/02/2026 12:00:33"
},
{
"numero": "000002",
"ped_cli": "ABC124",
"dt_emissao": "01/01/2026",
"codcli": "00001",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"codrep": "0001",
"nome_rep": "REPRESENTANTE EXEMPLO",
"per_desc": 1.0,
"vlr_desc": 0.0,
"pgto": "120150180 ",
"entrega": "01/01/2026",
"bloqueio": "1",
"financeiro": "1",
"empresa": "_001",
"qtde": 0.0,
"preco": 2892.0,
"valor": 0.0,
"faturado": 66.0,
"cancelado": 0.0,
"sit_dup": "00",
"colecao": "01",
"valor_total_liq": 2504.3312,
"valor_total_fat": 0.0,
"valor_total_pen": 3194.3,
"valor_total_bruto": 3194.3,
"obs": "OBSERVAÇÃO EXEMPLO",
"dt_altera": "14/02/2026 14:36:03"
}
]
URL
GET http://{ip_cliente}/PedidoLista
Retorno
A consulta irá considerar os pedidos com data de emissão, ou de alteração, maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/PedidoLista?dt_emissao_ini=07/01/2021
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| dt_emissao_ini | date | Sim (Caso não informado o parâmetro alteracao) |
Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| dt_emissao_fim | date | Não | Data final da consulta. Utilizar o formato DD/MM/YYYY |
| alteracao | date | Sim (Caso não informado o parâmetro emissao) |
Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| empresa | string / 3 | Não | Número da empresa |
| codcli | string / 5 | Não | Código do cliente |
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente do pedido devidamente formatado |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
| situacao | string / 1 | Não | Situação do pedido. P - Pendente F - Faturado C - Totalmente cancelado |
| status_com | string / 1 | Não | Status do pedido no comercial 0 - bloqueado 1 - liberado |
| status_fin | string / 1 | Não | Status do pedido no financeiro 0 - bloqueado 1 - liberado |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| codrep | string / 5 | Não | Código do representante |
| cnpj_rep | string / 18 | Não | CNPJ do representante |
Alterar status do pedido
Método permite alterar o status financeiro e comercial do pedido.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/StatusPedido?numero=06434&usuario=NOME_USUARIO
[
{
"resultado": "Status do pedido alterado com sucesso",
"pedido": "06434",
"bloqueio": "0",
"financeiro": "1"
}
]
Exemplo do corpo da requisição:
[
{
"bloqueio": "0",
"financeiro": "1"
}
]
URL
POST http://{ip_cliente}/StatusPedido
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/StatusPedido?numero=06434&usuario=NOME_USUARIO
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 12 | Sim | Número do pedido para alteração |
| usuario | string / 20 | Não | Nome do usuário para a alteração |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| bloqueio | string / 1 | Não | Status do pedido no comercial 0 - bloqueado 1 - liberado |
| financeiro | string / 1 | Não | Status do pedido no financeiro 0 - bloqueado 1 - liberado |
Consultar expedição
Método responsável por disponibilizar dados da expedição de pedidos
Exemplo de retorno OK:
http://{ip_cliente}/BuscarExpedicao?numero=01234
[
{
"numero": "01234",
"codcli": "01234",
"tab_trans": "001",
"qtde": 30,
"qtde_f": 20,
"data": "01/01/2022",
"peso": 19.17,
"peso_f": 29.82,
"notafiscal": [
"0687473",
"0687474"
],
"caixas": [
{
"caixa": "019749",
"qtde": 30,
"qtde_f": 0,
"peso": 19.17,
"notafiscal": [
"0687473"
]
},
{
"caixa": "019750",
"qtde": 0,
"qtde_f": 20,
"peso": 29.82,
"notafiscal": [
"0687474"
]
}
]
}
]
Consulta onde nenhum pedido foi encontrado:
http://{ip_cliente}/BuscarExpedicao?numero=01234X
[
{
"method-error-400": "Não foi possível buscar expedição: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/BuscarExpedicao
Retorno
Serão apresentados 300 registros por página
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/BuscarExpedicao?numero=01234
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 12 | Sim (Caso não informado o parâmetro data) |
Número do pedido |
| empresa | string / 3 | Não | Número da empresa |
| data | date | Sim (Caso não informado o parâmetro numero) |
Data de expedição |
| liberado | string / 1 | Não | S: Liberado para faturamento N: Bloqueado para faturamento |
| caixa | string / 6 | Não | Número da caixa |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Gravar expedição
Método responsável por gravar expedição de pedidos.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Movimentação concluída.",
"numero": "14648",
"caixa": "018766",
"itens_erro": []
}
]
Se algum item não puder ser movimentado, constará no array itens_erro, o item e o motivo:
[
{
"resultado": "Movimentação concluída.",
"numero": "14648",
"caixa": "018766",
"itens_erro": [
{
"barra": "1000000000000",
"lote": "000000",
"deposito": "0001",
"motivo": "Estoque insuficiente."
},
{
"barra": "1000000000001",
"lote": "000000",
"deposito": "0001",
"motivo": "Item não encontrado."
},
{
"barra": "1000000000002",
"lote": "000000",
"deposito": "0001",
"motivo": "Sem quantidades disponíveis para Baixa."
}
]
}
]
Exemplo do corpo da requisição
[
{
"pedido": "00001",
"tp_caixa": "01",
"funcionario": "00001",
"caixa": "000001",
"tipo_baixa": "01",
"itens": [
{
"barra": "1000000000001",
"lote": "000000",
"deposito": "0001",
"qtde": 10,
"ordem": 1
},
{
"barra": "1000000000002",
"lote": "000000",
"deposito": "0001",
"qtde": 10,
"ordem": 2
}
]
}
]
URL
POST http://{ip_cliente}/Expedicao
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/Expedicao?empresa=_002
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pedido | string / 12 | Sim | Número do pedido |
| tp_caixa | string / 5 | Sim | Código do tipo da caixa |
| funcionario | string / 5 | Sim | Código do funcionário |
| caixa | string / 6 | Não | Número da caixa Se informado, e a caixa já existir, os itens serão gravados na mesma Caso informado, e a caixa não existir, retornará uma mensagem "caixa inválida" |
| tipo_baixa | string / 2 | Não | Tipo da baixa para movimentação do estoque |
| Itens | Objeto | Sim | Itens para expedição |
| barra | string / 25 | Sim | Código de barras do produto EAN ou código de barras do cliente |
| lote | string / 15 | Sim | Número do lote |
| deposito | string / 6 | Sim | Código do depósito |
| qtde | Number / 10,3 | Sim | Quantidade a expedir |
| ordem | Integer | Não | Ordem do item no pedido |
As seguintes ações no ato da expedição dependem das parametrizações do ERP:
- Movimentar estoque dos itens expedidos;
- Permitir expedição de Pedidos Bloqueados (comercial e/ou financeiro).
- Bloquear expedição de pedidos com reserva não liberada.
- Percentual de tolerância de quantidade além do pedido.
Excluir expedição
Método responsável pela exclusão da expedição.
Exemplo de retorno:
[
{
"resultado": "Expedição excluída.",
"pedido": "00001",
"caixa": "000001"
}
]
URL
DELETE http://{ip_cliente}/Expedicao/:numero
DELETE http://{ip_cliente}/Expedicao/:numero/:caixa
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o número e a caixa informados como path param.
Exemplo para excluir toda a expedição de um pedido:
DELETE http://{ip_cliente}/Expedicao/12345?empresa=001
Exemplo para excluir apenas uma caixa:
DELETE http://{ip_cliente}/Expedicao/12345/000001?empresa=001
Onde "12345" representa o número do pedido e "000001" representa o número da caixa.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número do pedido |
| caixa | string / path param | Não | Número da caixa |
| empresa | string / 3 | Não | Número da empresa |
As seguintes ações no ato da expedição dependem das parametrizações do ERP:
- Voltar o estoque dos itens removidos da expedição.
Excluir pedido
Método responsável pela exclusão de pedidos.
Exemplo de retorno:
[
{
"resultado": "Pedido excluído."
}
]
URL
DELETE http://{ip_cliente}/Pedido/:numero
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o número informado como path param, exemplo:
DELETE http://{ip_cliente}/Pedido/12345?empresa=001
Onde "12345" representa o número do pedido.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número do pedido |
| empresa | string / 3 | Não | Número da empresa |
Consultar ranking de vendas
Método responsável por disponibilizar uma listagem de ranking de vendas.
Exemplo de retorno:
[
{
"codigo": "00001",
"descricao": "DESCRICAO EXEMPLO 1",
"qtde": 10,
"qtde_f": 40,
"qtde_c": 5,
"valor_total_liq": 500.2
},
{
"codigo": "00002",
"descricao": "DESCRICAO EXEMPLO 2",
"qtde": 10,
"qtde_f": 20,
"qtde_c": 0,
"valor_total_liq": 200.2
}
]
URL
GET http://{ip_cliente}/Pedido/Relatorio/Ranking
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
O formato do retorno será sempre o mesmo, mas o conteúdo dos campos codigo e descricao variam de acordo com o tipo.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Pedido/Relatorio/Ranking?tipo=1&emissao_ini=01/01/2024
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Sim | 1 - Cliente 2 - Mês 3 - Grupo de produto |
| emissao_ini | date | Sim | Data inicial de emissão dos pedidos |
| emissao_fim | date | Não | Data final de emissão dos pedidos |
| codrep | string / 5 | Não | Código do representante |
| cnpj_rep | string / 18 | Não | CNPJ do representante |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Consultar fluxo do pedido
Método responsável por disponibilizar as informações do fluxo do pedido
Exemplo de retorno:
[
{
"numero": "000001",
"codigo": "ABC1234",
"setor": "01",
"desc_setor": "ENTRADA PEDIDO",
"dt_inicio": "01/02/2026",
"dt_prev": "03/02/2026",
"dt_fim": "03/02/2026",
"situacao": "B",
"qtde": 10.0,
"tipo": "P"
},
{
"numero": "000001",
"codigo": "ABC1234",
"setor": "02",
"desc_setor": "CADASTRO DE CORES",
"dt_inicio": "03/02/2026",
"dt_prev": "04/02/2026",
"dt_fim": "",
"situacao": "A",
"qtde": 10.0,
"tipo": "P"
}
]
URL
GET http://{ip_cliente}/Pedido/Fluxo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Exemplo:
GET http://{ip_cliente}/Pedido/Fluxo?numero=000001&dt_prev_ini=01/03/2026&empresa=_001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 12 | Não ¹ | Número do pedido |
| dt_prev_ini | date | Não ¹ | Data de previsão inicial |
| dt_prev_fim | date | Não | Data de previsão final |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
¹ Obrigatório informar ou numero ou dt_prev_ini
Nota Fiscal
Consultar Faturas de Pedidos
Método responsável por retornar informações sobre faturas de pedidos.
Este método retorna apenas faturas que foram originadas a partir do faturamento de pedidos.
Exemplo de retorno OK:
http://{ip_cliente}/FaturaPedidoLista?pedido=00001&empresa=001
[
{
"pedido": "10001",
"fatura": "100000",
"dt_emissao": "01/01/2024",
"existe_nrbanco": "S",
"transportadora": "0001 - TRANSPORTADORA EXEMPLO",
"dt_entrega": "05/01/2024",
"dt_expedicao": "01/01/2024",
"dt_despacho": "04/01/2024",
"chave": "00000000000000000000000000000000000000000000",
"cnpj": "00.000.000/0001-00",
"valor": 999.99,
"empresa": "_001",
"volumes": 1,
"impresso": "S",
"tipo_fiscal": "55"
}
]
Consulta onde nenhuma fatura foi encontrada:
http://{ip_cliente}/FaturaPedidoLista?pedido=00001&empresa=001
[
{
"method-error-400": "Não foi possível buscar fatura: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/FaturaPedidoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/FaturaPedidoLista?pedido=00001&fatura=000001&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pedido | string / 12 | Sim (Caso não informado fatura ou emissao) |
Número do pedido |
| fatura | string / 7 | Sim (Caso não informado pedido ou emissao) |
Número da fatura / nota fiscal |
| emissao | date | Sim (Caso não informado pedido ou fatura) |
Data de emissão da nota fiscal |
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente devidamente formatado |
| tipo_fiscal | string / 2 | Não | Modelo/Tipo fiscal |
| impresso | string / 1 | Não | Status da fatura: N - Não Impressas/Transmitidas S - Impressas/Transmitidas T - Transmitidas em Contingência C - Canceladas D - Denegadas |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| empresa | string / 3 | Não | Número da empresa |
Consultar Faturas
Método responsável por retornar informações sobre faturas.
Exemplo de retorno:
[
{
"fatura": "001234",
"codcli": "00111",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"val_produtos": 9750.6,
"valor": 6825.42,
"dt_emissao": "01/01/2024",
"mensagem": "Devolucao Ref. NF: 001122 de 23/12/2023.",
"tp_base": "2",
"impresso": "S",
"chave_nfe": "00000000000000000000000000000000000000000000",
"nota_ref": [
{
"docto": "001122"
}
]
},
{
"fatura": "001235",
"codcli": "00111",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"val_produtos": 5290.9,
"valor": 3703.63,
"dt_emissao": "01/01/2024",
"mensagem": " ",
"tp_base": "1",
"impresso": "S",
"chave_nfe": "00000000000000000000000000000000000000000000",
"nota_ref": []
}
]
URL
GET http://{ip_cliente}/Fatura
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Fatura?fatura=00001&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| fatura | string / 7 | Sim (Caso não informado dt_emissao) |
Número da fatura / nota fiscal |
| dt_emissao | date | Sim (Caso não informado fatura) |
Data de emissão da nota fiscal |
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente devidamente formatado |
| codcli | string / 5 | Não | Código do cliente / destinatário |
| tp_base | string / 1 | Não | 1 - Notas de saída 2 - Notas de entrada |
| impresso | string / 1 | Não | Status da fatura: N - Não Impressas/Transmitidas S - Impressas/Transmitidas T - Transmitidas em Contingência C - Canceladas D - Denegadas |
| empresa | string / 3 | Não | Número da empresa |
Consultar XML
Método responsável por retornar os dados de um determinado XML, a partir de uma chave de NF-e ou todos os XML(s) relacionados ao pedido.
Os XML(s) serão retornados criptografados em Base64.
Exemplo de retorno dos XML(s) com número do pedido:
http://{ip_cliente}/BuscarXML?pedido=123456
[
{
"chave": "000000000000000000000000000000000000000000000",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48bmZlUHJvYyB2ZXJzYW89IjQuMDAiIHhtb..."
},
{
"chave": "000000000000000000000000000000000000000000001",
"xml": "HcyxNpqrwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48bmZlUHJvYyB2ZXJzYW89IjQuMDAiIHhtb..."
}
]
Exemplo de retorno do XML com chave de NF-e:
http://{ip_cliente}/BuscarXML?chave=000000000000000000000000000000000000000000000
[
{
"chave": "000000000000000000000000000000000000000000000",
"xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48bmZlUHJvYyB2ZXJzYW89IjQuMDAiIHhtb..."
}
]
Consulta onde nenhum registro do item foi encontrado:
http://{ip_cliente}/BuscarXML?pedido=0
[
{
"method-error-400": "Não foi possível buscar XML: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/BuscarXML
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo, para consultar os XML(s) de um determinado pedido, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/BuscarXML?pedido=123456
Os parâmetros que forem informados com a nomenclatura diferente da informada na tabela abaixo serão ignorados na consulta.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pedido | string / 12 | Sim (Caso não informado o parâmetro chave) |
Número do pedido |
| chave | string / 44 | Sim (Caso não informado o parâmetro pedido) |
Número chave da NF-e |
| empresa | string / 3 | Não | Número da empresa |
Consultar PDF
Método responsável por retornar o PDF de uma nota fiscal (DANFE).
URL
GET http://{ip_cliente}/Fatura/Download/:chave_nfe
Retorno
Content-Type: application/pdf
Em caso de sucesso será retornado status 200.
Em caso de erro, será retornado status 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, sendo a chave da nota fiscal informada como path param. Por exemplo:
GET http://{ip_cliente}/Fatura/Download/0000000000000000000000000000000000000000000?tipo=pdf&empresa=_001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| chave_nfe | string / path param | Sim | Chave da nota fiscal |
| tipo | string / 3 | Sim | Valor fixo: pdf |
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Incluir dados de entrega
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Nota de entrega cadastrado com sucesso.",
"fatura": "0000001"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Não foi possível processar nota entrega: Número da fatura já existe."
}
]
Exemplo do corpo da requisição:
[
{
"empresa":"001",
"fatura":"0000001",
"dt_expedicao":"01/01/2023",
"dt_entrega":"01/01/2023",
"dt_despacho":"01/01/2023",
"valor_frete":0.00,
"obs":"",
"vol_lidos":1,
"cnpj_transp": "00.000.000/0000-00"
}
]
Método responsável pela inclusão dos dados de entrega da nota fiscal.
URL
POST http://{ip_cliente}/NotaEntrega
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/NotaEntrega?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| fatura | string / 7 | Sim | Número da Fatura |
| dt_expedicao | date | Não | Data de expedição (DD/MM/YYYY) |
| dt_entrega | date | Não | Data de entrega (DD/MM/YYYY) |
| dt_despacho | date | Não | Data de despacho (DD/MM/YYYY) |
| obs | blob | Não | Observação |
| vol_lidos | integer | Não | Volumes lidos |
| valor_frete | number / 9,2 | Não | Valor do frete |
| cnpj_transp | string / 18 | Não | CNPJ da transportadora para gravar na nota fiscal Caso não informado nenhuma alteração será efetuada |
Incluir rastreio
Exemplo de retorno:
[
{
"resultado": "Rastreio fatura cadastrado com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"nota": "00001234",
"data": "01/01/2024",
"hora": "10:45:00",
"cartao": "0000000000",
"servico": "00000",
"lista": "00000000000",
"itens": [
{
"mov": 1,
"documento": "00000000000000"
},
{
"mov": 2,
"documento": "00000000000000"
},
{
"mov": 3,
"documento": "00000000000000"
}
]
}
]
Método responsável pela inclusão de rastreios de transporte das notas fiscais
URL
POST http://{ip_cliente}/RastreioFatura
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/RastreioFatura?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| nota | string / 8 | Sim | Número da nota fiscal |
| data | date | Sim | Data de emissão |
| hora | time | Sim | Hora da emissão (Utilizar o formato HH:MM:SS) |
| cartao | string / 10 | Sim | Número do cartão |
| servico | string / 5 | Sim | Código do serviço |
| lista | string / 11 | Sim | Protocolo de transmissão |
| itens | objeto | Sim | Itens / Volumes |
| mov | integer | Sim | Número sequencial |
| documento | string / 14 | Sim | Código do rastreio |
Consultar rastreio
Método responsável por disponibilizar uma lista de rastreios de transporte das notas fiscais.
Método responsável por retornar informações sobre faturas de pedidos.
Exemplo de retorno:
[
{
"codtran": "0001",
"documento": "QQ000006005BR",
"nota": "0100001",
"data": "28/11/2023",
"hora": "11:19:15",
"lista": "805040405",
"servico": "03298",
"observacao": "Observação exemplo"
},
{
"codtran": "0001",
"documento": "QQ000007001BR",
"nota": "0100002",
"data": "28/11/2023",
"hora": "12:37:15",
"lista": "805040405",
"servico": "03298",
"observacao": "Observação exemplo 2"
}
]
URL
GET http://{ip_cliente}/RastreioFatura
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/RastreioFatura?data=01/01/2022¬a=010001&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data de Emissão. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| nota | string / 8 | Não | Número da fatura / nota fiscal |
| empresa | string / 3 | Não | Número da empresa |
Incluir fatura
Exemplo de retorno:
[
{
"resultado": "Fatura cadastrada com sucesso.",
"fatura": "000001"
}
]
Exemplo de retorno com erro:
[
{
"resultado": "Não foi possível processar fatura. Itens inválidos.",
"itens_erro": [
{
"codigo": "ABC123",
"cor": "0001",
"tamanho": "P",
"motivo": "Produto inválido"
}
]
}
]
[
{
"method-error-400": "Não foi possível processar fatura: codcli inválido."
}
]
Exemplo do corpo da requisição:
[
{
"codcli": "00001",
"codrep": "0001",
"dt_emissao": "01/01/2024",
"dt_saida": "01/01/2024",
"transport": "0001",
"redesp": "0010",
"cif": "1",
"redesp_cif": "1",
"natureza": "6.10700",
"valor": 381.7,
"base_calc": 381.7,
"aliquota": 12,
"val_icms": 45.8,
"marca": "",
"volumes": 1,
"pecas": 3,
"nr_volumes": 3,
"base_ipi": 0,
"val_ipi": 0,
"pesol": 0.66,
"pesob": 0.66,
"mensagem": "",
"placa": "",
"val_frete": 50,
"val_seguro": 0,
"desconto": 0,
"despesas": 0,
"val_produtos": 331.7,
"val_pis": 2.48,
"val_cofins": 11.45,
"val_import": 0,
"val_subst": 0,
"base_subst": 0,
"docto": "",
"especie": "",
"val_fcp": 0,
"val_icms_remet": 0,
"val_icms_dest": 0,
"impresso": "N",
"itens": [
{
"codigo": "ABC321",
"cor": "0002",
"tamanho": "G",
"qtde": 1.0,
"preco": 59.9,
"valor": 59.9,
"deposito": "0005",
"lote": "000000",
"descricao": "CAMISETA EXEMPLO",
"data_mvto": "01/01/2024",
"codsped": "00",
"unidade": "UN",
"natureza": "6.10700",
"tipo_it": "P",
"empenho": "N",
"cla_fis": "09",
"base_st": 0.0,
"perc_red": 0.0,
"perc_st": 0.0,
"valor_st": 0.0,
"custo": 31.9665,
"chave_ref": "",
"cla_trib": "00",
"base_icms": 68.93,
"perc_icms": 12.0,
"trib_ipi": "51",
"base_ipi": 0.0,
"perc_ipi": 0.0,
"trib_pis": "01",
"base_pis": 68.93,
"perc_pis": 0.65,
"trib_cofins": "01",
"base_cofins": 68.93,
"perc_cofins": 3.0,
"base_ii": 0.0,
"perc_ii": 0.0,
"pedido": "",
"volumes": 0,
"ord_ped": 1,
"perc_dif": 0.0,
"valor_dif": 0.0,
"origem": "0",
"desconto": 0.0,
"val_fcp": 0.0,
"val_icms_remet": 0.0,
"val_icms_dest": 3.45,
"nota_cliente": "",
"valor_st_fcp": 0.0
},
{
"codigo": "ABC123",
"cor": "0086",
"tamanho": "M",
"qtde": 2.0,
"preco": 135.9,
"valor": 271.8,
"deposito": "0005",
"lote": "000000",
"descricao": "BERMUDA EXEMPLO",
"data_mvto": "01/01/2024",
"codsped": "00",
"unidade": "UN",
"natureza": "6.10700",
"tipo_it": "P",
"empenho": "N",
"cla_fis": "11",
"base_st": 0.0,
"perc_red": 0.0,
"perc_st": 0.0,
"valor_st": 0.0,
"custo": 56.9262,
"chave_ref": "",
"cla_trib": "00",
"base_icms": 312.77,
"perc_icms": 12.0,
"trib_ipi": "51",
"base_ipi": 0.0,
"perc_ipi": 0.0,
"trib_pis": "01",
"base_pis": 312.77,
"perc_pis": 0.65,
"trib_cofins": "01",
"base_cofins": 312.77,
"perc_cofins": 3.0,
"base_ii": 0.0,
"perc_ii": 0.0,
"pedido": "",
"volumes": 0,
"ord_ped": 1,
"perc_dif": 0.0,
"valor_dif": 0.0,
"origem": "0",
"desconto": 0.0,
"val_fcp": 0.0,
"val_icms_remet": 0.0,
"val_icms_dest": 15.64,
"nota_cliente": "",
"valor_st_fcp": 0.0
}
]
}
]
Método responsável pela inclusão de faturas / notas fiscais.
Esse método não faz recálculo automático de totais e impostos. Todas informações necessárias para a autorização da nota fiscal devem ser informadas corretamente.
A obrigatoriedade de campos pode variar de acordo com questões fiscais e tributárias.
URL
POST http://{ip_cliente}/Fatura
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/Fatura?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codcli | string / 5 | Sim | Código do cliente |
| codrep | string / 5 | Não | Código do representante |
| dt_emissao | date | Não | Data de emissão |
| dt_saida | date | Não | Data de saída |
| transport | string / 4 | Não | Código da transportadora |
| redesp | string / 4 | Não | Código da transportadora redespacho |
| cif | string / 1 | Não | Modalidade de frete 1 = CIF 2 = FOB 3 = Terceiro 4 = Sem Frete 5 = Próprio (Rem.) 6 = Próprio (Dest.) |
| redesp_cif | string / 1 | Não | Modalidade redespacho 1 = CIF 2 = FOB 3 = Terceiro 4 = Sem Frete 5 = Próprio (Rem.) 6 = Próprio (Dest.) |
| natureza | string / 7 | Sim | Código da natureza de operação |
| valor | number / 11,2 | Não | Valor total da nota |
| base_calc | number / 11,2 | Não | Base de cálculo de ICMS |
| aliquota | number / 6,2 | Não | Alíquota de ICMS |
| val_icms | number / 11,2 | Não | Valor de ICMS |
| marca | string / 30 | Não | Descrição marca |
| volumes | Integer | Não | Volumes |
| pecas | number / 10,3 | Não | Quantidade de peças |
| nr_volumes | string / 20 | Não | Número de volumes |
| base_ipi | number / 11,2 | Não | Base de cálculo de IPI |
| val_ipi | number / 11,2 | Não | Valor IPI |
| pesol | number / 9,3 | Não | Peso líquido |
| pesob | number / 9,3 | Não | Peso bruto |
| mensagem | blob | Não | Dados adicionais |
| placa | string / 8 | Não | Número da placa |
| val_frete | number / 11,2 | Não | Valor do frete |
| val_seguro | number / 11,2 | Não | Valor do seguro |
| desconto | number / 11,2 | Não | Valor do desconto |
| despesas | number / 9,2 | Não | Valor das despesas |
| val_produtos | number / 11,2 | Não | Valor total dos produtos |
| val_pis | number / 11,2 | Não | Valor do PIS |
| val_cofins | number / 11,2 | Não | Valor do COFINS |
| val_import | number / 11,2 | Não | Valor de importação |
| val_subst | number / 11,2 | Não | Valor da substituição tributária |
| base_subst | number / 11,2 | Não | Base de cálculo substituição tributária |
| docto | string / 15 | Não | Número do documento |
| especie | string / 25 | Não | Espécie |
| val_fcp | number / 11,2 | Não | Valor FCP |
| val_icms_remet | number / 11,2 | Não | Valor ICMS remetente |
| val_icms_dest | number / 11,2 | Não | Valor ICMS destinatário |
| impresso | string / 1 | Não | N: Não impressa / transmitida S: Impressa / transmitida T: Transmitida em contingência A: Em transmissão automática C: Cancelada D: Denegada Caso não informado, será gravado como N (Não impressa / transmitida) |
| itens | objeto | Sim | Itens |
| codigo | string / 15 | Sim | Código do item |
| cor | string / 12 | Sim | Código da cor |
| tamanho | string / 4 | Sim | Código do tamanho |
| qtde | number / 9,3 | Sim | Quantidade |
| preco | number / 18,6 | Sim | Preço |
| valor | number / 11,2 | Sim | Valor |
| deposito | string / 6 | Não | Código do depósito |
| lote | string / 15 | Não | Número do lote |
| descricao | string / 100 | Sim | Descrição do item |
| data_mvto | date | Não | Data de movimentação |
| codsped | string / 3 | Não | Código SPED |
| unidade | string / 3 | Não | Unidade |
| natureza | string / 7 | Não | Código da natureza de operação |
| tipo_it | string / 1 | Sim | Tipo do item: P = Produto M = Material |
| empenho | string / 1 | Não | Empenho ( S / N ) |
| cla_fis | string / 3 | Não | Código da classificação fiscal |
| base_st | number / 11,2 | Não | Base de cálculo de substituição tributária |
| perc_red | number / 11,2 | Não | Percentual de redução da base de cálculo |
| perc_st | number / 9,4 | Não | Percentual de substituição tributária |
| valor_st | number / 11,2 | Não | Valor de substituição tributária |
| custo | number / 11,4 | Não | Valor de custo |
| chave_ref | string / 44 | Não | Chave referenciada |
| cla_trib | string / 3 | Não | Código da classificação tributária ICMS |
| base_icms | number / 9,2 | Não | Base de cálculo de ICMS |
| perc_icms | number / 5,2 | Não | Alíquota de ICMS |
| trib_ipi | string / 3 | Não | Código da classificação tributária IPI |
| base_ipi | number / 9,2 | Não | Base de cálculo de IPI |
| perc_ipi | number / 5,2 | Não | Alíquota IPI |
| trib_pis | string / 3 | Não | Código da classificação tributária PIS |
| base_pis | number / 9,2 | Não | Base de cálculo PIS |
| perc_pis | number / 9,4 | Não | Alíquota PIS |
| trib_cofins | string / 3 | Não | Código da classificação tributária COFINS |
| base_cofins | number / 9,2 | Não | Base de cálculo COFINS |
| perc_cofins | number / 9,4 | Não | Alíquota COFINS |
| base_ii | number / 9,2 | Não | Base de cálculo imposto de importação |
| perc_ii | number / 9,2 | Não | Alíquota imposto de importação |
| pedido | string / 12 | Não | Número do pedido |
| volumes | integer | Não | Quantidade de volumes |
| ord_ped | integer | Não | Ordem pedido |
| perc_dif | number / 5,2 | Não | Percentual diferimento de ICMS |
| valor_dif | number / 11,2 | Não | Valor diferimento de ICMS |
| origem | string / 2 | Não | Código da origem do item |
| desconto | number / 9,2 | Não | Valor de desconto |
| val_fcp | number / 11,2 | Não | Valor de FCP |
| val_icms_remet | number / 11,2 | Não | Valor de ICMS remetente |
| val_icms_dest | number / 11,2 | Não | Valor de ICMS destinatário |
| nota_cliente | string / 9 | Não | Número da NF cliente |
| valor_st_fcp | number / 11,2 | Não | Valor de substituição tributária FCP |
Incluir fatura de pedido
Método responsável por realizar o faturamento de um pedido.
Exemplo de retorno:
[
{
"resultado": "Pedido faturado com sucesso.",
"pedido": "12345",
"fatura": "112233",
"serie": "1"
}
]
URL
POST http://{ip_cliente}/Fatura/Pedido/:pedido
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o número do pedido informado como path param, exemplo:
POST http://{ip_cliente}Fatura/Pedido/12345?empresa=001
Onde "12345" representa o número do pedido.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pedido | string /path param | Sim | Número do pedido |
| empresa | string / 4 | Não | Número da empresa |
Financeiro
Consultar lista do financeiro
Método responsável por disponibilizar uma lista de duplicatas emitidas a partir de uma determinada data.
Exemplo de retorno OK:
http://{ip_cliente}/FinanceiroLista?cnpj=00.000.000/0000-00&emissao=01/01/2021
[
{
"cnpj": "00.000.000/0000-00",
"numero": "104082/1",
"fatura": "104082",
"pedido": "03901",
"nrbanco": "0000000",
"dt_emissao": "26/08/2021",
"dt_vencto": "14/12/2021",
"dt_pagto": "13/12/2021",
"valor": 1800.4,
"saldo": 0,
"url_pix": "",
"banco": "001",
"conta": "1234-5",
"carteira": "01",
"dt_status": "15/12/2021",
"situacao": "01",
"tipo": "N",
"val_dev": 0,
"valor_pago": 0,
"empresa": "_001",
"com1": 3,
"com2": 2,
"historico": "0001",
"codcli": "00001",
"nome": "CLIENTE EXEMPLO",
"classe": "000001"
},
{
"cnpj": "00.000.000/0000-00",
"numero": "104083/1",
"fatura": "104083",
"pedido": "03902",
"nrbanco": "1111111",
"dt_emissao": "26/08/2021",
"dt_vencto": "14/12/2021",
"dt_pagto": "14/12/2021",
"valor": 1674,
"saldo": 837,
"url_pix": "",
"banco": "001",
"conta": "1234-5",
"carteira": "01",
"dt_status":"15/12/2021",
"situacao": "01",
"tipo": "N",
"val_dev": 0,
"valor_pago": 0,
"empresa": "_001",
"com1": 5,
"com2": 0,
"historico": "0001",
"codcli": "00001",
"nome": "CLIENTE EXEMPLO",
"classe": "000001"
}
]
Consulta onde nenhuma duplicata foi encontrada:
http://{ip_cliente}/FinanceiroLista?cnpj=00.000.000/0000-00&emissao=01/01/2023
[
{
"method-error-400": "Não foi possível buscar financeiro: Nenhum registro encontrado"
}
]
Consulta onde será retornado erro:
http://{ip_cliente}/FinanceiroLista?cnpj=00.000.000/0000-00&emissao=01/15/2023
[
{
"method-error-400":"Erro ao processar a lista Financeiro: Erro TIQuery.Open:
[FireDAC][Phys][FB]Dynamic SQL Error SQL error code = -303
conversion error from string \"15/01/2023\""
}
]
URL
GET http://{ip_cliente}/FinanceiroLista
Retorno
A consulta irá considerar as duplicatas com data de emissão maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
O campo "situação" no body de retorno é um campo variável, ou seja, poderá variar o valor nele contido de acordo com o cadastrado no ERP e vinculado à duplicata.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/FinanceiroLista?cnpj=00.000.000/0000-00&emissao=01/01/2021
Caso seja necessário consultar através do CPF, deve-se utilizar o mesmo parâmetro cnpj, com o valor devidamente formatado para CPF.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente devidamente formatado, ou a raiz do CNPJ devidamente formatada. |
| emissao | date | Sim (Caso não informado pagamento, vencimento ou movimento) |
Data de Emissão. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| pagamento | date | Sim (Caso não informado emissao, vencimento ou movimento) |
Data de Pagamento. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| vencimento | date | Sim (Caso não informado emissao, pagamento ou movimento) |
Data de Vencimento. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| vencimento_fim | date | Não | Data de Vencimento. Data final da consulta. Utilizar o formato DD/MM/YYYY |
| movimento | data | Sim (Caso não informado emissao, pagamento ou vencimento) |
Data de Movimentação (Emissão, Pagamento ou Alteração). Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| situacao | string / 1 | Não | Situação dos títulos que estão em aberto ou liquidados Parâmetros de busca: 0 : Em aberto com o saldo maior a 0 1 : Liquidados com saldo igual a 0 |
| pedido | string / 12 | Não | Número do pedido vinculado a duplicata |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| tipo | string | Não (Caso não informado, a consulta será executada com os valores "N", "CD" e "CH") |
"N" - Duplicatas "A" - Antecipações "O" - Orçamentos "D" - Desdobradas "G" - Agrupadas "CH" - Cheques "CD" - Cheques Devolvidos "DV" - Devolução |
Consultar lista contas a pagar
Método responsável por disponibilizar uma listagem das autorizações de pagamento cadastradas no ERP. São retornados apenas AP's bloqueadas ou em análise.
Exemplo de retorno:
[
{
"num_ap": "06512",
"docto": "581547",
"classe": "0195",
"desc_classe": "Devolucao Mercadoria",
"codcre": "10993",
"nome": "FORNECEDOR EXEMPLO LTDA.",
"valor": 815.81,
"dt_ven": "02/05/2022",
"dt_emi": "02/05/2022",
"historico": "4",
"desc_historico": "DUPLICATA",
"obs": "",
"bloqueio": "N",
"dt_lan": "",
"val_pag": 0,
"val_dev": 0,
"desconto": 0,
"status": "N",
"banco": "001",
"nome_banco": "BANCO DO BRASIL S/A",
"dt_atual": "12/05/2022",
"empresa": "_001"
},
{
"num_ap": "08305",
"docto": "10469",
"classe": "0190",
"desc_classe": "Compra de matéria prima",
"codcre": "11429",
"nome": "FORNECEDOR EXEMPLO 2 LTDA.",
"valor": 6180,
"dt_ven": "12/05/2022",
"dt_emi": "12/05/2022",
"historico": "6",
"desc_historico": "CARTEIRA",
"obs": "",
"bloqueio": "N",
"dt_lan": "12/05/2022",
"val_pag": 50,
"val_dev": 0,
"desconto": 0,
"status": "N",
"banco": "001",
"nome_banco": "BANCO DO BRASIL S/A",
"dt_atual": "12/05/2022",
"empresa": "_001"
},
]
URL
GET http://{ip_cliente}/PagarLista
Retorno
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/PagarLista?empresa=001&emissao=01/01/2022
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| emissao | date | Sim | Data de emissão inicial da consulta |
| pagamento | date | Sim (Caso não informado parâmetro emissão) |
Data de pagamento inicial da consulta |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| bloqueio | string / 1 | Não | S - Bloqueada N - Liberada A - Em análise Se não informado, retornará as autorizações de pagamento bloqueadas e/ou em análise. |
| situacao | string / 1 | Não | Situação 0 - Em aberto com o saldo maior a 0 1 - Liquidados com saldo igual a 0 Se não informado, retornará as autorizações de pagamento em aberto. |
| status | string / 2 | Não | Tipo da autorização de pagamento N - Situação A - Antecipação O - Orçamento C - Cancelada D - Desdobrada G - Agrupada DV - Devolução |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Alterar status contas a pagar
Método responsável por alterar o status das autorizações de pagamento, entre: Em análise, Liberado, Bloqueado.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/StatusPagar?numero=003125&usuario=NOME_USUARIO
[
{
"resultado": "Status pagar alterado com sucesso",
"numero": "06512",
"bloqueio": "S"
}
]
Exemplo do corpo da requisição:
[
{
"bloqueio": "S"
}
]
URL
POST http://{ip_cliente}/StatusPagar
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/StatusPagar?numero=06512&empresa=001&usuario=NOME_USUARIO
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da autorização de pagamento |
| usuario | string / 20 | Sim | Nome do usuário que efetuará a alteração |
| empresa | string / 4 | Não | Número da empresa para alteração (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| bloqueio | string / 1 | Sim | Status da ordem de compra 'S' - Bloqueado 'N' - Liberado 'A' - Em análise |
Incluir contas a pagar
Método responsável por incluir contas a pagar
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "AP gravada com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"banco": "001",
"barra": "",
"codcre": "31553",
"data_orig": "20/03/2025",
"docto": "12345",
"dt_atual": "20/03/2025",
"dt_emi": "20/03/2025",
"dt_ven": "20/03/2025",
"historico": "8008",
"lancamento": "",
"nrbanco": "",
"num_os": "0167",
"obs": "Teste de observação",
"serie": "1",
"situacao": "11",
"status": "N",
"taxa": 0,
"val_nota": 100,
"val_pag": 0,
"valor": 100,
"valor_orig": 100
}
]
URL
POST http://{ip_cliente}/Pagar
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/Pagar?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| banco | string / 3 | Sim | Código do banco |
| barra | string / 50 | Não | Código de barras |
| codcre | string / 6 | Sim | Código do fornecedor |
| data_orig | date | Não | Data de vencimento original |
| docto | string / 15 | Sim | Número da nota fiscal |
| dt_atual | date | Não | Data de entrada |
| dt_emi | date | Sim | Data de emissão |
| dt_ven | date | Sim | Data de vencimento |
| historico | string / 4 | Sim | Código do histórico |
| lancamento | string / 7 | Não | Número do lançamento |
| nrbanco | string / 60 | Não | Número do banco / linha digitável |
| num_os | string / 6 | Sim | Código da classe gerencial |
| obs | string / 250 | Não | Observação |
| serie | string / 3 | Sim | Série da nota fiscal |
| situacao | string / 2 | Não | Código da situação |
| status | string / 2 | Sim | Tipo: N: Normal O: Orçamento DV: Devolução |
| taxa | number / 11,2 | Não | Taxa |
| val_nota | number / 11,2 | Sim | Valor da nota fiscal |
| val_pag | number / 11,2 | Não | Valor pago |
| valor | number / 11,2 | Sim | Valor da AP |
| valor_orig | number / 11,2 | Sim | Valor original da AP |
Emissão de boleto
Método responsável pela emissão de boletos.
Caso o boleto ainda não tenha número do banco (nosso número) faz a geração do mesmo.
Se o boleto já foi enviado para banco utiliza a conta e carteira de cobrança utilizadas no envio, caso contrário, permite informar uma conta e carteira, se não informado conta utiliza a conta marcada como padrão e a primeira carteira de cobrança disponível para esta conta.
Caso realizada a consulta com o parâmetro fatura ou pedido, se existir mais de uma duplicata será gerado um único arquivo com todos os boletos.
URL
GET http://{ip_cliente}/Boleto
Retorno
Content-Type: application/pdf
Em caso de sucesso será retornado status 200.
Em caso de erro, será retornado status 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/Boleto?numero=010001/1&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| fatura | string / 9 | Não * | Número da fatura / nota fiscal |
| numero | string / 12 | Não * | Número da duplicata + parcela |
| pedido | string / 12 | Não * | Número do pedido |
| conta | string / 13 | Não | Número da conta corrente de cobrança |
| carteira | string / 3 | Não | Código da carteira de cobrança |
| enviar_email | string / 1 | Não | S - Envia e-mail do boleto para os endereços pré-cadastrados N - Não envia boleto |
| usuario | string / 20 | Sim (Caso enviar_email = "S") |
Código ou nome do usuário Obrigatório para o envio do e-mail. |
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
*Obrigatório informar um dos 3 parâmetros fatura, ou numero ou pedido.
Incluir duplicata
Exemplo de retorno:
[
{
"resultado": "Duplicata incluída com sucesso.",
"duplicata": "000001"
}
]
Exemplo do corpo da requisição:
[
{
"numero": "00001",
"codcli": "00001",
"fatura": "99887",
"valor2": 500.5,
"valor": 1001,
"dt_vencto": "01/01/2024",
"dt_emissao": "01/01/2024",
"quant": 1,
"pesol": 1.5,
"pesob": 1.8,
"historico": "0001",
"classe": "1020",
"banco": "001",
"situacao": "10",
"codrep": "0001",
"com1": 1.5,
"com2": 1.7,
"codrep2": "0002",
"com3": 1,
"com4": 1,
"val_ipi": 2.2,
"frete": 2.9,
"despesas": 3.4,
"val_subst": 1.1,
"pedido": "99887",
"taxa": 1,
"dt_previsao": "01/01/2024",
"obs": "Observação exemplo",
"nrbanco": "123456"
}
]
Método responsável pela inclusão de duplicatas.
URL
POST http://{ip_cliente}/Receber
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/Receber?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 12 | Não | Número da duplicata (Caso não informado será gerado automaticamente) |
| codcli | string / 5 | Não | Código do cliente |
| fatura | string / 9 | Não | Número da fatura |
| valor2 | number / 11,2 | Sim | Valor da duplicata |
| valor | number / 11,2 | Sim | Valor da fatura |
| dt_vencto | date | Sim | Data de vencimento |
| dt_emissao | date | Sim | Data de emissão |
| quant | number / 11,2 | Não | Quantidade |
| pesol | number / 9,2 | Não | Peso líquido |
| pesob | number / 9,2 | Não | Peso bruto |
| historico | string / 4 | Não | Código do histórico |
| classe | string / 6 | Não | Código da classe gerencial |
| banco | string / 3 | Não | Código do banco |
| situacao | string / 2 | Não | Código da situação |
| codrep | string / 5 | Não | Código do representante |
| com1 | number / 5,2 | Não | Percentual de comissão faturamento |
| com2 | number / 5,2 | Não | Percentual de comissão recebimento |
| codrep2 | string / 5 | Não | Código do representante preposto |
| com3 | number / 5,2 | Não | Percentual de comissão faturamento preposto |
| com4 | number / 5,2 | Não | Percentual de comissão recebimento preposto |
| val_ipi | number / 11,2 | Não | Valor de IPI |
| frete | number / 11,2 | Não | Valor de frete |
| despesas | number / 11,2 | Não | Valor de despesas |
| val_subst/RastreioFatura | number / 9,2 | Não | Valor de substituição tributária |
| pedido | string / 12 | Não | Número do pedido |
| taxa | number / 5,2 | Não | Percentual de taxa |
| dt_previsao | date | Sim | Data de previsão de recebimento |
| obs | string / 250 | Não | Observação |
| nrbanco | string / 20 | Não | Número do banco / nosso número |
Baixar duplicata
Exemplo de retorno:
[
{
"resultado": "Duplicata baixada com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"historico": "0001",
"data_pagamento": "01/01/2025",
"data_cont": "01/01/2025",
"valor_acrescimo": 10.99,
"despesa_antecip": 5.0,
"desconto_contr": 12.0,
"valor_desconto": 10.25,
"valor_devol": 14.11,
"quant_devol": 1,
"lanca_baixa_juros": 15.15,
"variacao_cambial": 1.01,
"documento": "0001",
"valor_pago": 1000.57,
"conta_corrente": "000001",
"obs": "Observação exemplo."
}
]
Método responsável por baixar uma duplicata.
URL
PATCH http://{ip_cliente}/Receber/Baixa/:numero
Parâmetros
Os parâmetros devem ser passados no link da requisição, sendo o número informado como path param.
PATCH http://{ip_cliente}/Receber/Baixa/123456?empresa=001
Onde "123456" representa o número da duplicata.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número da duplicata |
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| historico | string / 4 | Sim | Código do histórico |
| data_pagamento | date | Não * | Data do pagamento |
| data_cont | date | Não * | Data da contabilização |
| valor_acrescimo | number / 11,2 | Não | Valor de acréscimo |
| despesa_antecip | number / 11,2 | Não | Valor de despesa antecipação |
| desconto_contr | number / 11,2 | Não | Valor de desconto contratual |
| valor_desconto | number / 11,2 | Não | Valor de desconto |
| valor_devol | number / 11,2 | Não | Valor devolvido |
| quant_devol | number / 11,2 | Não | Quantidade devolvida |
| lanca_baixa_juros | number / 11,2 | Não | Valor para baixa de juros |
| variacao_cambial | number / 11,2 | Não | Valor de variação cambial |
| valor_pago | number / 11,2 | Sim | Valor pago |
| documento | string / 15 | Não | Número do documento |
| conta_corrente | string / 13 | Sim | Número da conta corrente |
| obs | string / 100 | Não | Observação da baixa |
*Caso não informado será gravada com a data do dia atual.
Produto
Incluir ou alterar produto
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Produto cadastrado com sucesso.",
"produto": "21234"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Não foi possível processar produto: Grupo iválido."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "10000",
"cor": ["001", "002", "003"],
"grupo": "001",
"colecao": "01",
"faixa": "01",
"familia": "00001",
"etiqueta": "10",
"marca": "01",
"linha": "01",
"descricao": "DESCRICAO PRODUTO",
"descricao2": "DESCRICAO PRODUTO 2",
"preco": 1.2,
"custo": 0.88,
"obs": "Observação produto",
"obs1": "Obs 1 produto",
"obs2": "Obs 2 produto",
"obs3": "Obs 3 produto",
"estilista": "João",
"modelista": "Maria",
"status": "LIBERADO P/ PRODUÇÃO",
"peso": 0.7,
"peso_talhado": 0.6,
"gramatura": 0,
"largura": 0,
"compri": 0,
"espessura": 0,
"densidade": 0,
"ativo": "S",
"unidade": "PC",
"codfis": "001",
"codsped": "001",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"produto_ecom": {
"titulo": "TITULO EXEMPLO",
"desc_detalhada": "DESCRIÇÃO EXEMPLO",
"modelagem": "MODELAGEM EXEMPLO",
"detalhe": "DETALHE EXEMPLO",
"genero_medida": "GENERO1",
"genero_market": "GENERO2",
"palavra_chave": "TESTE; EXEMPLO;",
"marca": "EXEMPLO",
"descricao": "DESCRIÇÃO EXEMPLO",
"integra_market": "S",
"clas1": "00001",
"id_ecom": "123456"
}
}
]
Método responsável pela inclusão ou alteração de produtos.
A alteração de um produto se dará pelo mesmo método de inclusão, caso o campo código for informado e já existir no banco de dados.
URL
POST http://{ip_cliente}/Produto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Não | Código do produto ** |
| cor | array / string | Sim | Array de string com as cores do produto |
| grupo | string / 3 | Sim | Código do grupo |
| colecao | string / 4 | Sim * | Código da coleção |
| faixa | string / 2 | Sim | Código da faixa de tamanho |
| familia | string / 5 | Sim * | Código da família |
| etiqueta | string / 4 | Sim * | Código da etiqueta |
| marca | string / 4 | Sim * | Código da marca |
| linha | string / 5 | Sim * | Código da linha |
| descricao | string / 100 | Não | Descrição do produto |
| descricao2 | string / 100 | Não | Descrição 2 / complemento |
| preco | number / 12,5 | Não | Preço |
| custo | number / 11,4 | Não | Custo |
| obs | blob | Não | Observação |
| obs1 | blob | Não | Observação 1 |
| obs2 | blob | Não | Observação 2 |
| obs3 | blob | Não | Observação 3 |
| estilista | string / 30 | Não | Nome do(a) estilista |
| modelista | string / 30 | Não | Nome do(a) modelista |
| status | string / 30 | Sim | Descrição do status do produto |
| peso | number / 9,4 | Não | Peso |
| peso_talhado | number / 9,4 | Não | Peso líquido |
| gramatura | number / 7,3 | Não | Gramatura |
| largura | number / 6,2 | Não | Largura |
| compri | number / 7,2 | Não | Comprimento |
| espessura | number / 7,2 | Não | Espessura |
| densidade | number / 7,2 | Não | Densidade |
| ativo | string / 1 | Não | Situação do produto S - Ativo N - Inativo |
| unidade | string / 3 | Sim | Unidade do produto |
| codfis | string / 3 | Sim | Código da classificação fiscal |
| codsped | string / 3 | Sim | Código Sped |
| codigo2 | string / 25 | Não | Código 2 / Referência do produto |
| codtrib | string / 3 | Não | Código da situação tributária de ICMS |
| trib_ipi | string / 3 | Não | Código da situação tributária de IPI |
| origem | string / 2 | Não | Origem do produto |
| produto_ecom | objeto | Não | Dados E-Commerce |
| descricao | string / 250 | Não | Descrição do produto |
| desc_detalhada | blob | Não | Descrição detalhada e/ou HTML |
| detalhe | string / 100 | Não | Detalhe |
| genero_market | string / 15 | Não | Gênero marketplace |
| genero_medida | string / 15 | Não | Gênero medidas |
| id_ecom | string / 15 | Não | Referência |
| integra_market | string / 1 | Não | S: Integrar ao marketplace N: Não integrar ao marketplace |
| marca | string / 100 | Não | Marca do produto |
| modelagem | string / 100 | Não | Modelagem do produto |
| palavra_chave | string / 200 | Não | Lista de palavras chave |
| titulo | string / 200 | Não | Título do produto |
| clas1 | string / 5 | Não | Classificação 1 |
*Campos obrigatórios a depender da parametrização do ERP.
** Caso não informado, o código do produto será formado de acordo com a parametrização do ERP.
Atributos alteráveis
Caso informado, no corpo da requisição, o atributo codigo, e o mesmo existir na base de dados, é possível alterar alguns parâmetros do produto.
No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos não informados serão ignorados na alteração. Atributos informados com valor vazio serão alterados para vazio.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 100 | Não | Descrição do produto |
| obs | blob | Não | Observação |
| obs1 | blob | Não | Observação 1 |
| obs2 | blob | Não | Observação 2 |
| obs3 | blob | Não | Observação 3 |
| estilista | string / 30 | Não | Nome do(a) estilista |
| modelista | string / 30 | Não | Nome do(a) modelista |
| status | string / 30 | Não | Descrição do status do produto |
| preco | number / 12,5 | Não | Preço |
| custo | number / 11,4 | Não | Custo |
| peso | number / 9,4 | Não | Peso médio |
| peso_talhado | number / 9,4 | Não | Peso líquido |
| grupo | string / 3 | Não | Código do grupo |
| familia | string / 5 | Não | Código da família |
| etiqueta | string / 4 | Não | Código da etiqueta |
| marca | string / 4 | Não | Código da marca |
| linha | string / 5 | Não | Código da linha |
| ativo | string / 1 | Não | Situação do produto S - Ativo N - Inativo |
| unidade | string / 3 | Não | Unidade do produto |
| codfis | string / 3 | Não | Código da classificação fiscal |
| codsped | string / 3 | Não | Código Sped |
| codigo2 | string / 25 | Não | Código 2 / Referência do produto |
| colecao | string / 4 | Não | Código da coleção |
| gramatura | number / 7,3 | Não | Gramatura |
| largura | number / 6,2 | Não | Largura |
| compri | number / 7,2 | Não | Comprimento |
| espessura | number / 7,2 | Não | Espessura |
| densidade | number / 7,2 | Não | Densidade |
| faixa | string / 2 | Não | Código da faixa de tamanho * |
| cor | array / string | Não | Array de string com as cores do produto ** |
| codtrib | string / 3 | Não | Código da situação tributária de ICMS |
| trib_ipi | string / 3 | Não | Código da situação tributária de IPI |
| origem | string / 2 | Não | Origem do produto |
| produto_ecom | objeto | Não | Dados E-Commerce *** |
| descricao | string / 250 | Não | Descrição do produto |
| desc_detalhada | blob | Não | Descrição detalhada e/ou HTML |
| detalhe | string / 100 | Não | Detalhe |
| genero_market | string / 15 | Não | Gênero marketplace |
| genero_medida | string / 15 | Não | Gênero medidas |
| id_ecom | string / 15 | Não | Referência |
| integra_market | string / 1 | Não | S: Integrar ao marketplace N: Não integrar ao marketplace |
| marca | string / 100 | Não | Marca do produto |
| modelagem | string / 100 | Não | Modelagem do produto |
| palavra_chave | string / 200 | Não | Lista de palavras chave |
| titulo | string / 200 | Não | Título do produto |
| clas1 | string / 5 | Não | Classificação 1 |
*Se o produto já possuir movimentações (pedidos, ordens de produção, cadastro de medidas, estoque, etc) não será possível trocar para uma faixa que remova tamanhos, apenas uma que adicione.
**Se informado o array "cores", as cores já existentes no EXCIA sem movimentação serão removidas, e as cores informadas na requisição serão inseridas.
*** Se informado o objeto "produto_ecom" todos os dados de e-commerce deste produto existentes serão substituídos pelos dados informados na requisição.
Consultar estoque
Método para consultar o estoque de um determinado produto.
O saldo em estoque é composto pela quantidade disponível em estoque subraíndo a somatória dos itens pendentes em pedidos liberados.
Consulta com retorno OK:
http://{ip_cliente}/ProdutoEstoque?codigo=123456&cor=042&colecao=001;002
[
{
"barra": "",
"cor": "042",
"desc_cor": "AZUL",
"tam": "P",
"estoque": 50,
"grade_v": 0,
"grade_v1": 0,
"grade_v2": 0,
"barracli": "12345604P",
"producao": 3,
"qtde_min": 2,
"saldo_estoque": 50
},
{
"barra": "",
"cor": "042",
"desc_cor": "AZUL",
"tam": "M",
"estoque": 63,
"grade_v": 0,
"grade_v1": 0,
"grade_v2": 0,
"barracli": "12345604M",
"producao": 0,
"qtde_min": 0,
"saldo_estoque": 60
},
{
"barra": "",
"cor": "042",
"desc_cor": "AZUL",
"tam": "G",
"estoque": 10,
"grade_v": 0,
"grade_v1": 0,
"grade_v2": 0,
"barracli": "12345604G",
"producao": 5,
"qtde_min": 5,
"saldo_estoque": 0
}
]
Consulta onde nenhum registro do item foi encontrado:
http://{ip_cliente}/ProdutoEstoque?codigo=999999
[
{
"method-error-400": "Não foi possível processar a busca do estoque: Nenhum item encontrado."
}
]
URL
GET http://{ip_cliente}/ProdutoEstoque
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo, para consultar o estoque de uma determinada cor de um produto, considerando apenas pedidos com as coleções 001 e 002, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/ProdutoEstoque?codigo=123456&cor=042&colecao=001;002
Os parâmetros que forem informados com a nomenclatura diferente da informada na tabela abaixo serão ignorados na consulta.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do item |
| cor | string / 6 | Não | Código da cor |
| tamanho | string / 4 | Não | Tamanho do item |
| deposito | string / 4 | Não | Código do depósito |
| colecao | string / 4 | Não | Coleção do pedido |
Consultar estoque detalhado
Esta é uma alternativa para consulta de estoque detalhado, podendo visualizar as quantidades disponíveis por código, cor, tamanho, depósito e lote.
Estoque detalhado, exemplo de retorno:
[
{
"codigo": "12345678",
"codigo2": "ABC123",
"descricao": "PRODUTO EXEMPLO 1",
"cor": "000123",
"desc_cor": "PRETO",
"tam": "P",
"deposito": "0001",
"desc_deposito": "DEPOSITO PADRAO",
"lote": "123456",
"barra": "0000000000000",
"barracli": "123456",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"qtde_min": 0.0,
"quantidade": 32.0
},
{
"codigo": "12345678",
"codigo2": "ABC123",
"descricao": "PRODUTO EXEMPLO 1",
"cor": "000123",
"desc_cor": "PRETO",
"tam": "M",
"deposito": "0002",
"desc_deposito": "DEPOSITO 2",
"lote": "654321",
"barra": "0000000000000",
"barracli": "123456",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"qtde_min": 0.0,
"quantidade": 50.0
},
{
"codigo": "87654321",
"codigo2": "ABC321",
"descricao": "PRODUTO EXEMPLO 2",
"cor": "001123",
"desc_cor": "BRANCO",
"tam": "P",
"deposito": "0001",
"desc_deposito": "DEPOSITO PADRAO",
"lote": "001954054",
"barra": "1020304050607",
"barracli": "103056",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"qtde_min": 0.0,
"quantidade": 30.0
}
]
URL
GET http://{ip_cliente}/Estoque
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/Estoque?empresa=001&codigo=001003001&cor=00123
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Não | Código do produto |
| codigo2 | string / 25 | Não | Código 2 / referência |
| cor | string / 6 | Não | Código da cor |
| tam | string / 4 | Não | Tamanho do produto |
| deposito | string / 4 | Não | Código do depósito |
| lote | string / 15 | Não | Número do lote |
| barra | string / 13 | Não | Código de barras |
| estoque | string / 1 | Não | 0 - Todos 1 - Com quantidade em estoque 2 - Sem quantidade em estoque |
| cor_ativa | string / 1 | Não | S - Apenas cores ativas N - Apenas cores inativas |
| dt_mov | timestamp | Não | Filtra apenas itens que tiverem movimentação após a data / hora informados Utilizar o formato DD/MM/YYYY HH:MM:SS |
| pagina | number | Não | Número da página |
| offset | number | Não | Quantidade de registros por página. Caso não informado, serão retornados 300 registros |
Consultar produto
Método responsável por disponibilizar os dados detalhados de um produto.
Exemplo de retorno:
[
{
"data_cad": "01/01/2024",
"codigo": "00112233",
"descricao": "PRODUTO EXEMPLO",
"codigo2": "998877",
"etiqueta": "10",
"unidade": "UN",
"grupo": "001",
"linha": "00001",
"familia": "001",
"status": "LIBERADO PARA PRODUÇÃO",
"ativo": "S",
"colecao": "01",
"dt_altera": "01/01/2024",
"fornecedor": "00001",
"largura": 0,
"compri": 0,
"espessura": 0,
"peso": 0,
"estilista": "ESTILISTA EXEMPLO",
"modelista": "MODELISTA EXEMPLO",
"marca": "01",
"codfis": "01",
"codsped": "01",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"minimo": 0,
"quant": 0,
"faixa": "00",
"custo": 10.1,
"preco_tabela": 59.9,
"dt_altera": "01/01/2026 15:58:27",
"cor": [
{
"cor": "001",
"ativo": "S"
},
{
"cor": "002",
"ativo": "N"
}
],
"tam": [
{
"tam": "P"
},
{
"tam": "M"
},
{
"tam": "G"
}
],
"produto_ecom": {
"titulo": "Título exemplo",
"desc_detalhada": "<p style='margin-left:40px;'>Lorem ipsum dolor sit amet consectetur adipisicing elit. <strong>Quidem voluptate doloribus dolores consequatur illo ea nihil</strong>, ab vitae eius voluptatibus sint quod facilis rem nisi deleniti fugit tenetur alias tempore.</p>",
"modelagem": "Modelagem exemplo",
"detalhe": "Detalhe exemplo",
"genero_medida": "12",
"genero_market": "10",
"palavra_chave": "Palavra; Chave; Exemplo;",
"marca": "Marca Exemplo",
"descricao": "Descrição exemplo",
"integra_market": "S",
"clas1": "00001"
}
}
]
URL
GET http://{ip_cliente}/Produto/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Produto/12345?empresa=001
Onde "12345" representa o código do produto.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string /path param | Sim | Código do produto. |
| tab_pre | string / 5 | Não | Código da tabela de preços |
| empresa | string / 4 | Não | Número da empresa |
Consultar lista de produtos
Método responsável por disponibilizar uma lista de produtos atualizados a partir de uma determinada data.
Exemplo de retorno com os dados dos produtos:
[
{
"data_cad": "01/01/2023",
"codigo": "12411",
"descricao": "PRODUTO EXEMPLO 1",
"codigo2": "",
"etiqueta": "001",
"unidade": "PC",
"titulo_ecommerce": "",
"descricao_ecommerce": "",
"grupo": "001",
"familia": "00001",
"linha": "00001",
"status": "LIBERADO PARA PRODUÇÃO",
"ativo": "S",
"colecao": "01",
"dt_altera": "01/06/2023",
"fornecedor": "00003",
"largura": 1,
"compri": 1,
"espessura": 1,
"peso": 0.16,
"estilista": "NOME ESTILISTA",
"modelista": "NOME MODELISTA",
"marca": "01",
"codfis": "100",
"codsped": "01",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"minimo": 0,
"custo": 10.1,
"preco_tabela": 89.75,
"dt_altera": "01/01/2026 15:58:27",
},
{
"data_cad": "27/01/2023",
"codigo": "12412",
"descricao": "PRODUTO EXEMPLO 2",
"codigo2": "",
"etiqueta": "002",
"unidade": "PC",
"titulo_ecommerce": "",
"descricao_ecommerce": "",
"grupo": "002",
"familia": "00002",
"linha": "00002",
"status": "LIBERADO PARA PRODUÇÃO",
"ativo": "S",
"colecao": "02",
"dt_altera": "01/06/2023",
"fornecedor": "00001",
"largura": 1,
"compri": 1,
"espessura": 1,
"peso": 0.16,
"estilista": "NOME ESTILISTA",
"modelista": "NOME MODELISTA",
"marca": "01",
"codfis": "100",
"codsped": "01",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"minimo": 0,
"custo": 8.2,
"preco_tabela": 79.9,
"dt_altera": "01/01/2026 15:59:10",
}
]
Consulta onde nenhum produto foi encontrado:
http://{ip_cliente}/Produto?data=01/10/2023
[
{
"method-error-400": "Não foi possível buscar produto: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/Produto
Retorno
A consulta irá considerar os produtos com a data de alteração maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Produto?data=07/01/2021 12:05:10
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data / Hora inicial da consulta. Utilizar o formato DD/MM/YYYY HH:MM:SS |
| codigo | string / 15 | Não | Código do produto. |
| colecao | string / 4 | Não | Código da coleção do produto. Separar por ";" quando informado mais de um valor |
| tab_pre | string / 5 | Não | Código da tabela de preços |
| descricao | string / 100 | Não | Descrição do produto |
| ativo | string / 1 | Não | S: Produto ativo N: Produto inativo |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Consultar lista de produtos (com cor e tamanho)
Método responsável por disponibilizar uma lista de produtos, com cores e tamanhos.
Exemplo de retorno com os dados dos produtos:
[
{
"data_cad": "25/08/2021",
"codigo": "1.2411",
"descricao": "BLUSA",
"codigo2": "",
"etiqueta": "001",
"unidade": "PC",
"titulo_ecommerce": "",
"descricao_ecommerce": "",
"grupo": "001",
"familia": "00001",
"linha": "00001",
"status": "LIBERADO PARA PRODUÇÃO",
"ativo": "S",
"colecao": "01",
"dt_altera": "22/11/2021",
"fornecedor": "00003",
"largura": 1,
"compri": 1,
"espessura": 1,
"peso": 0.16,
"estilista": "JOÃO",
"modelista": "MARIA",
"marca": "01",
"codfis": "100",
"codsped": "01",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"minimo": 0,
"custo": 10.1,
"preco_tabela": 79.9,
"dt_altera": "01/01/2026 15:58:27",
"cor": ["001","042","043"],
"cor_ativa": ["S","N","S"],
"tam": ["PP","P","M","G","GG"]
},
{
"data_cad": "25/08/2021",
"codigo": "1.2412",
"descricao": "REGATA",
"codigo2": "",
"etiqueta": "002",
"unidade": "PC",
"titulo_ecommerce": "",
"descricao_ecommerce": "",
"grupo": "002",
"familia": "00002",
"linha": "00002",
"status": "LIBERADO PARA PRODUÇÃO",
"ativo": "S",
"colecao": "02",
"dt_altera": "22/11/2021",
"fornecedor": "00001",
"largura": 1,
"compri": 1,
"espessura": 1,
"peso": 0.16,
"estilista": "JOÃO",
"modelista": "MARIA",
"marca": "01",
"codfis": "100",
"codsped": "01",
"codtrib": "001",
"trib_ipi": "001",
"origem": "0",
"minimo": 100,
"custo": 10.1,
"preco_tabela": 89.9,
"dt_altera": "01/01/2026 15:58:27",
"cor": ["001","042"],
"cor_ativa": ["N","S"],
"tam": ["PP","P","M","G","GG"]
}
]
Consulta onde nenhum produto foi encontrado:
http://{ip_cliente}/ProdutoLista?data=01/10/2023
[
{
"method-error-400": "Não foi possível buscar produto: Nenhum registro encontrado."
}
]
Consulta onde será retornado erro:
http://{ip_cliente}/ProdutoLista?data=01/15/2023
[
{
"method-error-400":"Não foi possível buscar produto: Erro TIQuery.Open:[FireDAC][Phys][FB]Dynamic SQL Error SQL error code = -303 conversion error from string \"15/01/2023\""
}
]
URL
GET http://{ip_cliente}/ProdutoLista
Retorno
A consulta irá considerar os produtos com a data de alteração maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/ProdutoLista?data=07/01/2021 10:12:01
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data / Hora inicial da consulta. Utilizar o formato DD/MM/YYYY HH:MM:SS |
| codigo | string / 15 | Não | Código do produto. Separar por ";" quando informado mais de um valor |
| colecao | string / 4 | Não | Código da coleção do produto. Separar por ";" quando informado mais de um valor |
| tab_pre | string / 5 | Não | Código da tabela de preços |
| descricao | string / 100 | Não | Descrição do produto |
| ativo | string / 1 | Não | S: Produto ativo N: Produto inativo |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Incluir ou alterar preço
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Preço cadastrado com sucesso"
}
]
Exemplo do corpo da requisição:
[
{
"regiao": "001",
"tipo": "P",
"codigo": "ABC1234",
"desc_produto": "PRODUTO EXEMPLO",
"grupo_cor": "00",
"faixa_preco": "00",
"preco_00": 90.89,
"qtde_min": 0
}
]
Método responsável pela inclusão ou alteração de preço.
A alteração de preço se dará pelo mesmo método de inclusão, caso os campos região e código informados já existirem no banco de dados.
URL
POST http://{ip_cliente}/Preco
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| regiao | string / 5 | Sim | Código da tabela de preços |
| descricao | string / 100 | Não ¹ | Descrição da tabela de preços |
| tipo | string / 1 | Não ¹ | Tipo do item P: Produto M: Material |
| codigo | string / 15 | Sim | Código do produto / material |
| desc_produto | string / 100 | Não ¹ | Descrição do produto / material |
| grupo_cor | string / 2 | Não ¹ | Código do grupo de cor |
| faixa_preco | string / 2 | Não ¹ | Código da faixa de preços |
| preco_00 | number / 12,5 | Sim | Preço |
| qtde_min | number / 9,4 | Não | Quantidade mínima |
¹ Campos não obrigatórios, caso não informados no corpo da requisição, serão preenchidos com valores padrão a depender da parametrização do ERP.
Atributos alteráveis
Caso informado, no corpo da requisição, os atributos codigo e regiao, e os mesmos existirem na base de dados, é possível alterar alguns parâmetros do cadastro de preço.
No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos não informados serão ignorados na alteração. Atributos informados com valor vazio serão alterados para vazio.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 100 | Não | Descrição da tabela de preços |
| tipo | string / 1 | Não | Tipo do item P: Produto M: Material |
| desc_produto | string / 100 | Não | Descrição do produto / material |
| grupo_cor | string / 2 | Não | Código do grupo de cor |
| faixa_preco | string / 2 | Não | Código da faixa de preços |
| preco_00 | number / 12,5 | Não | Preço |
| qtde_min | number / 9,4 | Não | Quantidade mínima |
Consultar preço
Método responsável por disponibilizar o preço dos produtos.
Exemplo de retorno:
[
{
"codigo": "001",
"descricao": "REGIAO 001",
"produto": "000001",
"desc_produto": "PRODUTO 1",
"preco_00": 10,
"ult_preco": 30.99
},
{
"codigo": "001",
"descricao": "REGIAO 001",
"produto": "000002",
"desc_produto": "PRODUTO 2",
"preco_00": 20.99,
"ult_preco": 22.99
},
{
"codigo": "001",
"descricao": "REGIAO 001",
"produto": "000003",
"desc_produto": "PRODUTO 3",
"preco_00": 30.99,
"ult_preco": 30.99
}
]
URL
GET http://{ip_cliente}/BuscarPreco
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
Para consultar o preço dos produtos de uma determinada tabela de preço, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/BuscarPreco?codigo=001
Para consultar o preço de todas as tabelas que o produto estiver cadastrado, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/BuscarPreco?produto=000003
Os parâmetros que forem informados com a nomenclatura diferente da informada na tabela abaixo serão ignorados na consulta.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 5 | Não | Código da tabela de preço. Separar por ";" quando informado mais de um valor |
| produto | string / 15 | Não | Código do produto |
| desc_produto | string / 100 | Não | Descrição do produto |
Consultar imagem
Método responsável por disponibilizar as imagens de um determinado produto.
Exemplo de retorno com as imagens do produto:
http://{ip_cliente}/CarregaImagemProduto?codigo=123456&tipo_item=P
[
{
"codigo": "123456",
"imagens": [
{
"imagem": "/9j/4AAQSkZJRgABAQAAAQABAAD/DFSFASDFAS...",
"arquivo": "123456-0001.jpg"
},
{
"imagem": "/9j/4AAQSkZJRgABAQAAAQABAAD/ASDGDFHSGH...",
"arquivo": "123456-0002.jpg"
},
{
"imagem": "/9j/4AAQSkZJRgABAQAAAQABAAD/GFHFGHFGSDFG...",
"arquivo": "123456-0003.jpg"
},
{
"imagem": "/9j/4AAQSkZJRgABAQAAAQABAAD/HSGHDHHJDFGHSFGH..."
"arquivo": "123456-0004.jpg",
},
{
"imagem": "/9j/4AAQSkZJRgABAQAAAQABAAD/AWEFASDFSDF..."
"arquivo": "123456-0005.jpg"
}
]
}
]
Consulta onde a imagem não foi encontrada:
http://{ip_cliente}/CarregaImagemProduto?codigo=654321&tipo_item=P
[
{
"codigo": "654321",
"imagens": [
{
"imagem": null,
"arquivo": null
}
]
}
]
URL
GET http://{ip_cliente}/CarregaImagemProduto
Retorno
As imagens serão retornadas em Base64 no objeto "imagens" do json.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/CarregaImagemProduto?codigo=123456&tipo_item=P
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| tipo_item | string / 1 | Sim | Informar P |
| img_padrao | string / 1 | Não | Se informado o valor "S", será retornada apenas a imagem padrão do produto. Se informa qualquer outro valor, ou não informar o parâmetro, serão retornadas todas as imagens do produto. |
Incluir parte
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Parte cadastrada com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "ABC123",
"parte": "00",
"fluxo": "01",
"padrao": "S",
"parte_ref": "01",
"setor_ref": "10"
},
{
"codigo": "ABC123",
"parte": "01",
"fluxo": "01",
"padrao": "N",
"parte_ref": "",
"setor_ref": ""
}
]
Método responsável pela inclusão de partes no produto.
URL
POST http://{ip_cliente}/ParteProduto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| parte | string / 2 | Sim | Código da parte |
| fluxo | number / 3 | Sim | Código do fluxo produtivo |
| padrao | string / 1 | Sim | S - Parte padrão N - Demais partes |
| parte_ref | string / 2 | Não | Código da parte de referência |
| setor_ref | string / 4 | Não | Código do setor de referência |
Consultar lista de partes
Método responsável por listar todas as partes de produtos cadastradas.
Exemplo de retorno:
http://{ip_cliente}/ParteProdutoLista
[
{
"codigo": "ABC123",
"parte": "00",
"descricao": "SUPERIOR",
"fluxo": "12",
"principal": "S",
"estoque": "S"
},
{
"codigo": "CBA321",
"parte": "01",
"descricao": "INFERIOR",
"fluxo": "03",
"principal": "N",
"estoque": "N"
}
]
URL
GET http://{ip_cliente}/ParteProdutoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/ParteProdutoLista?codigo=123456
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Não | Código do produto |
Consultar lista de status de produto
Método responsável por disponibilizar uma listagem do cadastro de status de produto.
Exemplo de retorno:
http://{ip_cliente}/StatusLista
[
{
"codigo": "01",
"descricao": "DESENVOLVIMENTO",
"bloq_prod": "N",
"bloq_of": "S"
},
{
"codigo": "03",
"descricao": "LIBERADO P/ PRODUÇÃO",
"bloq_prod": "N",
"bloq_of": "N"
}
]
URL
GET http://{ip_cliente}/StatusLista
Retorno
A consulta irá retornar todos os dados de todos os status cadastrados no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Incluir ficha técnica
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Ficha técnica cadastrada com sucesso.",
"insumos": [
{
"consumo": 0.062,
"aplicacao": "01",
"faixa": "0",
"preco": "S",
"tipo": "M",
"posicao": "",
"codigo": "20000",
"codigo2": "",
"insumo": "0010110001",
"id": 6,
"parte": "02",
"setor": "03",
"deposito": ""
},
{
"consumo": 0.046,
"aplicacao": "12",
"faixa": "0",
"preco": "N",
"tipo": "M",
"posicao": "",
"codigo": "20000",
"codigo2": "",
"insumo": "090000017",
"id": 7,
"parte": "02",
"setor": "10",
"deposito": ""
}
]
}
]
Exemplos onde insumo ou produto não são válidos:
[
{
"method-error-400": "Não foi possível processar ficha técnica: Insumo inválido: 0040070001."
}
]
[
{
"method-error-400": "Não foi possível processar ficha técnica: Codigo / Produto inválido."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "20000",
"insumo": "0010110001",
"consumo": 0.062,
"parte": "02",
"aplicacao": "01",
"faixa": "0",
"preco": "S",
"tipo": "M",
"setor": "03",
"cor": [
{
"cor": "00357",
"cor_i": "00066"
},
{
"cor": "30539",
"cor_i": "00357"
}
]
},
{
"codigo": "20000",
"insumo": "080140017",
"consumo": 0.046,
"parte": "02",
"aplicacao": "12",
"faixa": "0",
"preco": "N",
"tipo": "M",
"setor": "10",
"cor": [
{
"cor": "00357",
"cor_i": "00066"
},
{
"cor": "30539",
"cor_i": "00357"
}
]
},
{
"codigo": "20000",
"insumo": "0040070001",
"consumo": 1.1,
"parte": "02",
"aplicacao": "12",
"faixa": "0",
"preco": "N",
"tipo": "M",
"setor": "10",
"cor": [
{
"cor": "00357",
"cor_i": "00066"
},
{
"cor": "30539",
"cor_i": "00357"
}
]
}
]
Método responsável pela inclusão ou alteração de ficha técnica de produto.
A alteração de uma ficha técnica se dará pelo mesmo método de inclusão, caso o campo id for informado e já existir no banco de dados.
URL
POST http://{ip_cliente}/FichaTecnicaProduto
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/FichaTecnicaProduto?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa para gravação (ex.: 001 ou _002) |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| insumo | string / 15 | Sim | Código do insumo produto ou material |
| consumo | number / 15,4 | Não | Quantidade de consumo do insumo por unidade do produto |
| parte | string / 2 | Não | Código da parte do produto onde o insumo é utilizado |
| aplicacao | string / 4 | Não | Código da aplicação do produto onde o insumo é utilizado |
| faixa | string / 4 | Não | Código da faixa de tamanho |
| preco | string / 1 | Não | Considera insumo na formação de preço ( S / N ) |
| tipo | string / 1 | Sim | Tipo do insumo P - Produto M - Material |
| setor | string / 3 | Não | Código do setor ronde o insumo é utilizado |
| cor | objeto | Sim | Cor do produto e cor do insumo |
| cor | string / 6 | Sim | Cor do produto |
| cor_i | string / 6 | Sim | Cor do insumo |
Atributos alteráveis
Caso informado campo id no corpo da requisição, e o mesmo já existir na base de dados, é possível efetuar alteração dos atributos listados abaixo.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| consumo | number / 15,4 | Não | Quantidade de consumo do insumo por unidade do produto |
| parte | string / 2 | Não | Código da parte do produto onde o insumo é utilizado |
| aplicacao | string / 4 | Não | Código da aplicação do produto onde o insumo é utilizado |
| faixa | string / 4 | Não | Código da faixa de tamanho |
| preco | string / 1 | Não | Considera insumo na formação de preço ( S / N ) |
| setor | string / 3 | Não | Código do setor ronde o insumo é utilizado |
Consultar ficha técnica
Método responsável por retornar os dados da ficha técnica de um produto.
Exemplo de retorno:
http://{ip_cliente}/BuscarFichaTecnicaProduto?codigo=ABC123
[
{
"codigo": "ABC123",
"insumos": [
{
"parte": "02",
"insumo": "0020180008",
"id": 1,
"consumo": 0.062,
"aplicacao": "01",
"faixa": "0",
"preco": "N",
"tipo": "M",
"setor": "03",
"deposito": "0001",
"cor": [
{
"cor": "00001",
"cor_i": "0"
},
{
"cor": "00800",
"cor_i": "0"
},
{
"cor": "30009",
"cor_i": "0"
},
{
"cor": "40004",
"cor_i": "0"
}
]
},
{
"parte": "02",
"insumo": "080140017",
"id": 3,
"consumo": 0.046,
"aplicacao": "12",
"faixa": "0",
"preco": "S",
"tipo": "M",
"setor": "10",
"deposito": "0001",
"cor": [
{
"cor": "90357",
"cor_i": "01"
},
{
"cor": "10871",
"cor_i": "0"
},
{
"cor": "30539",
"cor_i": "01"
},
{
"cor": "40944",
"cor_i": "0"
}
]
},
{
"parte": "02",
"insumo": "080120001",
"id": 4,
"consumo": 0,
"aplicacao": "12",
"faixa": "0",
"preco": "N",
"tipo": "M",
"setor": "10",
"deposito": "0001",
"cor": [
{
"cor": "00357",
"cor_i": "01"
},
{
"cor": "00871",
"cor_i": "0"
},
{
"cor": "30539",
"cor_i": "01"
},
{
"cor": "40944",
"cor_i": "0"
}
]
}
]
}
]
URL
GET http://{ip_cliente}/BuscarFichaTecnicaProduto
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/BuscarFichaTecnicaProduto?codigo=ABC123&parte=02&insumo=0020180008
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| parte | string / 2 | Não | Código da parte do produto |
| insumo | string / 15 | Não | Código do insumo da ficha técnica |
| empresa | string / 3 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Excluir ficha técnica
Método responsável pela exclusão dos dados da ficha técnica de um produto.
Exemplo de retorno:
[
{
"resultado": "Ficha técnica produto excluída com sucesso.",
"codigo": "ABC123",
"id": 1
}
]
URL
DELETE http://{ip_cliente}/FichaTecnicaProduto/:codigo
DELETE http://{ip_cliente}/FichaTecnicaProduto/:codigo/:id
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código e o id informados como path param.
Exemplo para excluir toda a ficha técnica de um produto:
DELETE http://{ip_cliente}/FichaTecnicaProduto/ABC123?empresa=001
Exemplo para excluir apenas um insumo:
DELETE http://{ip_cliente}/FichaTecnicaProduto/ABC123/5?empresa=001
Onde "ABC123" representa o código do produto e "5" representa o id do insumo.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| id | integer / path param | Não | ID do insumo |
| empresa | string / 3 | Não | Número da empresa |
Movimentar estoque
Método responsável por realizar a movimentação de estoque de produtos.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Movimentação concluída.",
"documento": "000001",
"itens_erro": []
}
]
Se algum item não puder ser movimentado, constará no array itens_erro, o item e o motivo:
[
{
"resultado": "Movimentação concluída.",
"documento": "000001",
"itens_erro": [
{
"barra": "1000000004496",
"lote": "000000",
"qualidade": "1",
"deposito": "0005",
"motivo": "Estoque insuficiente."
},
{
"barra": "1000000004496",
"lote": "000000",
"qualidade": "1",
"deposito": "0005",
"motivo": "Estoque insuficiente."
},
{
"barra": "100000000449X6",
"lote": "000000",
"qualidade": "1",
"deposito": "0005",
"motivo": "Item não encontrado."
},
{
"codigo": "100110111000",
"cor": "0001",
"tam": "P",
"lote": "000000",
"qualidade": "1",
"deposito": "0000",
"motivo": "Item não encontrado."
}
]
}
]
Exemplo do corpo da requisição
[
{
"documento": "000001",
"operacao": "S",
"tipo_bai": "01",
"funcionario": "00001",
"itens": [
{
"barra": "1000000000000",
"lote": "000000",
"qualidade": "1",
"deposito": "0001",
"qtde": 10,
"custo": 1.0
},
{
"barra": "1000000000001",
"lote": "000000",
"qualidade": "1",
"deposito": "0000",
"qtde": 12,
"custo": 5.55
},
{
"codigo": "100110111000",
"cor": "0001",
"tam": "P",
"lote": "000000",
"qualidade": "1",
"deposito": "0000",
"qtde": 1,
"custo": 2.0
}
]
}
]
URL
POST http://{ip_cliente}/Estoque
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| documento | string / 12 | Sim | Número do documento |
| operacao | string / 1 | Sim | E - Entrada de produtos S - Saída de produtos |
| tipo_bai | string / 2 | Sim | Código do tipo de baixa |
| funcionario | string / 5 | Sim | Código do funcionário |
| Itens | Objeto | Sim | Itens a movimentar |
| barra | string / 25 | Sim (Caso não informados os atributos codigo, cor, tam) |
Código de barras do produto EAN ou código de barras do cliente |
| codigo | string / 15 | Sim (Caso não informado o atributo barra) |
Código do produto |
| cor | string / 6 | Sim (Caso não informado o atributo barra) |
Código da cor do produto |
| tam | string / 4 | Sim (Caso não informado o atributo barra) |
Tamanho do produto |
| lote | string / 15 | Sim | Número do lote |
| qualidade | string / 1 | Sim | Qualidade do produto |
| deposito | string / 6 | Sim | Código do depósito |
| qtde | Number / 10,3 | Sim | Quantidade a movimentar |
| custo | number / 9,4 | Não | Custo do produto |
Em movimentações de saída (operacao = 'S') será validado se a quantidade informada está disponível em estoque.
Caso o atributo custo não for informado, será utilizado o custo definido no cadastro do produto.
Consultar movimentação de estoque
Método responsável por retornar os dados de movimentação de estoques de produto.
Exemplo de retorno:
[
{
"num_docto": "012345",
"codigo": "ABC1234",
"cor": "00001",
"tamanho": "P",
"lote": "000000",
"deposito": "0001",
"tipo": "1",
"tp_mov": "MN",
"operacao": "E",
"qtde": 100,
"preco": 1,
"dt_mvto": "01/01/2025",
"hora": "12:00:00"
},
{
"num_docto": "012345",
"codigo": "ABC1234",
"cor": "00001",
"tamanho": "M",
"lote": "000000",
"deposito": "0001",
"tipo": "1",
"tp_mov": "MN",
"operacao": "E",
"qtde": 2,
"preco": 1,
"dt_mvto": "01/01/2025",
"hora": "12:00:00"
}
]
URL
GET http://{ip_cliente}/MovimentacaoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/MovimentacaoLista?data=27/04/2023&hora=10:00:00&deposito=0000
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Sim | Tipo do item. Preencher com "P" (Produto) |
| data | date | Sim | Data da movimentação |
| hora | time | Não | Hora da movimentação (Utilizar o formato HH:MM:SS) |
| deposito | string / 6 | Não | Código do depósito |
| operacao | string / 1 | Não | Tipo da operação E - Entrada S - Saída |
| tp_mov | string / 2 | Não | Tipo de movimentação |
| codigo | string / 15 | Não | Código do produto |
| cor | string / 6 | Não | Código da cor |
| tamanho | string / 4 | Não | Tamanho |
| lote | string / 15 | Não | Número do lote |
| num_docto | string / 12 | Não | Número do documento / movimentação |
Adicionar imagem produto
Método responsável por adicionar imagens ao cadastro do produto.
São aceitas imagens .jpg, no formato base64.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Imagem gravada com sucesso.",
"codigo": "ABC123"
}
]
Exemplo do corpo da requisição
[
{
"codigo": "000111000001",
"codigo2": "",
"padrao": "S",
"cor": "000001",
"imagem": "/9j/4AAQSkZJRgAB..."
}
]
URL
POST http://{ip_cliente}/ImagemProduto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim (Caso não informado o atributo codigo2) |
Código do produto |
| codigo2 | string / 25 | Não | Código da referência |
| padrao | string / 1 | Não* | S - Substitui a imagem principal do produto N - Adiciona a imagem à lista de documentos do produto Se não informado, assume "N" por padrão |
| cor | string / 6 | Não** | Código da cor do produto |
| imagem | base64 image | Sim | Imagem, .jpg, no formato base64 |
*Se informado atributo "padrao" como "S", independente dos demais parâmetros, será substituída a imagem principal do produto.
**Se não informado atributo "padrao" como "S" e informado atributo "cor", a imagem será gravada para a cor correspondente do produto.
Nos demais casos, a imagem será adicionada à lista de documentos do produto.
Excluir imagem produto
Método responsável por excluir imagens do cadastro de produto.
Exemplo de retorno:
[
{
"resultado": "Imagem excluída com sucesso.",
"imagem": "999940464000.jpg"
}
]
URL
DELETE http://{ip_cliente}/Produto/Imagem/:produto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| produto | string / path param | Sim | Código do produto |
| cor | string | Não | Cor do produto |
Excluir documento produto
Método responsável por excluir documentos do cadastro de produto.
Exemplo de retorno:
[
{
"resultado": "Arquivo excluído com sucesso.",
"arquivo": "1000.jpg"
}
]
URL
DELETE http://{ip_cliente}/Produto/Documento/:produto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| produto | string / path param | Sim | Código do produto |
| arquivo | string | Sim | Nome do arquivo com extensão |
Incluir ou alterar combinação
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Combinação cadastrada com sucesso."
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar combinação: codigo inválido."
}
]
[
{
"method-error-400": "Não foi possível processar combinação: ordem inválido."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "100000000001",
"ordem": 1,
"parte": "PARTE",
"malha": "MALHA",
"descricao": "DESCRICAO",
"tipo": "TIPO",
"cor01": "COR1",
"cor02": "COR2",
"cor03": "COR3",
"cor04": "COR4",
"cor05": "COR5"
}
]
Método responsável pela inclusão ou alteração de combinações no produto.
A alteração de uma combinação se dará pelo mesmo método de inclusão, caso os campos código, ordem, parte e tipo forem informados e já existirem no banco de dados.
URL
POST http://{ip_cliente}/Combinacao
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| ordem | integer | Sim | Ordem - sequencial numérico |
| parte | string / 20 | Sim | Descrição da parte do produto |
| malha | string / 150 | Sim | Descrição da malha |
| descricao | string / 50 | Sim | Descrição da combinação |
| tipo | string / 15 | Sim | Tipo da combinação |
| cor01 | string / 50 | Sim | Descrição da cor 1 |
| cor02 | string / 50 | Não | Descrição da cor 2 |
| cor03 | string / 50 | Não | Descrição da cor 3 |
| cor04 | string / 50 | Não | Descrição da cor 4 |
| cor05 | string / 50 | Não | Descrição da cor 5 |
Atributos alteráveis
Caso informados os campos código, ordem, parte e tipo no corpo da requisição, e os mesmos já existirem na base de dados, é possível efetuar alteração dos atributos listados abaixo.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| malha | string / 150 | Não | Descrição da malha |
| descricao | string / 50 | Não | Descrição da combinação |
| cor01 | string / 50 | Não | Descrição da cor 1 |
| cor02 | string / 50 | Não | Descrição da cor 2 |
| cor03 | string / 50 | Não | Descrição da cor 3 |
| cor04 | string / 50 | Não | Descrição da cor 4 |
| cor05 | string / 50 | Não | Descrição da cor 5 |
Consultar combinação
Método responsável por disponibilizar combinações dos produtos.
Exemplo de retorno:
http://{ip_cliente}/BuscarCombinacao
[
{
"codigo": "100000000001",
"ordem": 1,
"parte": "SUPERIOR",
"malha": "MEIA MALHA TESTE",
"descricao": "CORPO",
"tipo": "TESTE TIPO",
"cor01": "VERDE",
"cor02": "AZUL",
"cor03": "",
"cor04": "",
"cor05": ""
},
{
"codigo": "100000000001",
"ordem": 2,
"parte": "INFERIOR",
"malha": "MEIA MALHA TESTE",
"descricao": "GERAL",
"tipo": "TESTE TIPO",
"cor01": "AZUL",
"cor02": "VERDE",
"cor03": "",
"cor04": "",
"cor05": ""
}
]
URL
GET http://{ip_cliente}/BuscarCombinacao
Retorno
A consulta irá retornar os dados de combinações do produto informado.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/BuscarCombinacao?codigo=100000000001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
Incluir estampa
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Estampa associada ao produto com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "012345",
"estampa": "00001",
"observacao": "Observação de teste de estampas",
"cores": [
{
"ordem": 1,
"parte": "00",
"fundo": "FD01",
"quadro": "Q01",
"obs": "Descrição 1",
"camada1": "COR01"
},
{
"ordem": 2,
"parte": "00",
"fundo": "FD02",
"quadro": "Q02",
"obs": "Descrição 2",
"camada1": "COR02",
"camada2": "COR03"
}
]
}
]
Método responsável pelo vínculo de uma estampa a um produto.
URL
POST http://{ip_cliente}/EstampaProduto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| estampa | string / 15 | Sim | Código da estampa |
| observacao | blob | Não | Observação |
| cores | objeto | Sim | Cores e camadas da estampa |
| ordem | integer | Sim | Ordem da camada |
| parte | string / 2 | Não | Código da parte |
| fundo | string / 6 | Sim | Fundo da estampa |
| quadro | string / 15 | Sim | Quadro da estampa |
| obs | string / 50 | Sim | Descrição da camada |
| camada1 | string / 40 | Sim | Cor da camada 1 |
*Podem ser informadas até 20 camadas, alterando o número. ex: camada1, camada2, camada3.. Apenas a camada1 é obrigatória.
Atributos alteráveis
Caso informado campo produto e estampa no corpo da requisição, e os mesmos já existirem na base de dados, é possível efetuar alteração dos atributos listados abaixo.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| observacao | blob | Não | Observação |
Consultar estampa
Método responsável por retornar os dados de estampa de um produto.
Exemplo de retorno:
[
{
"produto": "012345",
"estampa": "00001",
"observacao": "Observação de teste de estampas",
"cores": [
{
"ordem": 2,
"parte": "01",
"fundo": "FD02",
"quadro": "Q02",
"obs": "DESCRIÇÃO 2",
"camada1": "COR1",
"camada2": "COR2"
},
{
"ordem": 2,
"parte": "01",
"fundo": "FD02",
"quadro": "Q02",
"obs": "DESCRIÇÃO 2",
"camada1": "COR1",
"camada2": "COR2"
}
]
}
]
URL
GET http://{ip_cliente}/BuscarEstampaProduto
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/BuscarEstampaProduto?produto=012345&estampa=00001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| produto | string / 15 | Sim | Código do produto |
| estampa | string / 15 | Não | Código da estampa |
Incluir preço parte
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Preco Parte Produto cadastrado com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "ABC1234",
"numero": "001",
"partes": [
{
"parte": "00",
"setores": [
{
"setor": "00",
"cor": "001",
"tam": "P",
"preco": 1.1,
"observacao": "Exemplo observação"
},
{
"setor": "10",
"cor": "",
"tam": "",
"preco": 0.5,
"observacao": "Exemplo observação 2"
}
]
},
{
"parte": "01",
"setores": [
{
"setor": "05",
"cor": "001",
"tam": "M",
"preco": 1.2,
"observacao": "Exemplo observação"
},
{
"setor": "15",
"cor": "",
"tam": "",
"preco": 2,
"observacao": "Exemplo observação 2"
}
]
}
]
}
]
Método responsável por incluir preços para partes de produtos.
URL
POST http://{ip_cliente}/PrecoParteProduto
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| numero | string / 5 | Sim | Código da tabela de preços |
| partes | objeto | Sim | Partes do produto |
| parte | string / 2 | Sim | Código da parte do produto |
| setores | objeto | Sim | Setores do fluxo produtivo |
| setor | string / 3 | Sim | Código do setor |
| cor | string / 6 | Não | Código da cor do produto |
| tam | string / 4 | Não | Tamanho do produto |
| preco | float | Sim | Preço |
| observacao | string / 50 | Não | Observação |
Consultar preço parte
Método responsável por retornar os dados de preços por partes de produtos.
Exemplo de retorno:
[
{
"codigo": "ABC1234",
"numero": "001",
"partes": [
{
"parte": "01",
"setores": [
{
"setor": "55",
"cor": "001",
"tam": "P",
"preco": 0.06,
"observacao": ""
},
{
"setor": "60",
"cor": "001",
"tam": "P",
"preco": 1.23,
"observacao": "Exemplo de observação"
}
]
},
{
"parte": "02",
"setores": [
{
"setor": "55",
"cor": "",
"tam": "",
"preco": 0.05,
"observacao": ""
},
{
"setor": "60",
"cor": "",
"tam": "",
"preco": 0.91,
"observacao": ""
}
]
}
]
}
]
URL
GET http://{ip_cliente}/BuscarPrecoParteProduto
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/BuscarPrecoParteProduto?codigo=ABC1234
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
Consultar medida produto
Método responsável por retornar os dados de medidas dos produtos.
Exemplo de retorno:
[
{
"codigo": "ABC1234",
"partes": [
{
"parte": "01",
"medidas": [
{
"abrev": "01",
"descricao": "TORAX",
"ordem": 1,
"tolerancia": 0.5,
"tamanhos": [
{
"tam": "P",
"medida": 26
},
{
"tam": "M",
"medida": 27
},
{
"tam": "G",
"medida": 28
},
{
"tam": "GG",
"medida": 30
}
]
}
]
},
{
"parte": "02",
"medidas": [
{
"abrev": "02",
"descricao": "GANCHO COSTA",
"ordem": 2,
"tolerancia": 0.5,
"tamanhos": [
{
"tam": "P",
"medida": 21.5
},
{
"tam": "M",
"medida": 22
},
{
"tam": "G",
"medida": 22.5
},
{
"tam": "GG",
"medida": 23
}
]
},
{
"abrev": "03",
"descricao": "TESTE",
"ordem": 3,
"tolerancia": 0.3,
"tamanhos": [
{
"tam": "P",
"medida": 22
},
{
"tam": "M",
"medida": 23
},
{
"tam": "G",
"medida": 23.5
},
{
"tam": "GG",
"medida": 24.5
}
]
}
]
}
]
}
]
URL
GET http://{ip_cliente}/BuscarMedidaProduto
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/BuscarMedidaProduto?codigo=ABC1234&parte=01
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| parte | string / 2 | Não | Código da parte |
Alterar código de barras
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Barra cadastrada com sucesso."
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar barra produto: cor inválida."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "ABC1234",
"cor": "0001",
"tam": "G",
"barra": "987654321",
"barracli": "1234",
"barra28": "282828"
},
{
"codigo": "ABC1234",
"cor": "0001",
"tam": "GG",
"barra": "987654322",
"barracli": "1235",
"barra28": "282829"
}
]
Método responsável pela inclusão e/ou alteração de códigos de barras no produto.
URL
PATCH http://{ip_cliente}/Produto/Barra
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do produto |
| cor | string / 6 | Sim | Cor do produto |
| tam | string / 4 | Sim | Tamanho do produto |
| barra | string / 13 | Não | Código de barras formato EAN13 |
| barracli | string / 25 | Não | Código de barras do cliente |
| barra28 | string / 6 | Não | Código de barras formato barra 28 |
- Os atributos barra, barracli e barra28, caso não informados, serão ignorados na alteração. Se informados com uma string vazia, os mesmos serão gravados em branco. Dessa forma, informar no corpo da requisição, apenas os atributos que de fato devem ser alterados.
Incluir ou alterar protótipo
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Protótipo cadastrado com sucesso.",
"produto": "1234"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Não foi possível processar protótipo: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"ativo": "S",
"descricao": "PROTOTIPO EXEMPLO",
"descricao2": "DESCRICAO 2",
"codcli": "0001",
"fornecedor": "0001",
"dt_producao": "01/01/2024",
"dt_entrega": "01/02/2024",
"ficha": "1",
"preco_repos": 1.1,
"comp1": "complemento 1",
"comp2": "complemento 2",
"compri": 1.2,
"status": "Liberado p/ Produção",
"estilista": "ESTILISTA",
"modelista": "MODELISTA",
"obs": "Observação exemplo",
"linha": "0001",
"grupo": "00",
"colecao": "01",
"faixa": "00",
"familia": "01",
"etiqueta": "001",
"marca": "01",
"unidade": "PC",
"instrucao": [
{
"ordem": 1,
"data": "01/01/2024",
"obs": "Observação instrução 1",
"instrucao": "1"
},
{
"ordem": 2,
"data": "01/01/2024",
"obs": "Observação instrução 2",
"instrucao": "2"
}
]
}
]
Método responsável pela inclusão ou alteração de protótipos.
A alteração de um protótipo se dará pelo mesmo método de inclusão, caso o atributo prototipo for informado e já existir no banco de dados.
URL
POST http://{ip_cliente}/Prototipo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ativo | string / 1 | Sim | Protótipo ativo ( S / N ) |
| descricao | string / 100 | Sim | Descrição do protótipo |
| descricao2 | string / 100 | Não | Descrição 2 |
| codcli | string / 5 | Não | Código do cliente |
| fornecedor | string / 6 | Não | Código do fornecedor |
| dt_producao | date | Não | Data do protótipo |
| dt_entrega | date | Não | Data de entrega |
| ficha | string / 12 | Não | Ficha |
| preco_repos | number / 11,4 | Não | Preço |
| comp1 | string / 80 | Não | Complemento 1 |
| comp2 | string / 80 | Não | Complemento 2 |
| compri | number / 7,2 | Não | Comprimento |
| status | string / 30 | Sim | Descrição do status do protótipo |
| estilista | string / 30 | Não | Nome do(a) estilista |
| modelista | string / 30 | Não | Nome do(a) modelista |
| obs | blob | Não | Observação |
| linha | string / 5 | Sim * | Código da linha |
| grupo | string / 3 | Sim | Código do grupo |
| colecao | string / 4 | Sim * | Código da coleção |
| faixa | string / 2 | Sim | Código da faixa de tamanho |
| familia | string / 5 | Sim * | Código da família |
| etiqueta | string / 4 | Sim * | Código da etiqueta |
| marca | string / 4 | Sim * | Código da marca |
| unidade | string / 3 | Sim | Unidade do protótipo |
| instrucao | objeto | Não | Instruções do protótipo |
| ordem | integer | Sim | Ordem da instrução |
| data | date | Sim | Data |
| obs | string / 180 | Não | Observação |
| instrucao | string / 5 | Sim | Código da instrução |
*Campos obrigatórios a depender da parametrização do ERP.
Atributos alteráveis
Caso informado, no corpo da requisição, o atributo prototipo, e o mesmo existir na base de dados, é possível alterar alguns parâmetros do protótipo.
No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos não informados serão ignorados na alteração. Atributos informados com valor vazio serão alterados para vazio.
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / 10 | Sim | Informar o código do protótipo a ser alterado |
| descricao | string / 100 | Não | Descrição do protótipo |
| descricao2 | string / 100 | Não | Descrição 2 |
| estilista | string / 30 | Não | Nome do(a) estilista |
| modelista | string / 30 | Não | Nome do(a) modelista |
| status | string / 30 | Não | Descrição do status do protótipo |
| preco_repos | number / 12,5 | Não | Preço |
| ativo | string / 1 | Não | Protótipo ativo ( S / N ) |
| dt_producao | date | Não | Data do protótipo |
| dt_entrega | date | Não | Data de entrega |
| obs | blob | Não | Observação |
| ficha | string / 12 | Não | Ficha |
| compri | number / 7,2 | Não | Comprimento |
| comp1 | string / 80 | Não | Complemento 1 |
| comp2 | string / 80 | Não | Complemento 2 |
| marca | string / 4 | Não | Código da marca |
| linha | string / 5 | Não | Código da linha |
| instrucao * | objeto | Não | Instruções do protótipo |
*Caso informado atributo "instrucao", todos registros de instrução serão substituídos pelos informados na requisição.
Consultar protótipo
Método responsável por consultar os dados de um protótipo.
Exemplo de retorno:
[
{
"data_cad": "18/06/2024",
"dt_producao": "01/01/2025",
"dt_entrega": "01/02/2025",
"prototipo": "00002",
"descricao": "PROTOTIPO EXEMPLO",
"descricao2": "DESCRICAO 2",
"etiqueta": "001",
"grupo": "00",
"familia": "01",
"linha": "0001",
"marca": "01",
"colecao": "01",
"faixa": "00",
"status": "Liberado p/ Produção",
"ativo": "S",
"codcli": "0001",
"estilista": "ESTILISTA",
"modelista": "MODELISTA",
"comp1": "comp 1",
"comp2": "comp 2",
"compri": 1.2,
"obs": "Observação exemplo",
"ficha": "0",
"instrucao": [
{
"ordem": 1,
"data": "01/01/2024",
"instrucao": "1",
"obs": "Observação instrução 1",
"obs1": "Observação adicional"
},
{
"ordem": 2,
"data": "01/01/2024",
"instrucao": "2",
"obs": "Observação instrução 2",
"obs1": ""
}
],
"documento": [
{
"arquivo": "arquivo_exemplo.pdf",
"data": "18/06/2024 10:30:42",
"tamanho": "4070,53 KB"
},
{
"arquivo": "teste.txt",
"data": "18/06/2024 12:30:42",
"tamanho": "0,70 KB"
}
]
}
]
URL
GET http://{ip_cliente}/Prototipo/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Prototipo/00001
Onde "00001" representa o código da operação consultada.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do protótipo |
| empresa | string / 4 | Não | Número da empresa |
Consultar lista de protótipos
Método responsável por disponibilizar uma lista de protótipos.
Exemplo de retorno:
[
{
"data_cad": "01/01/2024",
"dt_producao": "01/01/2025",
"dt_entrega": "01/02/2025",
"prototipo": "00001",
"descricao": "PROTOTIPO EXEMPLO",
"descricao2": "DESCRICAO 2",
"etiqueta": "001",
"grupo": "",
"familia": "01",
"linha": "0001",
"marca": "01",
"colecao": "01",
"faixa": "00",
"status": "Liberado p/ Produção",
"ativo": "S",
"codcli": "0001",
"estilista": "ESTILISTA",
"modelista": "MODELISTA",
"comp1": "comp 1",
"comp2": "comp 2",
"compri": 1.2,
"ficha": "0"
},
{
"data_cad": "01/01/2024",
"dt_producao": "01/01/2025",
"dt_entrega": "01/02/2025",
"prototipo": "00002",
"descricao": "PROTOTIPO EXEMPLO",
"descricao2": "DESCRICAO 2",
"etiqueta": "001",
"grupo": "",
"familia": "01",
"linha": "0001",
"marca": "01",
"colecao": "01",
"faixa": "00",
"status": "Liberado p/ Produção",
"ativo": "",
"codcli": "0001",
"estilista": "",
"modelista": "000",
"comp1": "comp 1",
"comp2": "comp 2",
"compri": 1.2,
"ficha": "0"
}
]
URL
GET http://{ip_cliente}/Prototipo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Prototipo?data_cad=01/01/2024&empresa=002
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data_cad | date | Sim | Data de cadastro Data inicial da consulta Utilizar o formato DD/MM/YYYY |
| codcli | string / 5 | Não | Código do cliente |
| prototipo | string / 15 | Não | Código do protótipo |
| fornecedor | string / 6 | Não | Código do fornecedor |
| empresa | string / 4 | Não | Número da empresa |
Excluir protótipo
Método responsável por excluir um protótipo
Exemplo de retorno:
[
{
"resultado": "Protótipo excluído com sucesso."
}
]
URL
DELETE http://{ip_cliente}/Prototipo/:prototipo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / path param | Sim | Código do protótipo |
| empresa | string / 3 | Não | Número da empresa |
Adicionar imagem protótipo
Método responsável por adicionar imagem ao cadastro de protótipo.
São aceitas imagens .jpg, no formato base64.
Exemplo de retorno:
[
{
"resultado": "Imagem gravada com sucesso.",
"codigo": "ABC123"
}
]
Exemplo do corpo da requisição
[
{
"prototipo": "ABC123",
"ordem": 1,
"imagem": "/9j/4AAQSkZJRgAB..."
}
]
URL
POST http://{ip_cliente}/Prototipo/Imagem
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / 15 | Sim | Código do protótipo |
| ordem | integer | Não | Sequencial da imagem Caso informado, será vinculada a imagem à instrução do protótipo de mesma ordem |
| imagem | base64 image | Sim | Imagem, .jpg, no formato base64 |
Consultar documento protótipo
Método responsável por consultar um documento do cadastro de protótipo.
O documento será retornado no formato base64.
Exemplo de retorno:
[
{
"arquivo": "arquivo_exemplo.txt",
"documento": "W2NhbWluaG9dDQpwYX.."
}
]
URL
GET http://{ip_cliente}/Prototipo/Documento/:prototipo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / path param | Sim | Código do protótipo |
| arquivo | string | Sim | Nome do documento / arquivo |
| empresa | string / 3 | Não | Número da empresa |
Adicionar documento protótipo
Método responsável por adicionar documentos ao cadastro de protótipo.
São aceitos documentos e imagens no formato base64.
Exemplo de retorno:
[
{
"resultado": "Documento gravado com sucesso.",
"arquivo": "teste.txt"
}
]
Exemplo do corpo da requisição
[
{
"arquivo": "teste1.txt",
"documento":"/9j/4AAQSkZJRgAB..."
}
]
URL
POST http://{ip_cliente}/Prototipo/Documento/:prototipo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / path param | Sim | Código do protótipo |
| empresa | string / 3 | Não | Número da empresa |
Excluir documento protótipo
Método responsável por excluir documentos do cadastro de protótipo.
Exemplo de retorno:
[
{
"resultado": "Arquivo deletado com sucesso.",
"arquivo": "teste.txt"
}
]
URL
DELETE http://{ip_cliente}/Prototipo/Documento/:prototipo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| prototipo | string / path param | Sim | Código do protótipo |
| arquivo | string | Sim | Nome do documento / arquivo |
| empresa | string / 3 | Não | Número da empresa |
Incluir terceiro da parte do produto
Método responsável pela inclusão do terceiro / facção para a parte e os setores no fluxo produtivo do produto.
Exemplo de retorno:
[
{
"resultado": "Dados gravados com sucesso."
}
]
Exemplo do corpo da requisição
[
{
"codcli": "00001",
"principal": "N",
"obs": "Observação exemplo 1"
},
{
"codcli": "00002",
"principal": "S",
"obs": "Observação exemplo 2"
},
{
"codcli": "00003",
"principal": "N",
"obs": "Observação exemplo 3"
}
]
URL
POST http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor
Parâmetros
Os parâmetros devem ser passados no link da requisição.
POST http://{ip_cliente}/Produto/1234/Fluxo/Terceiro/01/99?empresa=001
Onde "1234" representa o código do produto, "01" o código da parte e "99" o código do setor.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| parte | string / path param | Sim | Código da parte do produto |
| setor | string / path param | Sim | Código do setor |
| empresa | string / 4 | Não | Número da empresa |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codcli | string / 5 | Sim | Código do terceiro |
| principal | string / 1 | Não | Define o terceiro como principal ( S / N ) |
| obs | string / 100 | Não | Observação |
Alterar terceiro da parte do produto
Método responsável pela alteração do terceiro / facção para a parte e os setores no fluxo produtivo do produto.
Exemplo de retorno:
[
{
"resultado": "Dados atualizados com sucesso."
}
]
Exemplo do corpo da requisição
[
{
"principal": "N",
"obs": "Observação exemplo 1"
}
]
URL
PATCH http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor/:codcli
Parâmetros
Os parâmetros devem ser passados no link da requisição.
PATCH http://{ip_cliente}/Produto/1234/Fluxo/Terceiro/01/99/00001?empresa=001
Onde "1234" representa o código do produto, "01" o código da parte, "99" o código do setor e "00001" o código do terceiro.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| parte | string / path param | Sim | Código da parte do produto |
| setor | string / path param | Sim | Código do setor |
| codcli | string / path param | Sim | Código do terceiro |
| empresa | string / 4 | Não | Número da empresa |
Atributos alteráveis
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| principal | string / 1 | Não | Define o terceiro como principal ( S / N ) |
| obs | string / 100 | Não | Observação |
Consultar terceiro da parte do produto
Método responsável pela consulta dos dados de terceiro / facção para a parte e os setores no fluxo produtivo do produto.
Exemplo de retorno:
[
{
"codcli": "00001",
"nome": "EXEMPLO S/A",
"setor": "20",
"desc_setor": "COSTURA",
"parte": "01",
"desc_parte": "PRINCIPAL",
"principal": "N",
"obs": "Observação exemplo 00001"
},
{
"codcli": "00002",
"nome": "EXEMPLO LTDA.",
"setor": "30",
"desc_setor": "BORDADO",
"parte": "01",
"desc_parte": "PRINCIPAL",
"principal": "S",
"obs": "Observação exemplo 00002"
}
]
URL
GET http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro
GET http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte
GET http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor
GET http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor/:codcli
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Produto/1234/Fluxo/Terceiro/01/99/00001?empresa=001
Onde "1234" representa o código do produto, "01" o código da parte, "99" o código do setor e "00001" o código do terceiro.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| parte | string / path param | Não | Código da parte do produto |
| setor | string / path param | Não | Código do setor |
| codcli | string / path param | Não | Código do terceiro |
| empresa | string / 4 | Não | Número da empresa |
Excluir terceiro da parte do produto
Método responsável pela exclusão dos dados de terceiro / facção para a parte e os setores no fluxo produtivo do produto.
Exemplo de retorno:
[
{
"resultado": "Exclusão efetuada com sucesso.",
}
]
URL
DELETE http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro
DELETE http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte
DELETE http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor
DELETE http://{ip_cliente}/Produto/:codigo/Fluxo/Terceiro/:parte/:setor/:codcli
Parâmetros
Os parâmetros devem ser passados no link da requisição.
DELETE http://{ip_cliente}/Produto/1234/Fluxo/Terceiro/01/99/00001?empresa=001
Onde "1234" representa o código do produto, "01" o código da parte, "99" o código do setor e "00001" o código do terceiro.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| parte | string / path param | Não | Código da parte do produto |
| setor | string / path param | Não | Código do setor |
| codcli | string / path param | Não | Código do terceiro |
| empresa | string / 4 | Não | Número da empresa |
Inventário
Incluir inventário
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Inventário gravado.",
"lancamento": "000006"
}
Em caso de erro, será retornado status 400, um array com os itens e o motivo:
[
{
"resultado": "Não foi possível procesar o inventário.",
"itens_erro": [
{
"codigo": "",
"cor": "",
"tam": "",
"barra": "1000000000001",
"lote": "",
"deposito": "0001",
"motivo": "Material não encontrado."
}
]
}
]
Exemplo do corpo da requisição:
[
{
"setor": "00",
"dt_mes": "01/01/2024",
"conta": "0001",
"codcli": "00001",
"ind_prop": "0",
"deposito": "0001",
"usuario": "0001",
"itens": [
{
"barra": "0000000000000",
"codigo": "ABC123",
"descricao": "PRODUTO EXEMPLO",
"cor": "001",
"tam": "G",
"lote": "001122",
"qtde": 15,
"preco": 7.65,
"local": "A01",
"parte": "00"
},
{
"barra": "0000000000001",
"codigo": "ABC123",
"descricao": "PRODUTO EXEMPLO",
"cor": "001",
"tam": "GG",
"lote": "001122",
"qtde": 15,
"preco": 7.65,
"local": "A01",
"parte": "00"
}
]
}
]
Método responsável pela inclusão de inventário.
Caso já exista um registro com a mesma data, setor, código, cor, tamanho, lote e depósito, o mesmo será atualizado.
O tipo do item (Produto/Material) é definido pelo tipo do setor.
Produtos podem ser informados por código, cor e tamanho ou por código de barras.
Materiais podem ser informados por código e cor, ou por barra, ou por lote.
URL
POST http://{ip_cliente}/Inventario
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| setor | string / 15 | Sim | Setor do inventário |
| dt_mes | date | Sim | Data do inventário |
| deposito | string / 6 | Sim | Código do depósito |
| usuario | string / 20 | Sim | Nome do usuário |
| ind_prop | string / 1 | Não | Indicador de propriedade/posse do item 0 - Estoque de propriedade do informante e em seu poder. 1 - Estoque de propriedade do informante e em posse de terceiros 2 - Estoque de propriedade de terceiros e em posse do informante * Caso não informado, será gravado 0 |
| conta | string / 15 | Não | Código da conta |
| codcli | string / 5 | Não | Código do portador |
| Itens | Objeto | Sim | Itens do inventário |
| barra | string / 13 | Sim (Caso não informados os atributos código, cor e tam) | Código de barras EAN13 |
| codigo | string / 15 | Sim (Caso não informado atributo barra) | Código do item |
| descricao | string / 120 | Não | Descrição do item |
| cor | string / 6 | Sim (Caso não informado atributo barra) | Código da cor |
| tam | string / 4 | Sim (Caso não informado atributo barra) | Tamanho |
| lote | string / 15 | Não | Número do lote Caso não informado, será gravado "000000" |
| qtde | number / 12,3 | Sim | Quantidade em estoque |
| preco | number / 10,4 | Não | Preço/Custo do item |
| local | string / 30 | Não | Código do local |
| parte | string / 2 | Não | Código da parte |
Cor
Incluir cor
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Cor cadastrada com sucesso",
"codigo": "000001"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar cor: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "DESCRIÇÃO COR",
"grupo": "01",
"pantone": "0000000000000",
"corbase": "000001"
}
]
Método responsável pela inclusão de cores.
URL
POST http://{ip_cliente}/Cor
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 80 | Sim | Descrição da coleção |
| grupo | string / 2 | Não | Código do grupo de cores |
| pantone | string / 50 | Não | Código do pantone |
| corbase | string / 6 | Não | Código da cor base |
Consultar lista de cores
Método responsável por disponibilizar uma listagem do cadastro de cores.
Exemplo de retorno com os dados das cores:
http://{ip_cliente}/CorLista
[
{
"cor": "0",
"descricao": "UNICO",
"grupo": "00",
"pantone": "",
"corbase": ""
},
{
"cor": "001",
"descricao": "PRETO",
"grupo": "00",
"pantone": "",
"corbase": ""
},
{
"cor": "002",
"descricao": "BRANCO",
"grupo": "00",
"pantone": "",
"corbase": ""
}
]
URL
GET http://{ip_cliente}/CorLista
Retorno
A consulta irá retornar todos os dados de todas as cores cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/CorLista?cor=000001;000002
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| cor | string / 6 | Não | Código da cor. Separar por ";" quando informado mais de um valor |
Etiqueta
Consultar lista de etiquetas
Método responsável por disponibilizar uma listagem do cadastro de etiquetas.
Exemplo de retorno com os dados das etiquetas:
http://{ip_cliente}/EtiquetaLista
[
{
"codigo": "001",
"descricao": "ETIQUETA 1",
"obs": ""
},
{
"codigo": "002",
"descricao": "ETIQUETA 2",
"obs": ""
},
{
"codigo": "003",
"descricao": "ETIQUETA 3",
"obs": ""
}
]
URL
GET http://{ip_cliente}/EtiquetaLista
Retorno
A consulta irá retornar todos os dados de todas as etiquetas cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Coleção
Incluir coleção
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Coleção cadastrada com sucesso",
"codigo": "01"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar coleção: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "DESCRIÇÃO COLEÇÃO",
"indice": 0.63,
"sequencia": "0001",
"reservar": "L",
"ativo": "S",
"valor_min": 0.25
}
]
Método responsável pela inclusão de coleções.
URL
POST http://{ip_cliente}/Colecao
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Sim | Descrição da coleção |
| indice | number / 9,2 | Não | Índice |
| sequencia | string / 4 | Não | Sequência de produção |
| reservar | string / 1 | Sim | Atendimento S - Com reserva N - Pronta entrega L - Livre |
| ativo | string / 1 | Não | Status do cadastro S - Ativo N - Inativo |
| valor_min | number / 9,2 | Não | Valor mínimo |
Consultar lista de coleções
Método responsável por disponibilizar uma listagem do cadastro de coleções.
Exemplo de retorno com os dados das coleções:
http://{ip_cliente}/ColecaoLista
[
{
"codigo": "01",
"descricao": "COLEÇÃO 1",
"indice": 0,
"sequencia": ""
},
{
"codigo": "02",
"descricao": "COLEÇÃO 2",
"indice": 0,
"sequencia": ""
},
{
"codigo": "03",
"descricao": "COLEÇÃO 3",
"indice": 0,
"sequencia": ""
},
]
URL
GET http://{ip_cliente}/ColecaoLista
Retorno
A consulta irá retornar todos os dados de todas as coleções cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Não | Descrição da coleção |
Aplicação
Consultar lista de aplicações
Método responsável por disponibilizar uma listagem do cadastro de aplicações.
Exemplo de retorno com os dados das aplicações:
http://{ip_cliente}/AplicacaoLista
[
{
"codigo": "001",
"descricao": "UNICA",
"tipo": "",
"tipoapl": "01"
},
{
"codigo": "01",
"descricao": "FRENTE",
"tipo": "",
"tipoapl": ""
},
{
"codigo": "02",
"descricao": "COSTAS",
"tipo": "",
"tipoapl": ""
}
]
URL
GET http://{ip_cliente}/AplicacaoLista
Retorno
A consulta irá retornar todos os dados de todas as aplicações cadastradas no ERP EXCIA.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/AplicacaoLista?pagina=2
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Parte
Consultar lista de partes
Método responsável por disponibilizar uma listagem do cadastro de partes.
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "SUPERIOR"
},
{
"codigo": "02",
"descricao": "INFERIOR"
}
]
URL
GET http://{ip_cliente}/Parte
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Parte?empresa=001&descricao=SUPERIOR
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 2 | Não | Código da parte |
| descricao | string / 30 | Não | Descrição da parte |
Fluxo
Consultar fluxo
Método responsável por disponibilizar os dados detalhados de um fluxo produtivo.
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "PCP/CORTE/COST/REV/EMB",
"baixalivre": "N",
"setores": [
{
"setor": "00",
"descricao": "PCP",
"ordem": 1
},
{
"setor": "10",
"descricao": "CORTE",
"ordem": 2
},
{
"setor": "60",
"descricao": "COSTURA",
"ordem": 4
},
{
"setor": "70",
"descricao": "REVISAO",
"ordem": 5
},
{
"setor": "90",
"descricao": "DOBRA",
"ordem": 7
}
]
}
]
URL
GET http://{ip_cliente}/Fluxo/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Fluxo/01?empresa=001
Onde "01" representa o código do fluxo.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do fluxo |
Consultar lista de fluxos
Método responsável por disponibilizar uma listagem do cadastro de fluxo produtivo.
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "PCP/CORTE/BORD/COST/REV/EMB"
},
{
"codigo": "02",
"descricao": "PCP/CORTE/COST/REV/EMB"
}
]
URL
GET http://{ip_cliente}/Fluxo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Fluxo?empresa=001&descricao=PCP
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 2 | Não | Código do fluxo |
| descricao | string / 30 | Não | Descrição do fluxo |
Representante
Consultar lista de representantes
Método responsável por disponibilizar uma listagem do cadastro de representantes.
Exemplo de retorno com os dados dos representantes:
http://{ip_cliente}/RepresentanteLista
[
{
"codrep": "00001",
"nome": "REPRESENTANTE 1",
"cpf": "000.000.000-00",
"ativo": "S",
"email": "",
"celular": "",
"comissao": 2,
"comissao2": 3,
"comissao3": 1,
"comissao4": 1,
"grupo": "01"
},
{
"codrep": "00002",
"nome": "REPRESENTANTE 2",
"cpf": "000.000.000-00",
"ativo": "S",
"email": "",
"celular": "",
"comissao": 5,
"comissao2": 3,
"comissao3": 0,
"comissao4": 0,
"grupo": "02"
},
{
"codrep": "00003",
"nome": "REPRESENTANTE 3",
"cpf": "000.000.000-00",
"ativo": "S",
"email": "",
"celular": "",
"comissao": 15,
"comissao2": 0,
"comissao3": 0,
"comissao4": 0,
"grupo": "10"
}
]
URL
GET http://{ip_cliente}/RepresentanteLista
Retorno
A consulta irá retornar todos os representantes cadastrados e ativos no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/RepresentanteLista?codrep=0001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codrep | string / 5 | Não | Código do representante. |
| nome | string / 100 | Não | Nome do representante |
Consultar lista de lançamentos dos representantes
Método responsável por disponibilizar uma listagem dos lançamentos de débito e crédito dos representantes.
Exemplo de retorno:
[
{
"codigo": "000003",
"dt_lan": "01/01/2024",
"dt_pago": "01/01/2024",
"codcli": "00001",
"nome": "REPRESENTANTE EXEMPLO 1",
"valor": 500.56,
"op": "D",
"descricao": "OBSERVAÇÃO EXEMPLO",
"pago": "S"
},
{
"codigo": "000004",
"dt_lan": "15/01/2024",
"dt_pago": "",
"codcli": "00002",
"nome": "REPRESENTANTE EXEMPLO 2",
"valor": 120.35,
"op": "C",
"descricao": "",
"pago": "N"
},
{
"codigo": "000005",
"dt_lan": "16/01/2024",
"dt_pago": "17/01/2024",
"codcli": "00003",
"nome": "REPRESENTANTE EXEMPLO 3",
"valor": 55.01,
"op": "D",
"descricao": "OBSERVAÇÃO EXEMPLO",
"pago": "S"
}
]
URL
GET http://{ip_cliente}/Representante/Lancamento
Retorno
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/Representante/Lancamento?codrep=00001&dt_lan=01/01/2024
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codrep | string / 5 | Não | Código do representante. |
| dt_lan | date | Não | Data do lançamento |
| pago | string / 1 | Não | Situação do lançamento S - Pago N - Pendente |
| empresa | string / 3 | Não | Número da empresa |
Transportadora
Consultar lista de transportadoras
Método responsável por disponibilizar uma listagem do cadastro de transportadoras.
Exemplo de retorno com os dados dos transportadoras:
http://{ip_cliente}/TransportadoraLista
[
{
"codigo": "0001",
"descricao": "TRANSPORTADORA 1",
"ativo": "S",
"cidade": "INDAIAL",
"uf": "SC",
"cgc": "00.000.000/0000-00"
},
{
"codigo": "0002",
"descricao": "TRANSPORTADORA 2",
"ativo": "S",
"cidade": "BLUMENAU",
"uf": "SC",
"cgc": "02.000.000/0000-00"
},
{
"codigo": "0003",
"descricao": "TRANSPORTADORA 3",
"ativo": "N",
"cidade": "CURITIBA",
"uf": "PR",
"cgc": "03.000.000/0000-00"
}
]
URL
GET http://{ip_cliente}/TransportadoraLista
Retorno
A consulta irá retornar todas as transportadoras cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/TransportadoraLista?codigo=0001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 4 | Não | Código da transportadora |
| descricao | string / 80 | Não | Descrição da transportadora |
Condição de pagamento
Consultar lista de condições
Método responsável por disponibilizar uma listagem do cadastro de condições de pagamento.
Exemplo de retorno com os dados das condições:
http://{ip_cliente}/CondicaoLista
[
{
"codigo": 1,
"descricao": "30",
"descmax": 10,
"tabela": "001",
"prazoini": 30,
"nrdia": 30,
"diave": 5,
"nrpar": 1
},
{
"codigo": 2,
"descricao": "30 60",
"descmax": 0,
"tabela": "001",
"prazoini": 30,
"nrdia": 30,
"diave": 5,
"nrpar": 2
},
{
"codigo": 3,
"descricao": "30 60 90",
"descmax": 0,
"tabela": "001",
"prazoini": 30,
"nrdia": 30,
"diave": 5,
"nrpar": 3
}
]
URL
GET http://{ip_cliente}/CondicaoLista
Retorno
A consulta irá retornar todas as condições de pagamento cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Ordem de produção
Incluir inspeção
Método responsável pelo apontamento de defeitos em ordens de produção.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/Inspecao
[
{
"resultado": "Inspeção cadastrada com sucesso",
"lancamento": "021552"
}
]
Exemplo de retorno caso algum campo obrigatório não for informado ou for informado com um dado inválido:
[
{
"method-error-400": "Não foi possível processar inspeção: dt_lan inválida."
}
]
Exemplo de retorno em caso de erro:
[
{
"method-error-400": "Não foi possível processar inspeção: [FireDAC][Phys][FB]-345. Data too large for variable [codcli]. Max len = [5], actual len = [15] Hint: set the TFDParam.Size to a greater value"
}
]
URL
POST http://{ip_cliente}/Inspecao
Exemplo do corpo da requisição:
[
{
"numero": "000000",
"setor": "04",
"lote": "0001",
"insumo": "123456",
"parte": "00",
"amostra": 5,
"qtde_prod": 100,
"dt_lan": "01/01/2021",
"tipo": "01",
"codcli": "00001",
"revisor": "001",
"inspetor": "001",
"obs": "Observação teste",
"aprovado": "S",
"defeitos": [
{
"codigo": "001",
"cor": "0001",
"tam": "GG",
"quant": 2,
"rolo": 1,
"status": "1"
},
{
"codigo": "002",
"cor": "0001",
"tam": "GG",
"quant": 5,
"lote": "0001",
"rolo": 1,
"status": "1"
}
],
"detalhes": [
{
"nome": "detalhe1",
"valor": 1.780
},
{
"nome": "detalhe2",
"valor": 1
}
]
}
]
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 9 | Sim | Número da OP |
| setor | string / 4 | Sim | Setor onde o defeito foi apontado |
| lote | string / 15 | Não | Lote |
| insumo | string / 15 | Sim | Código do insumo |
| parte | string / 2 | Não | Parte do produto |
| mov | integer | Não | Número sequencial do movimento |
| amostra | number / 10,2 | Não | Quantidade de amostra |
| qtde_prod | number / 10,2 | Não | Quantidade produzida na OP |
| dt_lan | date | Sim | Data do lançamento |
| tipo | string / 2 | Não | Código do tipo de inspeção |
| codcli | string / 5 | Sim | Código do terceiro |
| revisor | string / 8 | Sim | Código do revisor |
| inspetor | string / 8 | Sim | Código do inspetor |
| obs | blob | Não | Observação |
| aprovado | string / 1 | Não | Status aprovado (S / N) |
| Defeitos | Objeto | Sim | Defeitos da inspeção |
| codigo | string / 5 | Sim | Código do defeito |
| cor | string / 6 | Sim | Cor do produto |
| tam | string / 4 | Sim | Tamanho do produto |
| quant | number / 10,2 | Não | Quantidade de defeitos |
| rolo | integer | Não | Número do rolo |
| status | string / 1 | Não | 0 - Inspeção Inicial 1 - Aprovado 2 - Reprovado 3 - Aprovado com Restrição |
| Detalhes | Objeto | Não | Campos auxiliares da inspeção Estes valores serão gravados na tabela OF2 |
| nome | string / 30 | Sim | Nome do campo |
| valor | number / 10,3 | Sim | Valor do campo |
Consultar consumos
Método responsável por listar os insumos da ficha técnica de um produto com base em sua ordem de produção.
Exemplo de retorno com os dados dos consumos:
http://{ip_cliente}/BuscarConsumos?numero=100001&setor=01
[
{
"parte": "00",
"insumo": "ABCD1234",
"cor_i": "B0000",
"lote": "100000",
"largura": 0,
"gramatura": 0,
"codcli": "00001",
"consumo": 652
},
{
"parte": "00",
"insumo": "ABCD0001",
"cor_i": "B0001",
"lote": "24058",
"largura": 0,
"gramatura": 0,
"codcli": "00001",
"consumo": 120
},
{
"parte": "00",
"insumo": "ABCD9876",
"cor_i": "B0002",
"lote": "300000",
"largura": 0,
"gramatura": 0,
"codcli": "00001",
"consumo": 326
}
]
Exemplo de retorno em caso de erro:
http://{ip_cliente}/BuscarConsumos?numero=100001&setor=01111
[
{
"method-error-400": "Não foi possível buscar consumos da OP: Erro TIQuery.Open: [FireDAC][Phys][FB]-345. Data too large for variable [SETOR]. Max len = [3], actual len = [5] Hint: set the TFDParam.Size to a greater value"
}
]
Exemplo de retorno onde não foram encontrados registros:
http://{ip_cliente}/BuscarConsumos?numero=10000X&setor=01
[
{
"method-error-400": "Não foi possível buscar consumos da OP: Nenhum registro encontrado"
}
]
URL
GET http://{ip_cliente}/BuscarConsumos
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/BuscarConsumos?numero=100001&setor=01
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da OP. |
| setor | string / 3 | Sim | Setor da OP. |
| lote | string / 15 | Não | Lote do insumo em estoque. |
| insumo | string / 15 | Não | Código do insumo. |
| cor_i | string / 6 | Não | Cor do insumo. |
Incluir Operação
Método responsável pela inclusão de uma operação em um produto.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/Operacao
[
{
"resultado": "Operação cadastrada com sucesso",
"codigo": "2383"
}
]
Exemplo de retorno em caso de erro:
[
{
"method-error-400": "Não foi possível processar operação: 'a0' is not a valid integer value"
}
]
URL
POST http://{ip_cliente}/Operacao
Exemplo do corpo da requisição:
[
{
"codigo": "2383",
"descricao":"Operacao teste",
"maquina":"01",
"tempo":1.2,
"complemento":"Comp. teste",
"tempo_hr":"00:00:02",
"parte":"00",
"compri":1.1,
"interferencia":0,
"concessoes ":0,
"tempo_total":0,
"custo":1
}
]
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 5 | Não | Código da operação no ERP. Caso informado, se já existir no ERP, as informações serão atualizadas. Nesse caso é importante que todas os parâmetros sejam informados, mesmo os que permanecerão iguais. |
| descricao | string / 100 | Não | Descrição da operação |
| maquina | string / 3 | Não | Código da máquina |
| tempo | number / 9,4 | Não | Tempo (em horas) |
| complemento | string / 10 | Não | Complemento |
| tempo_hr | time | Não | Tempo em HH:MM:SS |
| parte | string / 2 | Não | Código da parte |
| compri | number / 5,2 | Não | Comprimento |
| interferencia | number / 5,2 | Não | % Interferência |
| concessoes | number / 5,2 | Não | Concessões |
| tempo_total | number / 8,4 | Não | Tempo total (em horas) |
| custo | number / 9,2 | Não | Custo Opr. |
Consultar operação
Método responsável por consultar os dados de uma operação.
Exemplo de retorno:
[
{
"codigo": "00001",
"maquina": "001",
"observacao": "OBSERVAÇÃO EXEMPLO",
"descricao": "OPERAÇÃO EXEMPLO 1",
"tipo": "Normal"
}
]
URL
GET http://{ip_cliente}/Operacao/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Operacao/00001
Onde "00001" representa o código da operação consultada.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código da operação |
Consultar lista de operações
Método responsável por listar todas as operações cadastradas no ERP.
Exemplo de retorno:
[
{
"codigo": "00001",
"maquina": "001",
"observacao": "OBSERVAÇÃO EXEMPLO",
"descricao": "OPERAÇÃO EXEMPLO 1",
"tipo": "Normal"
},
{
"codigo": "00002",
"maquina": "002",
"observacao": "OBSERVAÇÃO EXEMPLO",
"descricao": "OPERAÇÃO EXEMPLO 2",
"tipo": "Parada"
}
]
URL
GET http://{ip_cliente}/OperacaoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
GET http://{ip_cliente}/OperacaoLista?pagina=1
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Incluir ou alterar processo
Método responsável pro incluir processos em um produto.
A alteração de um processo se dará pelo mesmo método de inclusão. Caso o produto e a ordem informados já existam na base de dados, o processo será atualizado.
Exemplo de retorno:
[
{
"resultado": "Processo cadastrado com sucesso",
"produto": "ABC001"
}
]
Exemplo de retorno em caso de erro:
[
{
"method-error-400": "Não foi possível processar processo: ordem inválida."
}
]
Exemplo de retorno caso algum campo obrigatório não for informado ou for informado com um dado inválido:
[
{
"method-error-400": "Não foi possível processar processo: operacao inválida."
}
]
Exemplo de retorno em caso de alteração:
[
{
"resultado": "Processo alterado com sucesso.",
"produto": "ABC001"
}
]
URL
POST http://{ip_cliente}/Processo
Exemplo do corpo da requisição:
[
{
"ordem":1,
"grupo":"01",
"produto":"ABC001",
"operacao":"2379",
"descricao":"Teste Processo",
"perc":25,
"complemento":"Teste complemento",
"parte":"00",
"compri":1
}
]
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ordem | integer | Sim | Ordem |
| grupo | string / 5 | Não | Código do grupo de setores |
| produto | string / 15 | Sim | Código do produto |
| operacao | string / 5 | Sim | Código da operação |
| descricao | string / 100 | Não | Descrição do processo |
| perc | number / 9,2 | Sim | Percentual de dificuldade |
| complemento | string / 100 | Não | Complemento |
| parte | string / 2 | Não | Código da parte |
| compri | number / 5,2 | Não | Comprimento |
Excluir processo
Método responsável por excluir processos de um produto.
Exemplo de retorno:
[
{
"resultado": "Processo excluído com sucesso.",
"produto": "1010101"
}
]
URL
DELETE http://{ip_cliente}/Processo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição.
DELETE http://{ip_cliente}/Processo?produto=1010101&ordem=2&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| produto | string / 15 | Sim | Código do produto |
| ordem | integer | Sim | Ordem do processo |
| empresa | string / 4 | Não | Número da empresa |
Consultar lista de OPs
Método responsável por listar ordens de produção.
Exemplo de retorno:
http://{ip_cliente}/OPLista?emissao=01/01/2022
[
{
"numero": "000001",
"parte": "01",
"codigo": "ABC123",
"dt_inicio": "01/01/2022",
"periodo": "0001",
"partes": ["01","02"],
"pedido": "10212",
"tipo": "P",
"impof": "1",
"codcli": "00001",
"descricao": "PRODUTO EXEMPLO",
"maquina": "001",
"sequencial": 0,
"deposito": "000001",
"itens": [
{
"cor": "000",
"tam": "G",
"barracli": "ABC123/000/G",
"qtde": 10,
"qtde_b": 0,
"barra": "0000000000000"
},
{
"cor": "001",
"tam": "GG",
"barracli": "ABC123/001/GG",
"qtde": 10,
"qtde_b": 0,
"barra": "0000000000001"
}
]
},
{
"numero": "00002",
"parte": "01",
"codigo": "ABC234",
"dt_inicio": "02/01/2022",
"periodo": "0002",
"partes": ["00","01"],
"pedido": "10213",
"tipo": "P",
"impof": "1",
"codcli": "00001",
"descricao": "PRODUTO EXEMPLO",
"maquina": "001",
"sequencial": 1,
"deposito": "000001",
"itens": [
{
"cor": "001",
"tam": "4",
"barracli": "ABC234/001/4",
"qtde": 30,
"qtde_b": 30,
"barra": ""
},
{
"cor": "002",
"tam": "6",
"barracli": "ABC234/002/6",
"qtde": 45,
"qtde_b": 0,
"barra": "1000000000001"
},
{
"cor": "003",
"tam": "8",
"barracli": "ABC234/003/8",
"qtde": 50,
"qtde_b": 0,
"barra": ""
}
]
}
]
URL
GET http://{ip_cliente}/OPLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/OPLista?emissao=01/01/2022&numero=000001&pagina=1
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| emissao | date | Sim | Data de Emissão. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| numero | string / 6 | Não | Número da OP |
| tipo | string / 1 | Não | Tipo de OP |
| impof | integer | Não | Status da OP 0 - Pendente 1 - Fechada 2 - Cancelada 4 - Parada |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Movimentar OP
Método responsável pela movimentação de setores da facção da ordem de produção.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/MovimentarOP
[
{
"resultado": "OP movimentada com sucesso"
}
]
Exemplo de retorno caso algum campo obrigatório não for informado ou for informado com um dado inválido:
[
{
"method-error-400": "Não foi possível movimentar OP: terceiro_atual inválido."
}
]
URL
POST http://{ip_cliente}/MovimentarOP
Exemplo do corpo da requisição:
[
{
"op": "000001",
"parte": "01",
"setor_atual": "10",
"terceiro_atual": "10020",
"terceiro_dest": "10021",
"baixar_op": "S",
"itens": [
{
"barra_cli": "ABC123/000/M",
"cor": "000",
"tam": "M",
"qtde": 1,
"quant_i": 1,
"quant_2": 3
},
{
"barra_cli": "ABC123/000/G",
"cor": "000",
"tam": "G",
"qtde": 2,
"quant_i": 0,
"quant_2": 0
},
{
"barra_cli": "ABC123/000/GG",
"cor": "000",
"tam": "GG",
"qtde": 2,
"quant_i": 0,
"quant_2": 0
}
]
}
]
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| op | string / 6 | Sim | Número da OP |
| parte | string / 2 | Sim | Parte do produto |
| setor_atual | string / 3 | Sim | Setor a ser baixado |
| terceiro_atual | string / 5 | Não | Código interno do terceiro que será movimentado. Caso não informado, será utilizado o código da empresa no cadastro de entidades para processos internos, definido nos parâmetros do ERP. |
| terceiro_dest | string / 5 | Não | Código interno do terceiro do setor que será aberto. Caso não informado, será utilizado o código da empresa no cadastro de entidades para processos internos, definido nos parâmetros do ERP. |
| baixar_op | string / 1 | Não | Informar "S" se desejar movimentar o último setor do fluxo produtivo e baixar as quantidades pendentes na OP. |
| Itens | Objeto | Sim | Itens da OP |
| barra_cli | string / 25 | Sim (Caso não informado atributo barra) |
Código de barras do item |
| barra | string / 13 | Sim (Caso não informado atributo barra_cli) |
Código de barras EAN 13 do produto |
| cor | string / 6 | Sim (Caso não informados atributos barra ou barra_cli) |
Código da cor |
| tam | string / 4 | Sim (Caso não informados atributos barra ou barra_cli) |
Tamanho |
| qtde | integer | Sim | Quantidade a ser movimentada |
| quant_i | integer | Não | Quantidade de peças incompletas |
| quant_2 | integer | Não | Quantidade de peças de segunda qualidade |
Consultar movimentação de OP
Método responsável por consultar a movimentação de uma ordem de produção
Exemplo de retorno:
[
{
"numero": "100000",
"parte": "01",
"setor": "04",
"codigo": "ABC1234",
"itens": [
{
"cor": "001",
"tam": "10",
"barracli": "ABC123400110",
"barra": "01234567890123",
"qt_orig": 100,
"quant": 100,
"quant_2": 0,
"quant_i": 0,
"codcli": "00001",
"custo": 1.0
},
{
"cor": "001",
"tam": "12",
"barracli": "ABC123400112",
"barra": "01234567890124",
"qt_orig": 100,
"quant": 90,
"quant_2": 5,
"quant_i": 5,
"codcli": "00001",
"custo": 1.10
},
{
"cor": "001",
"tam": "14",
"barracli": "ABC123400114",
"barra": "01234567890126",
"qt_orig": 100,
"quant": 98,
"quant_2": 1,
"quant_i": 1,
"codcli": "00001",
"custo": 1.12
}
]
}
]
URL
GET http://{ip_cliente}/BuscarMovimentacaoOP
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/BuscarMovimentacaoOP?numero=100000&parte=01&setor=02
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da OP |
| parte | string / 2 | Sim | Parte do produto |
| setor | string / 3 | Sim | Setor da movimentação |
| codcli | string / 5 | Não | Código do terceiro |
Incluir apontamento OP
Método responsável pela inclusão de apontamentos nas ordens de produção
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Apontamento cadastrado com sucesso."
}
]
URL
POST http://{ip_cliente}/ApontamentoOP
Exemplo do corpo da requisição:
[
{
"numero": "000001",
"codigo": "ABCD1234",
"data": "25/01/2023",
"codfun": "00001",
"hr_inicio": "12:00:01",
"hr_fim": "13:00:01",
"hr_total": 1,
"maquina": "001",
"motivo": "01",
"turno": "1",
"setor": "05",
"descricao": "DESCRIÇÃO EXEMPLO",
"qtde": 2,
"qtde_def": 1
}
]
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da OP |
| codigo | string / 2 | Sim | Código do insumo |
| data | string / 3 | Sim | Data do apontamento |
| codfun | string / 5 | Sim | Código do funcionário |
| hr_inicio | string / 5 | Sim | Hora de início (Utilizar o formato HH:MM:SS) |
| hr_fim | string / 25 | Sim | Hora de conclusão (Utilizar o formato HH:MM:SS) |
| hr_total | string / 13 | Não | Quantidade total de horas. Utilizar formato decimal. Ex: 1:30 deve ser informado 1.5 |
| maquina | integer | Sim | Código da máquina |
| motivo | Sim | Código do motivo | |
| turno | Sim | Turno correspondente ao horário do apontamento | |
| setor | Não | Código do setor | |
| descricao | Não | Descrição ou observação do apontamento | |
| qtde | Sim | Quantidade apontada | |
| qtde_def | Sim | Quantidade de defeitos |
Buscar apontamento
Método responsável por buscar os apontamentos de uma ordem de produção.
Exemplo de retorno:
[
{
"numero": "007366",
"codigo": "10000000",
"data": "04/01/2023",
"codfun": "00008",
"hr_inicio": "00:00:00",
"hr_fim": "00:22:00",
"hr_total": 0.3667,
"maquina": "203",
"motivo": "01",
"turno": "3",
"setor": "",
"descricao": "",
"qtde": 1,
"qtde_def": 0
},
{
"numero": "007366",
"codigo": "20000000",
"data": "05/01/2023",
"codfun": "00007",
"hr_inicio": "00:00:00",
"hr_fim": "01:35:00",
"hr_total": 1.5833,
"maquina": "203",
"motivo": "01",
"turno": "3",
"setor": "",
"descricao": "OBSERVAÇÃO TESTE",
"qtde": 3,
"qtde_def": 1
}
]
URL
GET http://{ip_cliente}/BuscarApontamentoOP
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/BuscarApontamentoOP?numero=100000
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da ordem de produção |
Processar apontamento de produção
Método responsável pelo processamento de um apontamento de produção têxtil.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/ProcessarProducao?numero=012345&funcionario=00001&tipo=T&operacao=00001&pacote=001&empresa=001
[
{
"resultado": "Apontamento cadastrado com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"qtde": 10
}
]
URL
POST http://{ip_cliente}/ProcessarProducao
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/ProcessarProducao?numero=012345&funcionario=00001&tipo=T&operacao=00001&pacote=001&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Sim | Número da ordem de produção |
| funcionario | string / 5 | Sim | Código do funcionário do apontamento |
| tipo | string / 1 | Sim | Utilizar sempre a letra T |
| operacao | string / 5 | Sim | Código da operação a ser apontada |
| pacote | string / 3 | Sim | Número do pacote |
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| qtde | number / 9,2 | Sim | Quantidade a ser apontada |
Incluir produção por funcionário
Método responsável por incluir apontamento de produção por funcionário.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
http://{ip_cliente}/ProducaoFuncionario?empresa=001
[
{
"resultado": "Produção funcionário cadastrada com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"numero": "000001",
"tam": "GG",
"data_emi": "01/01/2023",
"qtde": 1,
"funcionario": "00000001",
"operacao": "00001",
"defeitos": 1,
"parte": "00"
}
]
URL
POST http://{ip_cliente}/ProducaoFuncionario
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/ProducaoFuncionario?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / 6 | Não | Número da ordem de produção |
| tam | string / 4 | Não | Tamanho do produto |
| data_emi | date | Não | Data do apontamento |
| qtde | number / 5,2 | Não | Quantidade produzida |
| funcionario | string / 8 | Não | Código do funcionário |
| operacao | string / 5 | Não | Código da operação |
| defeitos | integer | Não | Quantidade de defeitos |
| parte | string / 2 | Não | Código da parte do produto |
Ordem de tinturaria
Consultar lista de ordens de tinturaria
Método responsável por listar ordens de tinturaria.
Exemplo de retorno:
http://{ip_cliente}/OrdemTinturaria?dats=01/01/2022
[
{
"numero": "000001",
"ficha": "12345",
"cnpj": "00.000.000/0001-00",
"dats": "01/01/2023",
"datr": "10/01/2023",
"observacao": "Observação ordem de tinturaria",
"itens": [
{
"codigo": "20000-1",
"cor": "0001",
"cort": "001-20",
"fluxo": "10",
"desc_fluxo": "DESCRICAO FLUXO",
"custo": 1.55,
"custo_fluxo": 0.2,
"peso_liquido": 360.5,
"rolos": 6,
"gramatura": "450",
"largura": 171,
"situacao": "A",
"obs": "Observação Item"
},
{
"codigo": "20000-1",
"cor": "0002",
"cort": "002-20",
"fluxo": "20",
"desc_fluxo": "DESCRICAO FLUXO",
"custo": 1.55,
"custo_fluxo": 0.2,
"peso_liquido": 360.5,
"rolos": 6,
"gramatura": "450",
"largura": 171,
"situacao": "A",
"obs": "Observação Item"
}
]
},
{
"numero": "000002",
"ficha": "54321",
"cnpj": "00.000.000/0001-00",
"dats": "02/01/2023",
"datr": "12/01/2023",
"observacao": "",
"itens": [
{
"codigo": "14700-1",
"cor": "0003",
"cort": "003-20",
"fluxo": "10",
"desc_fluxo": "DESCRICAO FLUXO",
"custo": 3.55,
"custo_fluxo": 0.2,
"peso_liquido": 358.2,
"rolos": 6,
"gramatura": "500",
"largura": 171,
"situacao": "B",
"obs": ""
}
]
}
]
URL
GET http://{ip_cliente}/OrdemTinturaria
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/OrdemTinturaria?dats=01/01/2023&cnpj=00.000.000/0001-00&empresa=001&pagina=1
É possível consultar apenas uma ordem de tinturaria informando o número como path param
GET http://{ip_cliente}/OrdemTinturaria/010203
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| dats | date | Sim (Caso não informado o parâmetro numero) |
Data de saída. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| numero | string / 6 | Sim (Caso não informado o parâmetro dats) |
Número da ordem de tinturaria |
| cnpj | string / 18 | Não | CNPJ da tinturaria |
| empresa | string / 3 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Ordem de malharia
Consultar lista de ordens de malharia
Método responsável por listar ordens de malharia.
Exemplo de retorno:
[
{
"num_of": "000001",
"data": "01/01/2024",
"cliente": "00101",
"nome": "CLIENTE EXEMPLO 1",
"material": "11000000",
"desc_material": "MALHA EXEMPLO ",
"maquina": "001",
"fluxo": "01",
"kg_total": 500,
"kg_rolo": 15,
"observacao": "OBSERVAÇÃO EXEMPLO"
},
{
"num_of": "000002",
"data": "01/01/2024",
"cliente": "00102",
"nome": "CLIENTE EXEMPLO 2",
"material": "12000000",
"desc_material": "MALHA EXEMPLO ",
"maquina": "001",
"fluxo": "01",
"kg_total": 691.37,
"kg_rolo": 20,
"observacao": "OBSERVAÇÃO EXEMPLO"
}
]
URL
GET http://{ip_cliente}/OrdemMalharia
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/OrdemMalharia?data=01/01/2024&material=12000000&empresa=001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim (Caso não informado o parâmetro dt_altera) |
Data de emissão. Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| dt_altera | timestamp | Sim (Caso não informado o parâmetro data) |
Data de alteração. Utilizar o formato DD/MM/YYYY HH:MM:SS |
| cliente | string / 5 | Não | Código do cliente |
| material | string / 15 | Não | Código da malha |
| empresa | string / 3 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Consultar ordem de malharia
Método responsável por retornar os dados de uma determinada ordem de malharia a partir do número.
Exemplo de retorno:
[
{
"num_of": "000001",
"data": "01/01/2024",
"cliente": "00002",
"nome": "CLIENTE EXEMPLO",
"material": "15000000",
"desc_material": "MALHA EXEMPLO",
"maquina": "001",
"fluxo": "01",
"kg_total": 6010,
"kg_rolo": 20,
"baixado": 4010,
"saldo": 2000,
"observacao": "OBSERVAÇÃO EXEMPLO",
"itens": [
{
"codigo": "10000050",
"descricao": "FIO 1",
"docto": "47017",
"marca": "Marca Fio",
"lote": "1032145",
"qtde": 5529.2,
"saldo": 1840,
"reserva": 5529.2
},
{
"codigo": "10000005",
"descricao": "FIO 2",
"docto": "4064",
"marca": "Marca fio 2",
"lote": "0001144",
"qtde": 480.8,
"saldo": 160,
"reserva": 480.8
}
]
}
]
URL
GET http://{ip_cliente}/OrdemMalharia/:numero
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o número informado como path param, exemplo:
GET http://{ip_cliente}/OrdemMalharia/000001?empresa=001
Onde "000001" representa o número da ordem de malharia.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número da ordem de malharia |
| empresa | string / 3 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Funcionário
Consultar lista de funcionários
Método responsável por listar todos funcionários ativos.
Exemplo de retorno com a listagem dos funcionários:
http://{ip_cliente}/FuncionarioLista
[
{
"codigo": "00001",
"nome": "JOÃO SILVA",
"turno": "1",
"cargo": "30",
"setor": "01"
},
{
"codigo": "00002",
"nome": "MARIA PEREIRA",
"turno": "2",
"cargo": "01",
"setor": "10"
},
{
"codigo": "00003",
"nome": "PEDRO PASSOS",
"turno": "4",
"cargo": "36",
"setor": "105"
}
]
URL
GET http://{ip_cliente}/FuncionarioLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Buscar funcionário
Método responsável por consultar os dados de um funcionário. Retorna nome e os setores aos quais o funcionário possui acesso.
Exemplo de retorno:
http://{ip_cliente}/BuscarFuncionario?codigo=0000
[
{
"codigo": "0000",
"nome": "FUNCIONARIO EXEMPLO",
"setores": [
{
"setor": "2",
"desc_setor": "OXIC BURNY"
},
{
"setor": "10",
"desc_setor": "LASER"
},
{
"setor": "11",
"desc_setor": "DOBRA"
}
]
}
]
URL
GET http://{ip_cliente}/BuscarFuncionario
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/BuscarFuncionario?codigo=0000
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 8 | Sim | Código do funcionário para consulta |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Defeito
Consultar lista de defeitos
Método responsável por listar todos os defeitos disponíveis.
Exemplo de retorno com a listagem dos defeitos:
http://{ip_cliente}/DefeitoLista
[
{
"codigo": "01",
"setor": "30",
"descricao": "Peça fora de Medida",
"qualidade": "2"
},
{
"codigo": "02",
"setor": "30",
"descricao": "Interferindo no visual da peça",
"qualidade": "2"
},
{
"codigo": "03",
"setor": "30",
"descricao": "Marca de gabarito",
"qualidade": "2"
}
]
URL
GET http://{ip_cliente}/DefeitoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/DefeitoLista?grupo=05
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| grupo | string / 2 | Não | Código do grupo de defeitos |
Máquina
Consultar máquina
Método responsável por consultar os dados de uma máquina.
Exemplo de retorno:
[
{
"maquina": "001",
"nome": "MAQUINA",
"descricao": "MAQUINA EXEMPLO",
"setor": "01"
}
]
URL
GET http://{ip_cliente}/Maquina/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Maquina/001
Onde "001" representa o código da máquina consultada.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código da máquina |
Consultar lista de máquinas
Método responsável por listar todas as máquinas cadastradas.
Exemplo de retorno:
http://{ip_cliente}/MaquinaLista
[
{
"maquina": "01",
"nome": "OVERLOCK SIMPLES",
"descricao": "OVERLOCK SIMPLES",
"setor": "20"
},
{
"maquina": "02",
"nome": "COBERTURA 1 AGULHA",
"descricao": "COBERTURA 1 AGULHA",
"setor": "20"
}
]
URL
GET http://{ip_cliente}/MaquinaLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Setor
Consultar setor
Método responsável por consultar os dados de um setor.
Exemplo de retorno:
[
{
"codigo": "10",
"descricao": "PCP",
"tipo": "P"
}
]
URL
GET http://{ip_cliente}/Setor/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Setor/10
Onde "10" representa o código do setor consultado.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do setor |
Consultar lista de setores
Método responsável por listar todos os setores cadastrados.
Exemplo de retorno:
http://{ip_cliente}/SetorLista
[
{
"codigo": "01",
"descricao": "PPCP",
"tipo": "P"
},
{
"codigo": "02",
"descricao": "CORTE",
"tipo": "P"
},
{
"codigo": "03",
"descricao": "COSTURA",
"tipo": "P"
}
]
URL
GET http://{ip_cliente}/SetorLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Prazo
Consultar lista de prazos
Método responsável por disponibilizar uma listagem do cadastro de prazos.
Exemplo de retorno com os dados dos representantes:
http://{ip_cliente}/PrazoLista
[
{
"prazo": "001",
"dt_fim": "31/05/2019",
"dt_inicio": "01/01/2019",
"descricao": "PRAZO 001",
"minuto": 0,
"tipo": "P",
"ativo": "S"
},
{
"prazo": "002",
"dt_fim": "31/12/2019",
"dt_inicio": "01/06/2019",
"descricao": "PRAZO 002",
"minuto": 0,
"tipo": "P",
"ativo": "S"
},
{
"prazo": "003",
"dt_fim": "31/05/2020",
"dt_inicio": "01/01/2020",
"descricao": "PRAZO 003",
"minuto": 0,
"tipo": "P",
"ativo": "S"
}
]
URL
GET http://{ip_cliente}/PrazoLista
Retorno
A consulta irá retornar todos os prazos cadastrados no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Ordens de compra
Consultar lista de ordens de compra
Método responsável por disponibilizar uma listagem das ordens de compra cadastradas no ERP.
Exemplo de retorno:
[
{
"numero": "000001",
"dt_emissao": "14/04/2022",
"codfor": "00001",
"nome_for": "FORNECEDOR EXEMPLO LTDA.",
"classe": "1075",
"desc_classe": "AVIAMENTOS",
"desconto": 0,
"condicao": "28 45 56",
"dt_entrega": "18/04/2022",
"valor_total": 682.5,
"empresa": "_001",
"obs": "",
"usuario": "EXCIA",
"email_usuario": "email@exemplo.com",
"valor_ipi": 0
},
{
"numero": "000002",
"dt_emissao": "14/04/2022",
"codfor": "00002",
"nome_for": "FORNECEDOR EXEMPLO 2 LTDA.",
"classe": "1075",
"desc_classe": "MALHAS",
"desconto": 3,
"condicao": "30 60",
"dt_entrega": "18/04/2022",
"valor_total": 1435,
"empresa": "_001",
"obs": "",
"usuario": "EXCIA",
"email_usuario": "email@exemplo.com",
"valor_ipi": 0
}
]
URL
GET http://{ip_cliente}/OrdemCompra
Retorno
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/OrdemCompra?usuario=NOME_USUARIO&todas_empresas=S&empresa=001&cnpj=00.000.000/0000-00&dt_emissao_ini=01/01/2022
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| dt_emissao_ini | date | Sim | Data de emissão inicial |
| dt_emissao_fim | date | Não | Data de emissão final |
| dt_entrega_ini | date | Não | Data de entrega inicial |
| dt_entrega_fim | date | Não | Data de entrega final |
| cnpj | string / 18 | Não | CNPJ ou CPF do cliente devidamente formatado |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
| todas_empresas | string / 1 | Não | Consultar, ou não, em todas as empresas cadastradas no ERP ( S / N ) |
| usuario | string / 20 | Sim (Caso informado parâmetro todas_empresas = S) |
Nome do usuário para consulta |
| liberado | string / 1 | Não | Status S - Liberado N - Bloqueado Se não informado retornará apenas as ordens de compra com status "Em análise". |
| situacao | string / 1 | Não | A - Aberto B - Baixado |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Consultar uma ordem de compra
Método responsável por disponibilizar os detalhes de uma ordem de compra em específico.
Exemplo de retorno:
[
{
"numero": "009357",
"dt_emissao": "01/01/2024",
"dt_entrega": "15/01/2024",
"codfor": "00001",
"desc_for": "FORNECEDOR EXEMPLO LTDA.",
"classe": "1075",
"desc_classe": "AVIAMENTOS",
"desconto": 0,
"condicao": "30 60 90",
"obs": "Observação teste.",
"valor_total": 682.5,
"usuario": "JOAO",
"email_usuario": "email@exemplo.com.br",
"itens": [
{
"codigo": "998877",
"descricao": "PRODUTO 001",
"preco": 27.3,
"qtde": 25,
"tp_item": "P",
"valor": 682.5,
"cor": "0",
"desc_cor": "UNICO",
"obs": "Observação: Este é um produto.",
"ordem": 1,
"unidade": "UN",
"tam": "0",
"especifica": "",
"dt_entrega": "15/01/2024",
"dt_fatura": "15/01/2024",
"ipi": 0,
"icms": 0,
"barra": "0000000000000",
"lote": "000000"
},
{
"codigo": "778899",
"descricao": "MATERIAL 001",
"preco": 10,
"qtde": 12,
"tp_item": "M",
"valor": 120,
"cor": "0",
"desc_cor": "UNICO",
"obs": "Observação: Este é um material.",
"ordem": 2,
"unidade": "UN",
"tam": "0",
"especifica": "",
"dt_entrega": "15/01/2024",
"dt_fatura": "15/01/2024",
"ipi": 0,
"icms": 0,
"barra": "0000000000000",
"lote": "000000"
}
]
}
]
URL
GET http://{ip_cliente}/OrdemCompra/:numero
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
O número da ordem de compra deve ser informado como path param e demais parâmetros como query param, por exemplo:
GET http://{ip_cliente}/OrdemCompra/:009372?empresa=002
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número da ordem de compra |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Baixar ordem de compra
Método responsável por baixar uma ordem de compra.
Permite escolher se movimenta estoque ou não.
Apenas ordens de compra com status liberado podem ser baixadas.
Exemplo de retorno:
[
{
"resultado": "Movimentação concluída"
}
]
Exemplo do corpo da requisição:
[
{
"ordem": 1,
"tp_item": "P",
"barra": "1000000000000",
"codigo": "123456",
"cor": "01",
"tam": "P",
"lote": "000000",
"qualidade": "1",
"deposito": "0001",
"qtde": 10
},
{
"ordem": 2,
"tp_item": "P",
"barra": "1000000000000",
"codigo": "123456",
"cor": "01",
"tam": "M",
"lote": "000000",
"qualidade": "1",
"deposito": "0001",
"qtde": 10
}
]
URL
PATCH http://{ip_cliente}/OrdemCompra/Baixa/:numero
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, sendo o número informado como path param, por exemplo:
PATCH http://{ip_cliente}/OrdemCompra/Baixa/12345?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| numero | string / path param | Sim | Número da ordem de compra |
| movimentar_estoque | string / 1 | Não | S: Efetua a entrada de estoque dos itens da ordem de compra N: Não efetua a entrada de estoque |
| empresa | string / 4 | Não | Número da empresa para alteração (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ordem | Integer | Sim | Ordem do item |
| tp_item | string / 1 | Sim | Tipo do item P: Produto M: Material |
| barra | string / 13 | Sim* | Código de barras |
| codigo | string / 15 | Sim* | Código do item |
| cor | string / 6 | Sim* | Código da cor |
| tam | string / 4 | Sim* | Tamanho |
| lote | string / 15 | Sim | Número do lote |
| qualidade | string / 1 | Não | Qualidade para movimentação de estoque |
| deposito | string / 6 | Sim | Código do depósito |
| qtde | number | Sim | Quantidade a ser baixada |
*A movimentação pode ser efetuada através do código de barras ou por código cor e tamanho.
Notas de Entrada
Incluir nota de entrada
Método responsável por incluir nota fiscal de entrada.
Esse método não faz recálculo automático de totais e impostos. Todas informações da nota fiscal devem ser informadas corretamente.
Esse método não movimenta estoque e não gera financeiro.
A obrigatoriedade de campos pode variar de acordo com questões fiscais e tributárias.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Nota entrada gravada com sucesso",
"notafiscal": "12346",
"serie": "3",
"credor": "31553"
}
]
Exemplo do corpo da requisição:
[
{
"aliq_dif": 0,
"aliquota": 0,
"base_csll": 0,
"base_icm": 0,
"base_icms_dif": 0,
"base_inss": 0,
"base_ipi": 0,
"base_irrf": 0,
"base_iss": 0,
"base_st": 0,
"cod_ajus_dif": "",
"cofins": 0,
"cofins_ret": 0,
"condicao": "30 60",
"credor": "31553",
"desconto": 0,
"despesa": 0,
"docto": "12345",
"dt_emissao": "01/01/2025",
"dt_entrada": "01/01/2025",
"frete": 0,
"fretenf": 0,
"grupo": "001",
"isenta_icm": 0,
"isenta_ipi": 0,
"mensagem": "Dados adicionais",
"motivo": "00",
"natureza": "1101",
"notafiscal": "12346",
"nsu": "0",
"outras_icm": 0,
"outras_ipi": 0,
"pis": 0,
"pis_ret": 0,
"serie": "3",
"tipo": "01",
"tp_frete": "1",
"val_cardex": 0,
"val_icms_dif": 0,
"val_import": 0,
"val_produtos": 0,
"valor": 0,
"valor_csll": 0,
"valor_icm": 0,
"valor_inss": 0,
"valor_ipi": 0,
"valor_irrf": 0,
"valor_iss": 0,
"valor_st": 0,
"itens": [
{
"base_cofins": 0,
"base_icms": 0,
"base_ipi": 0,
"base_pis": 0,
"base_st": 0,
"clafis": "64",
"clatrib": "01",
"codigo": "10001",
"codsped": "01",
"cofins": 0,
"cor": "0101",
"deposito": "0001",
"descricao": "PRODUTO EXEMPLO",
"docto": "12345",
"estoque": "N",
"icms": 0,
"lote": "000000",
"natureza": "1101",
"origem": "0",
"pis": 0,
"qtde": 1,
"tam": "3",
"tipo": "P",
"trib_cofins": "01",
"trib_ipi": "01",
"trib_pis": "01",
"unidade": "PC",
"val_desc": 0,
"val_frete": 0,
"val_icms": 0,
"val_ipi": 0,
"valor": 10,
"valor_st": 0,
"valor_tot": 10,
"vlr_ipi": 0
},
{
"base_cofins": 0,
"base_icms": 0,
"base_ipi": 0,
"base_pis": 0,
"base_st": 0,
"clafis": "64",
"clatrib": "01",
"codigo": "0100100",
"codsped": "01",
"cofins": 0,
"cor": "0",
"deposito": "0001",
"descricao": "MATERIAL EXEMPLO",
"docto": "12345",
"estoque": "N",
"icms": 0,
"lote": "000000",
"natureza": "1101",
"origem": "0",
"pis": 0,
"qtde": 1,
"tam": "0",
"tipo": "M",
"trib_cofins": "01",
"trib_ipi": "01",
"trib_pis": "01",
"unidade": "PC",
"val_desc": 0,
"val_frete": 0,
"val_icms": 0,
"val_ipi": 0,
"valor": 10,
"valor_st": 0,
"valor_tot": 10,
"vlr_ipi": 0
}
],
"nf_vinculada": [
{
"nota": "000001",
"serie": "1",
"tipo": "S"
}
]
}
]
URL
POST http://{ip_cliente}/NotaEntrada
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/NotaEntrada?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| aliq_dif | number / 9,2 | Não | Alíquota diferenciais |
| aliquota | number / 5,2 | Não | Alíquota de ICMS |
| base_csll | number / 9,2 | Não | Base de cálculo CSLL |
| base_icm | number / 11,2 | Não | Base de cálculo ICMS |
| base_icms_dif | number / 9,2 | Não | Base de cálculo ICMS diferenciais |
| base_inss | number / 11,2 | Não | Base de cálculo INSS |
| base_ipi | number / 11,2 | Não | Base de cálculo IPI |
| base_irrf | number / 9,2 | Não | Base de cálculo IRRF |
| base_iss | number / 9,2 | Não | Base de cálculo ISS |
| base_st | number / 9,2 | Não | Base de cálculo ST |
| cod_ajus_dif | string / 10 | Não | Código de ajuste diferenciais |
| cofins | number / 9,2 | Não | Valor total COFINS |
| cofins_ret | number / 9,2 | Não | Valor total retenção COFINS |
| condicao | string / 27 | Não | Condição de pagamento |
| credor | string / 6 | Sim | Código do fornecedor |
| desconto | number / 11,2 | Não | Valor desconto |
| despesa | number / 11,2 | Não | Valor despesas |
| docto | string / 15 | Não | Número do documento / ordem de compra |
| dt_emissao | date | Não | Data de emissão |
| dt_entrada | date | Não | Data de entrada |
| frete | number / 11,2 | Não | Valor frete CT-e |
| fretenf | number / 9,2 | Não | Valor frete nota fiscal |
| grupo | string / 6 | Não | Código da classe gerencial |
| isenta_icm | number / 11,2 | Não | Valor total isenta ICMS |
| isenta_ipi | number / 11,2 | Não | Valor total isenta IPI |
| mensagem | blob | Não | Dados adicionais da nota fiscal |
| motivo | string / 3 | Não | Código do motivo |
| natureza | string / 7 | Sim | Código da natureza de operação |
| notafiscal | string / 9 | Sim | Número da nota fiscal |
| nsu | string / 50 | Sim | Chave da nota fiscal |
| outras_icm | number / 11,2 | Não | Valor total outras ICMS |
| outras_ipi | number / 11,2 | Não | Valor total outras IPI |
| pis | number / 9,2 | Não | Valor total PIS |
| pis_ret | number / 9,2 | Não | Valor total retenção PIS |
| serie | string / 3 | Não | Série da nota fiscal |
| tipo | string / 3 | Não | Tipo do documento |
| tp_frete | string / 1 | Não | Tipo de frete: 1: (CIF) Emitente 2: (FOB) Destinatario 3: Terceiro 4: Sem Frete 5: Próprio (Rem.) 6: Próprio (Dest.) |
| val_cardex | number / 11,2 | Não | Valor total cardex |
| val_icms_dif | number / 9,2 | Não | Valor total diferenciais |
| val_import | number / 11,2 | Não | Valor total importação |
| val_produtos | number / 11,2 | Não | Valor total dos produtos |
| valor | number / 11,2 | Não | Valor total da nota fiscal |
| valor_csll | number / 9,2 | Não | Valor total CSLL |
| valor_icm | number / 11,2 | Não | Valor total ICMS |
| valor_inss | number / 11,2 | Não | Valor total INSS |
| valor_ipi | number / 11,2 | Não | Valor total IPI |
| valor_irrf | number / 9,2 | Não | Valor total IRRF |
| valor_iss | number / 9,2 | Não | Valor total ISS |
| valor_st | number / 9,2 | Não | Valor total ST |
| itens | Objeto | Sim | Itens da nota |
| base_cofins | number / 9,2 | Não | Base de cálculo COFINS |
| base_icms | number / 9,2 | Não | Base de cálculo ICMS |
| base_ipi | number / 9,2 | Não | Base de cálculo IPI |
| base_pis | number / 9,2 | Não | Base de cálculo PIS |
| base_st | number / 9,2 | Não | Base de cálculo ST |
| clafis | string / 3 | Sim | Código da classificação fiscal |
| clatrib | string / 3 | Sim | Código da classificação tributária de ICMS |
| codigo | string / 15 | Sim | Código do item |
| codsped | string / 3 | Sim | Código SPED |
| cofins | number / 9,4 | Não | Alíquota COFINS |
| cor | string / 6 | Sim | Código da cor do item |
| deposito | string / 6 | Não | Código do depósito |
| descricao | string / 100 | Não | Descrição do item |
| docto | string / 7 | Não | Número do documento / ordem de compra |
| estoque | string / 1 | Não | Indica se houve entrada de estoque ( S / N ) |
| icms | number / 5,2 | Não | Alíquota de ICMS |
| lote | string / 15 | Sim | Lote do item |
| natureza | string / 7 | Sim | Código da natureza de operação |
| origem | string / 2 | Não | Origem |
| pis | number / 9,4 | Não | Alíquota de PIS |
| qtde | number / 12,4 | Sim | Quantidade do item |
| tam | string / 4 | Sim | Tamanho do item (0 para materiais) |
| tipo | string / 1 | Sim | Tipo do item P: Produto M: Material |
| trib_cofins | string / 3 | Sim | Código da classificação tributária de COFINS |
| trib_ipi | string / 3 | Sim | Código da classificação tributária de IPI |
| trib_pis | string / 3 | Sim | Código da classificação tributária de PIS |
| unidade | string / 6 | Sim | Unidade do item |
| val_desc | number / 9,2 | Não | Valor de desconto |
| val_frete | number / 9,2 | Não | Valor do frete |
| val_icms | number / 9,2 | Não | Valor de ICMS |
| val_ipi | number / 9,2 | Não | Valor de IPI |
| valor | number / 12,5 | Sim | Preço do item |
| valor_st | number / 9,2 | Não | Valor de ST |
| valor_tot | number / 12,2 | Sim | Valor total do item |
| vlr_ipi | number / 9,2 | Não | Alíquota de IPI |
| nf_vinculada | Objeto | Não | NF's Vinculadas |
| nota | string / 9 | Sim | Número da NF vinculada |
| serie | string / 3 | Sim | Série da NF vinculada |
| tipo | string / 1 | Sim | Tipo de documento S: Saída C: Entrada |
Consultar lista de notas de entrada
Método responsável por disponibilizar uma listagem de notas fiscais de entrada.
Exemplo de retorno:
[
{
"notafiscal": "12345",
"serie": "1",
"docto": "4455",
"tipo": "55",
"credor": "00001",
"nome": "FORNECEDOR EXEMPLO",
"cnpj": "00.000.000/0001-00",
"dt_emissao": "01/01/2000",
"dt_entrada": "01/01/2000",
"natureza": "2101.0"
},
{
"notafiscal": "12346",
"serie": "1",
"docto": "4456",
"tipo": "55",
"credor": "00001",
"nome": "FORNECEDOR EXEMPLO",
"cnpj": "00.000.000/0001-00",
"dt_emissao": "01/01/2000",
"dt_entrada": "01/01/2000",
"natureza": "2101.0"
}
]
URL
GET http://{ip_cliente}/NotaEntrada
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/NotaEntrada?emissao=01/01/2022&empresa=001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| emissao | date | Sim | Data de emissão |
| entrada | date | Não | Data de entrada |
| credor | string / 5 | Não | Código do credor / emissor |
| docto | string / 15 | Não | Número do documento referenciado à nota |
| tipo | string / 3 | Não | Tipo fiscal |
| notafiscal | string / 9 | Não | Número da nota |
| serie | string / 3 | Não | Número da série da nota |
| tipo_natureza | string / 1 | Não | Tipo da natureza de operação V - Venda/Compra D - Devolução R - Retorno/Remessa C - Consignação A - Antecipação S - Serviço B - Bonificação/Brindes I - Imposto Complementar J - Ajuste E - Crédito T - Débito |
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
| pagina | number | Não | Número da página |
Consultar uma nota de entrada
Método responsável por disponibilizar os detalhes de uma nota fiscal de entrada.
Exemplo de retorno:
[
{
"notafiscal": "001234",
"serie": "1",
"docto": "123456",
"tipo": "55",
"credor": "00111",
"nome": "CLIENTE EXEMPLO",
"cnpj": "00.000.000/0001-00",
"dt_emissao": "01/01/2024",
"dt_entrada": "01/01/2000",
"mensagem": "Dados adicionais da nota de exemplo.",
"nf_vinculada": [
{
"nota": "112233",
"serie": "1",
"tipo": "S"
},
{
"nota": "112234",
"serie": "1",
"tipo": "S"
}
],
"itens": [
{
"ordem": 1,
"tipo": "P",
"barra": "7897897897891",
"codigo": "001122",
"cor": "0002",
"tam": "P",
"lote": "000000",
"qtde": 10.0,
"docto": "001122",
"valor": 10.0
},
{
"ordem": 2,
"tipo": "P",
"barra": "7897897897892",
"codigo": "001122",
"cor": "0002",
"tam": "M",
"lote": "000000",
"qtde": 10.0,
"docto": "001122",
"valor": 10.0
}
]
}
]
URL
GET http://{ip_cliente}/NotaEntrada/:credor/:numero/:serie
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros credor, número e série da nota devem ser informado como path param e demais parâmetros como query param, por exemplo:
GET http://{ip_cliente}/NotaEntrada/00001/12345/1?empresa=001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| credor | string / path param | Sim | Código do credor / emissor da nota |
| numero | string / path param | Sim | Número da nota |
| serie | string / path param | Sim | Número da série da nota |
| empresa | string / 4 | Não | Número da empresa para consulta (ex.: 001 ou _002) |
Grupo
Incluir grupo
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Grupo cadastrado com sucesso",
"codigo": "001"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar grupo: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "DESCRICAO GRUPO",
"prioridade": "1",
"lote": "S",
"preco": "S"
}
]
Método responsável pela inclusão de grupos de produtos / materiais
URL
POST http://{ip_cliente}/Grupo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Sim | Descrição do grupo |
| prioridade | string / 1 | Sim | Prioridade "1" ou "2" |
| lote | string / 1 | Sim | Controla lote |
| preco | string / 1 | Sim | Controla preço de compra |
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/Grupo?tipo=M
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Não | Tipo de grupo P - Produto M - Material (Caso não informado, será Produto, por padrão) |
Consultar grupo
Método responsável por consultar os dados de um grupo.
Exemplo de retorno:
[
{
"codigo": "014",
"descricao": "GRUPO EXEMPLO",
"prioridade": "2",
"lote": "N",
"preco": "N"
}
]
URL
GET http://{ip_cliente}/Grupo/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Grupo/014
Onde "014" representa o código do grupo consultado.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do grupo |
Consultar lista de grupos
Método responsável por disponibilizar uma listagem do cadastro de grupos de produtos.
Exemplo de retorno:
http://{ip_cliente}/GrupoLista
[
{
"codigo": "01",
"descricao": "GRUPO 01",
"prioridade": "1",
"lote": "",
"preco": ""
},
{
"codigo": "02",
"descricao": "GRUPO 02",
"prioridade": "0",
"lote": "",
"preco": ""
},
{
"codigo": "03",
"descricao": "GRUPO 03",
"prioridade": "",
"lote": "",
"preco": ""
}
]
URL
GET http://{ip_cliente}/GrupoLista
Retorno
A consulta irá retornar os dados dos grupos de produtos/materiais cadastrados no ERP EXCIA.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/GrupoLista?tipo=P
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Não | Tipo de grupo. P - Produto M - Material |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Subgrupo
Consultar subgrupo
Método responsável por consultar os dados de um subgrupo de materiais.
Exemplo de retorno:
[
{
"codigo": "0004",
"descricao": "SUBGRUPO EXEMPLO",
"grupo": "10"
}
]
URL
GET http://{ip_cliente}/SubGrupo/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/SubGrupo/0004
Onde "0004" representa o código do subgrupo consultado.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do subgrupo |
Consultar lista de subgrupos
Método responsável por disponibilizar uma listagem do cadastro de subgrupos de materiais.
Exemplo de retorno:
http://{ip_cliente}/SubGrupoLista
[
{
"codigo": "0001",
"descricao": "SUBGRUPO 1",
"grupo": "120"
},
{
"codigo": "0002",
"descricao": "SUBGRUPO 2",
"grupo": "100"
},
{
"codigo": "0003",
"descricao": "SUBGRUPO 3",
"grupo": "150"
}
]
URL
GET http://{ip_cliente}/SubGrupoLista
Retorno
A consulta irá retornar os dados dos subgrupos de materiais cadastrados no ERP EXCIA.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/SubGrupoLista?pagina=1
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Marca
Incluir marca
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Marca cadastrada com sucesso",
"codigo": "001"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar marca: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "DESCRIÇÃO MARCA"
}
]
Método responsável pela inclusão de marcas.
URL
POST http://{ip_cliente}/Marca
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Sim | Descrição da marca |
Consultar lista de marcas
Método responsável por disponibilizar uma listagem do cadastro de marcas.
Exemplo de retorno:
http://{ip_cliente}/MarcaLista
[
{
"codigo": "01",
"descricao": "MARCA 01"
},
{
"codigo": "02",
"descricao": "MARCA 02"
},
{
"codigo": "03",
"descricao": "MARCA 03"
},
{
"codigo": "04",
"descricao": "MARCA 04"
}
]
URL
GET http://{ip_cliente}/MarcaLista
Retorno
A consulta irá retornar todos os dados de todas as marcas cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Linha
Incluir linha
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Linha cadastrada com sucesso",
"codigo": "00001"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar linha: descricao inválida."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "DESCRIÇÃO LINHA",
"genero": "M"
}
]
Método responsável pela inclusão de linhas.
URL
POST http://{ip_cliente}/Linha
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Sim | Descrição da linha |
| genero | string / 1 | Sim | Gênero M - Masculino F - Feminino U - Unisex |
Consultar lista de linhas
Método responsável por disponibilizar uma listagem do cadastro de linhas.
Exemplo de retorno:
http://{ip_cliente}/LinhaLista
[
{
"codigo": "00001",
"descricao": "LINHA 1",
"concentrado": 0,
"genero": ""
},
{
"codigo": "00002",
"descricao": "LINHA 2",
"concentrado": 0,
"genero": ""
},
{
"codigo": "00003",
"descricao": "LINHA 3",
"concentrado": 0,
"genero": ""
}
]
URL
GET http://{ip_cliente}/LinhaLista
Retorno
A consulta irá retornar todos os dados de todas as linhas cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Família
Consultar lista de famílias
Método responsável por disponibilizar uma listagem do cadastro de linhas.
Exemplo de retorno:
http://{ip_cliente}/FamiliaLista
[
{
"codigo": "00001",
"descricao": "FAMILIA 1",
"cor": 32768,
"grupo": ""
},
{
"codigo": "00002",
"descricao": "FAMILIA 2",
"cor": 65535,
"grupo": "00001"
},
{
"codigo": "00003",
"descricao": "FAMILIA 3",
"cor": -16777203,
"grupo": ""
}
]
URL
GET http://{ip_cliente}/FamiliaLista
Retorno
A consulta irá retornar todos os dados de todas as famílias cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Tamanho
Incluir faixa de tamanho
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Faixa tamanho cadastrada com sucesso",
"codigo": "01"
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar faixa tamanho: tamanho inválido."
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "FAIXA TESTE API",
"tamanho": 4,
"tamanhos": [
{
"posicao": 1,
"tamanho": "P"
},
{
"posicao": 2,
"tamanho": "M"
},
{
"posicao": 3,
"tamanho": "G"
}
]
}
]
Método responsável pela inclusão de faixas de tamanho.
URL
POST http://{ip_cliente}/FaixaTamanho
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 30 | Sim | Descrição da faixa de tamanho |
| tamanho | integer | Sim | Espaçamento entre os tamanhos |
| tamanhos | Objeto | Sim | Tamanhos contidos na faixa |
| posicao | integer | Sim | Posição do tamanho dentro da faixa |
| tamanho | string / 4 | Sim | Tamanho |
Consultar faixa de tamanho
Método responsável por disponibilizar os dados de uma faixa de tamanho.
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "P / M / G",
"tamanho": 5,
"tamanhos": [
{
"tamanho": "P",
"posicao": 1
},
{
"tamanho": "M",
"posicao": 2
},
{
"tamanho": "G",
"posicao": 3
}
]
}
]
URL
GET http://{ip_cliente}/FaixaTamanho/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Lista de parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/FaixaTamanho/01?empresa=001
Onde "01" representa o código da faixa de tamanho.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código da faixa de tamanho |
| empresa | string / 4 | Não | Código da empresa |
Consultar lista de faixas de tamanho
Método responsável por disponibilizar uma listagem do cadastro de faixas de tamanho.
Exemplo de retorno:
http://{ip_cliente}/FaixaTamanhoLista
[
{
"codigo": "00",
"descricao": "GERAL",
"tamanho": 8
},
{
"codigo": "01",
"descricao": "P-M-G-GG",
"tamanho": 8
},
{
"codigo": "02",
"descricao": "0-3/3-6/6-9/9-12",
"tamanho": 8
}
]
URL
GET http://{ip_cliente}/FaixaTamanhoLista
Retorno
A consulta irá retornar todos os dados de todas as faixas de tamanho cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 30 | Não | Descrição da faixa de tamanhos |
| empresa | string / 4 | Não | Código da empresa |
Incluir tamanho
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Tamanho cadastrado com sucesso"
}
]
Exemplo do corpo da requisição:
[
{
"tam": "P",
"acrescimo": 1,
"faixa": "01",
"faixa_preco": "01"
}
]
Método responsável pela inclusão de tamanho.
URL
POST http://{ip_cliente}/Tamanho
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tam | string / 4 | Sim | Tamanho |
| acrescimo | integer | Não | Ordem do tamanho |
| faixa | string / 10 | Não | Faixa |
| faixa_preco | string / 2 | Não | Código da faixa de preço |
| empresa | string / 4 | Não | Número da empresa |
Consultar lista de tamanhos
Método responsável por disponibilizar uma listagem do cadastro de tamanhos.
Exemplo de retorno:
[
{
"tam": "34",
"faixa": "01",
"faixa_preco": "01",
"acrescimo": 1
},
{
"tam": "36",
"faixa": "01",
"faixa_preco": "01",
"acrescimo": 2
},
{
"tam": "38",
"faixa": "01",
"faixa_preco": "01",
"acrescimo": 3
}
]
URL
GET http://{ip_cliente}/Tamanho
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tam | string / 4 | Não | Tamanho |
| acrescimo | integer | Não | Ordem do tamanho |
| faixa | string / 10 | Não | Faixa |
| faixa_preco | string / 2 | Não | Código da faixa de preço |
| empresa | string / 4 | Não | Número da empresa |
Material
Incluir ou alterar material
Exemplo de retorno:
[
{
"resultado": "Material cadastrado com sucesso.",
"material": "21234"
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "MA012345",
"codigo2": "REF012345",
"unidade": "UN",
"descricao": "MATERIAL EXEMPLO",
"grupo": "MA",
"sub_grupo": "SG",
"composicao": "",
"uni_com": "UN",
"ativo": "S",
"divisor": 1.0,
"linha": "0001",
"largura": 0.0,
"maximo": 0.0,
"obs1": "Observação exemplo.",
"observacao": "Observação de exemplo.",
"cdcentro": "000",
"descricao2": "DESCRICAO 2",
"ne": 0,
"peso": 15.0,
"peso_liq": 14.8,
"reposicao": 0.0,
"kg_hora": 0.0,
"minimo": 0.0,
"ind_tin": 0.0,
"codcli": "00001",
"codtri": "00",
"codfis": "01",
"codsped": "01",
"concentracao": 0.0,
"concentra_est": 0.0,
"local": "",
"ipi": 0.0,
"gramatura": 0.0,
"origem": "0",
"preco": 0.0,
"pre_medio": 0.09,
"pre_compra": 0.11,
"trib_ipi": "01",
"trib_pis": "01",
"trib_cofins": "01",
"estampa": "",
"estoque": "S",
"dt_compra": "01/01/2025",
"cubagem": 0.0,
"custo_imp": 0.0,
"cor": [
{
"cor": "0001",
"local": "",
"qtd_minima": 0.0,
"qtd_maxima": 0.0,
"barra": "",
"ativo": "S",
"preco_med": 0.0913
},
{
"cor": "0002",
"local": "",
"qtd_minima": 0.0,
"qtd_maxima": 0.0,
"barra": "",
"ativo": "S",
"preco_med": 0.0979
}
]
}
]
Método responsável pela inclusão ou alteração de materiais.
A alteração de um material se dará pelo mesmo método de inclusão, caso o campo código for informado e já existir no banco de dados.
URL
POST http://{ip_cliente}/Material
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ativo | string / 1 | Não | Status ativo/inativo do material ( S / N ) |
| cdcentro | string / 4 | Não | Código do centro de custo |
| codcli | string / 6 | Não | Código do cliente |
| codfis | string / 3 | Sim | Código da classificação fiscal |
| codigo | string / 15 | Não ** | Código do material |
| codigo2 | string / 25 | Não | Referência |
| codsped | string / 3 | Sim | Código do SPED |
| codtri | string / 3 | Não | Codigo da situação tributária de ICMS |
| composicao | string / 100 | Não | Composição |
| concentra_est | number / 5,2 | Não | Concentração estampa |
| concentracao | number / 5,2 | Não | Concentração |
| cubagem | number / 9,4 | Não | Cubagem |
| custo_imp | number / 18,8 | Não | Custo importação |
| descricao | string / 100 | Sim | Descrição do material |
| descricao2 | string / 100 | Não | Descrição 2 |
| divisor | number / 12,5 | Sim | Divisor |
| dt_compra | date | Não | Data de compra |
| estampa | string / 15 | Não | Estampa |
| estoque | string / 1 | Não | Controla estoque ( S / N ) |
| gramatura | number / 9,2 | Não | Gramatura |
| grupo | string / 3 | Sim * | Código do grupo |
| ind_tin | number / 9,2 | Não | Índice de desperdício |
| ipi | number / 5,2 | Não | Percentual de IPI |
| kg_hora | number / 5,2 | Não | Média de peso |
| largura | number / 5,2 | Não | Largura |
| linha | string / 5 | Sim * | Código da linha |
| local | string / 5 | Não | Local |
| maximo | number / 10,3 | Não | Tara |
| ne | integer | Não | NE. |
| obs1 | blob | Não | Observação |
| observacao | blob | Não | Observação |
| origem | string / 2 | Não | Origem do material |
| peso | number / 9,5 | Não | Peso bruto |
| peso_liq | number / 9,4 | Não | Peso líquido |
| pre_compra | number / 13,5 | Não | Preço de compra |
| pre_medio | number / 13,5 | Não | Preço médio |
| preco | number / 14,5 | Não | Preço de venda |
| reposicao | number / 13,5 | Não | Preço de custo |
| sub_grupo | string / 5 | Sim * | Código do subgrupo |
| trib_cofins | string / 3 | Não | Código da situação tributária COFINS |
| trib_ipi | string / 3 | Não | Código da situação tributária de IPI |
| trib_pis | string / 3 | Não | Código da situação tributária PIS |
| uni_com | string / 3 | Não | Unidade de compra |
| unidade | string / 3 | Sim | Unidade |
| cor | objeto | Sim | Cores do material |
| ativo | string / 1 | Não | Status ativo/inativo da cor ( S / N ) |
| barra | string / 13 | Não | Código de barras |
| cor | string / 6 | Sim | Código da cor |
| local | string / 30 | Não | Local estoque |
| preco_med | number / 18,8 | Não | Preço médio |
| qtd_maxima | number / 9,2 | Não | Quantidade máxima |
| qtd_minima | number / 13,3 | Não | Quantidade Mínima |
*Campos obrigatórios a depender da parametrização do ERP.
** Caso não informado, o código do material será formado de acordo com a parametrização do ERP.
Atributos alteráveis
Caso informado, no corpo da requisição, o atributo codigo, e o mesmo existir na base de dados, é possível alterar todos os demais parâmetros do material.
No corpo da requisição, é necessário informar o atributo com seu respectivo valor, os atributos não informados serão ignorados na alteração. Atributos informados com valor vazio serão alterados para vazio.
Se informado o array "cor", as cores já existentes no EXCIA sem movimentação serão removidas, e as cores informadas na requisição serão inseridas.
Consultar material
Método responsável por disponibilizar os dados detalhados de um material.
Exemplo de retorno:
[
{
"codigo": "MA012345",
"codigo2": "REF012345",
"dt_altera": "01/01/2025",
"unidade": "UN",
"descricao": "MATERIAL EXEMPLO",
"grupo": "MA",
"desc_grupo": "GRUPO EXEMPLO",
"sub_grupo": "SG",
"desc_sub_grupo": "SUBGRUPO EXEMPLO",
"composicao": "",
"uni_com": "UN",
"ativo": "S",
"divisor": 1.0,
"linha": "0001",
"largura": 0.0,
"maximo": 0.0,
"obs1": "Observação exemplo.",
"observacao": "Observação de exemplo",
"cdcentro": "000",
"descricao2": "DESCRICAO 2",
"ne": 0,
"peso": 15.1,
"peso_liq": 14.9,
"reposicao": 0.0,
"kg_hora": 0.0,
"minimo": 0.0,
"ind_tin": 0.0,
"codcli": "00001",
"codtri": "01",
"codfis": "01",
"codsped": "01",
"concentracao": 0.0,
"concentra_est": 0.0,
"local": "",
"ipi": 0.0,
"gramatura": 0.0,
"origem": "0",
"preco": 0.0,
"pre_medio": 0.09,
"pre_compra": 0.11,
"trib_ipi": "",
"trib_pis": "",
"trib_cofins": "",
"estampa": "",
"estoque": "S",
"dt_compra": "01/01/2025",
"cubagem": 0.0,
"custo_imp": 0.0,
"preco_tabela": 0,
"cor": [
{
"cor": "00001",
"desc_cor": "PRETO",
"local": "",
"qtd_minima": 0.0,
"qtd_maxima": 0.0,
"barra": "",
"ativo": "S",
"preco_med": 1.0
},
{
"cor": "00002",
"desc_cor": "MESCLA",
"local": "",
"qtd_minima": 0.0,
"qtd_maxima": 0.0,
"barra": "",
"ativo": "S",
"preco_med": 1.0
}
]
}
]
URL
GET http://{ip_cliente}/Material/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Material/12345?empresa=001
Onde "12345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string /path param | Sim | Código do produto. |
| tab_pre | string / 5 | Não | Código da tabela de preços |
| empresa | string / 4 | Não | Número da empresa |
Consultar lista de materiais
Método responsável por retornar uma lista de materiais atualizados a partir de uma determinada data.
Exemplo de retorno OK:
http://{ip_cliente}/MaterialLista?data=01/01/2022
[
{
"codigo": "1010010001",
"codigo2": "1010010002",
"dt_altera": "05/01/2022",
"unidade": "KG",
"descricao": "MEIA MALHA 30/1 TINTA",
"grupo": "01",
"desc_grupo": "GRUPO EXEMPLO",
"sub_grupo": "02",
"desc_sub_grupo": "SUBGRUPO EXEMPLO",
"composicao": "COMPOSICAO EXEMPLO",
"uni_com": "KG",
"ativo": "S",
"preco_tabela": 10.0,
"cor": [
"0053",
"006",
"010"
]
},
{
"codigo": "1010000001",
"codigo2": "1010000002",
"dt_altera": "23/01/2022",
"unidade": "KG",
"descricao": "MEIA MALHA EXEMPLO",
"grupo": "01",
"desc_grupo": "GRUPO EXEMPLO",
"sub_grupo": "02",
"desc_sub_grupo": "SUBGRUPO EXEMPLO",
"composicao": "COMPOSICAO EXEMPLO",
"uni_com": "KG",
"ativo": "S",
"preco_tabela": 10.0,
"cor": [
"0"
]
}
]
Consulta onde o material não foi encontrado:
http://{ip_cliente}/MaterialLista?codigo=1010010001X
[
{
"method-error-400": "Não foi possível buscar Material: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/MaterialLista
Retorno
A consulta irá considerar os materiais atualizados com a data maior ou igual a data informada via parâmetro.
Serão apresentados 300 registros por página.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/MaterialLista?data=07/01/2021&codigo=0020010002
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
| codigo | string / 15 | Não | Código do material a ser consultado |
| ativo | string / 1 | Não | S = Materiais ativos N = Materiais inativos |
| pagina | Number | Não | Número da página. Cada página contem 300 registros. |
Excluir material
Método responsável pela exclusão de um material
Exemplo de retorno:
[
{
"resultado": "Material excluído com sucesso.",
"material": "MA012345"
}
]
URL
DELETE http://{ip_cliente}/Material/:codigo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
DELETE http://{ip_cliente}/Material/MA012345?empresa=001
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| empresa | string / 3 | Não | Número da empresa |
Incluir documento material
Método responsável pela inclusão de documentos no cadastro de material
Exemplo de retorno:
[
{
"resultado": "documento gravado com sucesso."
}
]
URL
POST http://{ip_cliente}/Material/:codigo/Documento
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
POST http://{ip_cliente}/Material/MA012345/Documento?empresa=001
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| empresa | string / 3 | Não | Número da empresa |
Atributos
Este método utiliza o corpo da requisição no formato multipart/form-data.
Informar no atributo "key" o nome do arquivo a ser salvo em disco e no "value" o arquivo propriamente dito.
Aceita vários arquivos por requisição.
Consultar lista de documentos material
Método responsável por listar os documentos vinculados a um material.
Exemplo de retorno
[
{
"arquivo": "arquivo1.jpg"
},
{
"arquivo": "arquivo2.docx"
},
{
"arquivo": "arquivo3.pdf"
}
]
URL
GET http://{ip_cliente}/Material/:codigo/Documento
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Material/MA012345/Documento
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
Consultar documento material
Método responsável por buscar / realizar download de um documento vinculado a um material.
URL
GET http://{ip_cliente}/Material/:codigo/Documento/:arquivo
Retorno
O content-type do retorno é definido pelo tipo do arquivo, ou application/octet-stream para arquivos binários que não possam ser reconhecidos automaticamente.
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Material/MA012345/Documento/documento_exemplo.pdf
Onde "MA012345" representa o código do material e "documento_exemplo.pdf" o nome do arquivo em disco.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| arquivo | string / path param | Sim | Nome do arquivo |
Excluir documento material
Método responsável pela exclusão de um documento vinculado a um material.
Exemplo de retorno:
[
{
"resultado": "documento excluído com sucesso."
}
]
URL
DELETE http://{ip_cliente}/Material/:codigo/Documento
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
DELETE http://{ip_cliente}/Material/MA012345/Documento?arquivo=arquivo_exemplo.jpg
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| arquivo | string / query param | Sim | Nome do arquivo em disco |
Incluir composição produção material
Método responsável pela inclusão e alteração da composição tipo produção de um material.
A alteração de uma composição se dará pelo mesmo método de inclusão. Sempre que o método é consumido toda ficha de composição do material em questão e excluída e reinserida conforme o JSON informado.
Exemplo de retorno:GET http://{ip_cliente}/OrdemCompra
[
{
"resultado": "Composição gravada com sucesso."
}
]
Exemplo do corpo da requisição:
[
{
"largura": 0.0,
"gramatura": 0.0,
"rpm": 0,
"diametro": 0.0,
"finura": 0.0,
"kg_rolo": 0.0,
"alimentadores": 0,
"fluxo": "01",
"desperdicio": 0.0,
"itens": [
{
"codigo": "123456",
"ordem": 1,
"lfa": 0,
"roca": 0,
"comp_ponto": 0.0,
"tensao": 0.0,
"perc": 52.52,
"regra": "01",
"cores": [
{
"cor": "00001",
"cor_i": "00001"
}
]
},
{
"codigo": "654321",
"ordem": 2,
"lfa": 0,
"roca": 0,
"comp_ponto": 0.0,
"tensao": 0.0,
"perc": 48.48,
"regra": "01",
"cores": [
{
"cor": "00001",
"cor_i": "00001"
}
]
}
]
}
]
URL
POST http://{ip_cliente}/Material/:codigo/Composicao/Producao
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
POST http://{ip_cliente}/Material/MA012345/Composicao/Producao
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| empresa | string / 4 | Não | Número da empresa |
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| largura | number / 5,2 | Não | Largura |
| gramatura | number / 5,2 | Não | Gramatura |
| rpm | integer | Não | RPM |
| diametro | number / 5,3 | Não | Diâmetro |
| finura | number / 5,3 | Não | Finura |
| kg_rolo | number / 5,3 | Não | KG Rolo |
| alimentadores | integer | Não | Alimentadores |
| fluxo | string / 2 | Não | Código do fluxo |
| desperdicio | number / 9,2 | Não | Fator malharia |
| itens | array | Sim | Itens da composição |
| codigo | string / 15 | Sim | Código do material / insumo |
| ordem | integer | Não | Número da ordem (Gerado automaticamente caso não informado) |
| lfa | integer | Não | LFA |
| roca | integer | Não | Roca |
| comp_ponto | number / 9,3 | Não | Comp. Ponto |
| tensao | number / 9,3 | Não | Tensão |
| perc | number / 8,5 | Sim | Percentual do insumo |
| regra | string / 3 | Não | Código da regra |
| cores | array | Sim | Cores do material e do insumo |
| cor | string / 6 | Sim | Cor do material |
| cor_i | string / 6 | Sim | Cor do insumo correspondente a cor do material |
Consultar composição produção material
Método responsável por buscar a composição produção de um material
Exemplo de retorno
[
{
"largura": 0.0,
"gramatura": 0.0,
"rpm": 0,
"diametro": 0.0,
"finura": 0.0,
"kg_rolo": 0.0,
"alimentadores": 0,
"fluxo": "01",
"desperdicio": 0.0,
"itens": [
{
"codigo": "MA012344",
"descricao": "FIO 30/1 100% ALGODÃO PENTEADO",
"ordem": 1,
"lfa": 0,
"roca": 0,
"comp_ponto": 0.0,
"tensao": 0.0,
"perc": 52.52,
"regra": "01",
"cores": [
{
"cor": "00001",
"desc_cor": "CINZA MESCLA",
"cor_i": "00002",
"desc_cor_i": "CINZA"
}
]
},
{
"codigo": "MA012345",
"descricao": "FIO 30/1 MESCLA CARDADO 88% ALGODÃO 12% POLIÉSTER",
"ordem": 2,
"lfa": 0,
"roca": 0,
"comp_ponto": 0.0,
"tensao": 0.0,
"perc": 48.48,
"regra": "01",
"cores": [
{
"cor": "00001",
"desc_cor": "CINZA MESCLA",
"cor_i": "00002",
"desc_cor_i": "CINZA"
}
]
}
]
}
]
URL
GET http://{ip_cliente}/Material/:codigo/Composicao/Producao
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo o código informado como path param, exemplo:
GET http://{ip_cliente}/Material/MA012345/Composicao/Producao
Onde "MA012345" representa o código do material.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do material |
| empresa | string / 4 | Não | Número da empresa |
Consultar estoque
Método responsável por consultar o estoque de materiais.
Exemplo de retorno:
[
{
"codigo": "ABC0001",
"codigo2": "98765",
"descricao": "MATERIAL EXEMPLO",
"cor": "0001",
"desc_cor": "PRETO",
"tam": "0",
"deposito": "0000",
"desc_deposito": "DEPOSITO PADRAO",
"lote": "000000",
"barra": "",
"barracli": "",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"quantidade": 10.0,
"qtde_min": 0.0
},
{
"codigo": "ABC0001",
"codigo2": "98765",
"descricao": "MATERIAL EXEMPLO",
"cor": "0002",
"desc_cor": "BRANCO",
"tam": "0",
"deposito": "0000",
"desc_deposito": "DEPOSITO PADRAO",
"lote": "000000",
"barra": "",
"barracli": "",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"quantidade": 10.0,
"qtde_min": 0.0
},
{
"codigo": "ABC0001",
"codigo2": "98765",
"descricao": "MATERIAL EXEMPLO",
"cor": "0003",
"desc_cor": "AZUL",
"tam": "0",
"deposito": "0000",
"desc_deposito": "DEPOSITO PADRAO",
"lote": "000000",
"barra": "",
"barracli": "",
"local": "",
"cor_ativa": "S",
"tipo": "1",
"quantidade": 20.0,
"qtde_min": 0.0
}
]
URL
GET http://{ip_cliente}/Estoque
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
http://{ip_cliente}/Estoque?tipo=M&codigo=0020010002
O tipo=M é obrigatório para retornar os dados referente a estoque de materiais
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Sim | Informar M |
| codigo | string / 15 | Não | Código do material |
| codigo2 | string / 25 | Não | Código 2 / referência |
| cor | string / 6 | Não | Código da cor |
| deposito | string / 4 | Não | Código do depósito |
| lote | string / 15 | Não | Número do lote |
| barra | string / 13 | Não | Código de barras |
| estoque | string / 1 | Não | 0 - Todos 1 - Com quantidade em estoque 2 - Sem quantidade em estoque |
| local | string / 30 | Não | Código do local |
| cor_ativa | string / 1 | Não | S - Apenas cores ativas N - Apenas cores inativas |
| pagina | number | Não | Número da página |
| offset | number | Não | Quantidade de registros por página. Caso não informado, serão retornados 300 registros |
Movimentar estoque
Método responsável por realizar a movimentação de estoque de materiais.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Movimentação concluída.",
"documento": "000001",
"itens_erro": []
}
]
Se algum item não puder ser movimentado, constará no array itens_erro, o item e o motivo:
[
{
"resultado": "Movimentação concluída.",
"documento": "000001",
"itens_erro": [
{
"codigo": "ABC1234",
"cor": "000001",
"tam": "",
"lote": "100000",
"qualidade": "1",
"deposito": "0000",
"motivo": "Item não encontrado."
},
{
"codigo": "ABC1234",
"cor": "000001",
"tam": "",
"lote": "100000",
"qualidade": "1",
"deposito": "0000",
"motivo": "Item não encontrado."
}
]
}
]
Exemplo do corpo da requisição
[
{
"documento": "000001",
"operacao": "E",
"tipo_bai": "1",
"funcionario": "00001",
"itens": [
{
"codigo": "ABC123456",
"cor": "000001",
"lote": "100000",
"qualidade": "1",
"deposito": "0000",
"qtde": 5
},
{
"codigo": "ABC123456",
"cor": "000001",
"lote": "100001",
"qualidade": "1",
"deposito": "0000",
"qtde": 5
}
]
}
]
URL
POST http://{ip_cliente}/Estoque
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| documento | string / 12 | Sim | Número do documento |
| operacao | string / 1 | Sim | E - Entrada de produtos S - Saída de produtos |
| tipo_bai | string / 2 | Sim | Código do tipo de baixa |
| funcionario | string / 5 | Sim | Código do funcionário |
| tipo | string / 1 | Sim | Informar "M" |
| Itens | Objeto | Sim | Itens a movimentar |
| codigo | string / 15 | Sim (Caso não informado o atributo barra) |
Código do material |
| cor | string / 6 | Sim (Caso não informado o atributo barra) |
Código da cor do material |
| lote | string / 15 | Sim | Número do lote |
| qualidade | string / 1 | Não | Qualidade do material |
| deposito | string / 6 | Sim | Código do depósito |
| qtde | Number / 10,3 | Sim | Quantidade a movimentar |
| custo | number / 9,4 | Não | Custo do material |
Em movimentações de saída (operacao = 'S') será validado se a quantidade informada está disponível em estoque.
Caso o atributo custo não for informado, será utilizado o custo definido no cadastro do material.
Consultar movimentação de estoque
Método responsável por retornar os dados de movimentação de estoques de material.
Exemplo de retorno:
[
{
"num_docto": "012345",
"codigo": "ABC1234",
"cor": "00001",
"tamanho": "0",
"lote": "000000",
"deposito": "0001",
"tipo": "1",
"tp_mov": "MN",
"operacao": "E",
"qtde": 100,
"preco": 1,
"dt_mvto": "01/01/2025",
"hora": "12:00:00"
},
{
"num_docto": "012345",
"codigo": "ABC1234",
"cor": "00001",
"tamanho": "0",
"lote": "000000",
"deposito": "0001",
"tipo": "1",
"tp_mov": "MN",
"operacao": "E",
"qtde": 2,
"preco": 1,
"dt_mvto": "01/01/2025",
"hora": "12:00:00"
}
]
URL
GET http://{ip_cliente}/Estoque/Movimento
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/Estoque/Movimento?data=01/01/2025&hora=10:00:00&deposito=0001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| tipo | string / 1 | Sim | Tipo do item. Preencher com "M" (Material) |
| data | date | Sim | Data da movimentação |
| hora | time | Não | Hora da movimentação (Utilizar o formato HH:MM:SS) |
| deposito | string / 6 | Não | Código do depósito |
| operacao | string / 1 | Não | Tipo da operação E - Entrada S - Saída |
| tp_mov | string / 2 | Não | Tipo de movimentação |
| codigo | string / 15 | Não | Código do material |
| cor | string / 6 | Não | Código da cor |
| lote | string / 15 | Não | Número do lote |
| num_docto | string / 12 | Não | Número do documento / movimentação |
Consultar lotes de materiais
Método responsável por retornar os dados de lotes de materiais.
Exemplo de retorno:
[
{
"codigo": "MT12345",
"descricao": "MOLETOM TUBULAR MESCLA",
"cor": "100001",
"desc_cor": "MESCLA",
"lote": "000538006",
"partida": "",
"sequencia": "",
"tonalidade": "",
"obs": "",
"gramatura": 0.0,
"dt_validade": ""
},
{
"codigo": "MM54321",
"descricao": "M.MALHA TUBULAR ESCURO",
"cor": "949269",
"desc_cor": "PRETO",
"lote": "000538006",
"partida": "",
"sequencia": "",
"tonalidade": "",
"obs": "",
"gramatura": 0.0,
"dt_validade": ""
}
]
URL
GET http://{ip_cliente}/Estoque/Lote
Parâmetros
Os parâmetros devem ser passados no link da requisição, a parametrização deve ser feita da seguinte forma:
http://{ip_cliente}/Estoque/Lote?codigo=MT12345&cor=100001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Não | Código do material |
| cor | string / 6 | Não | Código da cor |
| lote | string / 15 | Não | Número do lote |
| empresa | string / 4 | Não | Número da empresa |
Alterar código de barras
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Barra cadastrada com sucesso."
}
]
Exemplos onde algum campo é inválido:
[
{
"method-error-400": "Não foi possível processar barra material: codigo: ABC123 cor: 0001 inválidos."
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "ABC123",
"cor": "000001",
"barra": "0123456789101",
"deposito": "0001",
"lote": "000001"
},
{
"codigo": "ABC123",
"cor": "000002",
"barra": "0123456789102",
"deposito": "0001",
"lote": "000002"
}
]
Método responsável pela inclusão e/ou alteração de códigos de barras no material.
URL
PATCH http://{ip_cliente}/Material/Barra
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código do material |
| cor | string / 6 | Sim | Cor do material |
| deposito | string / 6 | Não | Código do depósito |
| lote | string / 15 | Não | Código do lote |
| barra | string / 13 | Não | Código de barras |
- O atributo barra, caso não informado, será ignorado na alteração. Se informado com uma string vazia, o mesmo será gravado em branco. Dessa forma, informar no corpo da requisição, apenas os atributos que de fato devem ser alterados.
Estampa
Incluir estampa
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Estampa cadastrada com sucesso.",
"estampa": "00015"
}
]
Exemplo do corpo da requisição:
[
{
"descricao": "Estampa 001",
"tamanho": "Pequeno",
"area": "Area",
"qtde_ponto": 1,
"observacao": "Teste Observação",
"tipo": "E",
"data": "01/01/2023"
}
]
Método responsável pela inclusão de estampas.
URL
POST http://{ip_cliente}/Estampa
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| descricao | string / 50 | Sim | Descrição da estampa |
| tamanho | string / 15 | Sim | Tamanho da estampa (Pequeno, Grande, Todo, Corrido) |
| area | string / 10 | Não | Área |
| qtde_ponto | integer | Não | Quantidade ponto |
| observacao | blob | Não | Observação |
| tipo | string / 1 | Sim | Tipo E - Estampa B - Bordado R - Retilínea |
| data | date | Não | Data de cadastro |
Consultar lista de estampas
Método responsável por disponibilizar uma listagem do cadastro de estampas.
Exemplo de retorno:
http://{ip_cliente}/EstampaLista
[
{
"codigo": "00001",
"descricao": "ESTAMPA 1",
"data": "01/01/2023",
"tamanho": "Pequeno",
"area": "AREA",
"qtde_ponto": 0,
"observacao": "Observação teste",
"tipo": "E"
},
{
"codigo": "00002",
"descricao": "ESTAMPA 2",
"data": "05/04/2023",
"tamanho": "Grande",
"area": "TESTE",
"qtde_ponto": 0,
"observacao": "",
"tipo": "E"
}
]
URL
GET http://{ip_cliente}/EstampaLista
Retorno
A consulta irá retornar todos os dados de todas as estampas cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/EstampaLista?data=01/01/2023
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data inicial da consulta. Utilizar o formato DD/MM/YYYY |
Adicionar imagem
Método responsável por adicionar imagem ao cadastro de estampa.
São aceitas imagens .jpg, no formato base64.
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Imagem gravada com sucesso."
}
]
Exemplo do corpo da requisição
[
{
"codigo":"00008",
"imagem": "/9j/4AAQSkZJRgAB..."
}
]
URL
POST http://{ip_cliente}/EstampaImagem
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 15 | Sim | Código da estampa no cadastro de estampas |
| imagem | base64 image | Sim | Imagem, .jpg, no formato base64 |
Situação Amostra
Consultar lista de situações de amostras
Método responsável por disponibilizar uma listagem do cadastro de situações de amostra.
Exemplo de retorno:
[
{
"ativo": "S",
"codigo": "01",
"descricao": "EXEMPLO 1"
},
{
"ativo": "S",
"codigo": "02",
"descricao": "EXEMPLO 2"
},
{
"ativo": "N",
"codigo": "03",
"descricao": "EXEMPLO 3"
}
]
URL
GET http://{ip_cliente}/SituacaoAmostra
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/SituacaoAmostra?descricao=teste&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 3 | Não | Código da situação |
| descricao | string / 80 | Não | Descrição da situação |
| empresa | string / 3 | Não | Número da empresa |
Depósito
Consultar lista de depósitos
Método responsável por disponibilizar uma listagem dos depósitos cadastrados
Exemplo de retorno:
[
{
"codigo": "0000",
"descricao": "DEPÓSITO PADRÃO",
"prioridade": "1",
"codcli": "",
"posse": ""
},
{
"codigo": "0001",
"descricao": "SEGUNDA QUALIDADE",
"prioridade": "0",
"codcli": "",
"posse": ""
}
]
URL
GET http://{ip_cliente}/DepositoLista
Retorno
A consulta irá retornar todos os dados de todos os depósitos cadastrados no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/DepositoLista?pagina=1
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| pagina | integer | Não | Número da página. Cada página contem 300 registros. |
Medida
Consultar lista de medidas
Método responsável por disponibilizar uma listagem do cadastro de medidas.
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "TORAX"
},
{
"codigo": "02",
"descricao": "CINTURA"
},
{
"codigo": "03",
"descricao": "BARRA"
}
]
URL
GET http://{ip_cliente}/MedidaLista
Retorno
A consulta irá retornar todos os dados de todas as medidas cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Esse método dispensa a necessidade parâmetros para executar a consulta.
Varejo
Incluir venda varejo
Em caso de sucesso será retornado status 200 e o seguinte objeto JSON:
[
{
"resultado": "Venda gravada com sucesso",
"codven": "1000"
}
]
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON:
[
{
"method-error-400": "Não foi possível processar venda: Produto com estoque reservado em pedidos.\r\nQuantidade reservada: 25\r\nProduto: 107000700\r\nCor: PINK\r\nTamanho: M"
}
]
[
{
"method-error-400": "Não foi possível processar venda: Item com estoque insuficiente.\r\nProduto: 107000700\r\nCor: PINK\r\nTamanho: M\r\nDeposito: 0000"
}
]
Exemplo do corpo da requisição:
[
{
"codven": 15,
"codcli": "00001",
"codrep": "00012",
"data": "01/01/2023",
"hora": "09:32:50",
"tabela": "001",
"tipo_venda": 0,
"valor": 200,
"valor_bruto": 200,
"observacao": "Observação exemplo",
"itens": [
{
"coditven": "1",
"codigo": "ABC123",
"cor": "0001",
"tam": "P",
"lote": "000000",
"deposito": "0000",
"quantidade": 5,
"preco_orig": 20,
"valor": 20
},
{
"coditven": "2",
"codigo": "ABC123",
"cor": "0002",
"tam": "M",
"lote": "000000",
"deposito": "0000",
"preco_orig": 50,
"quantidade": 2,
"valor": 50
}
]
}
]
Método responsável pela inclusão ou alteração de venda varejo.
A alteração se dará pelo mesmo método de inclusão. Caso a venda esteja aberta e o atributo codven informado já exista na base de dados, a venda será atualizada.
URL
POST http://{ip_cliente}/VendaVarejo
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codven | integer | Sim | Número da venda |
| codcli | string / 5 | Sim | Código do cliente |
| codrep | string / 5 | Sim | Código do vendedor / representante |
| data | date | Sim | Data da venda (Utilizar o formato DD/MM/YYYY) |
| hora | time | Sim | Hora da venda (Utilizar o formato HH:MM:SS) |
| tabela | string / 5 | Sim | Tabela de preço |
| tipo_venda | number | Sim | Tipo da venda 0 - Venda 1 - Devolução |
| valor | number | Sim | Valor total líquido |
| valor_bruto | number | Sim | Valor total bruto |
| observacao | string / 1000 | Não | Observação da venda |
| itens | objeto | sim | itens da venda |
| coditven | integer | Sim | Sequencial numérico que representa a ordem do item na venda |
| codigo | string / 15 | Sim | Código do item |
| cor | string / 6 | Sim | Cor do item |
| tam | string / 4 | Sim | Tamanho do item |
| lote | string / 15 | Sim | Lote do item no estoque |
| deposito | string / 6 | Sim | Código do depósito |
| quantidade | number | Sim | Quantidade do item |
| preco_orig | number | Sim | Preço original |
| valor | number | Sim | Preço |
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/VendaVarejo?usuario=NomeUsuario&empresa=_001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| usuario | string / 20 | Sim | Nome do usuário |
| empresa | string / 3 | Não | Número da empresa |
As seguintes ações no ato da gravação da venda dependem das parametrizações do ERP:
- Permitir venda de produtos com estoque negativo ou insuficiente;
- Considerar vendas em aberto para o cálculo de disponibilidade de Estoque;
- Considerar a quantidade pendente em pedidos no calculo de saldo de estoque.
As validações acima são efetuadas da mesma forma que a tela Venda/Varejo do ERP.
Consultar venda varejo
Método responsável por retornar os dados de uma determinada venda varejo
Exemplo de retorno:
[
{
"codven": 5135,
"codcli": "10080",
"nome": "CLIENTE TESTE",
"codrep": "00001",
"nome_rep": "REPRESENTANTE",
"tipo": "N",
"tabela": "999",
"desc_tabela": "TABELA PADRAO",
"cdcondicao": 24,
"desc_condicao": "30 60 90 120 150 180",
"observacao": "Observação exemplo",
"nota": "001234",
"fatura": "001234",
"chave_nfe": "00000000000000000000000000000000000000000000",
"impresso": "S",
"tipo_venda": 0,
"status": 1,
"itens": [
{
"codigo": "100000000",
"descricao": "CALCA MASC MOLETOM",
"cor": "0001",
"desc_cor": "MESCLA",
"tam": "G",
"preco_orig": 279.96,
"quantidade": 1,
"valor": 279.96,
"lote": "000000",
"deposito": "0001"
},
{
"codigo": "100000000",
"descricao": "CALCA MASC MOLETOM",
"cor": "0002",
"desc_cor": "PRETO",
"tam": "GG",
"preco_orig": 279.96,
"quantidade": 1,
"valor": 279.96,
"lote": "000000",
"deposito": "0001"
}
]
}
]
URL
GET http://{ip_cliente}/BuscarVendaVarejo
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/BuscarVendaVarejo?venda=5135&empresa=_001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| venda | number | Sim | Número da venda |
| empresa | string / 3 | Não | Número da empresa |
Consultar lista de vendas varejo
Método responsável por disponibilizar uma listagem das vendas varejo.
Exemplo de retorno:
[
{
"codven": 3824,
"codcli": "00001",
"nome": "CONSUMIDOR FINAL",
"valor": 1505.76,
"data": "01/01/2023",
"valor_bruto": 2007.68,
"quantidade": 8,
"valor_liq": 2007.68,
"cnpj": "00.000.000/0000-00",
"codrep": "00001",
"nome_rep": "REPRESENTANTE",
"codrep2": "00002",
"nome_rep2": "REPRESENTANTE/GUIA",
"nota": "001234",
"fatura": "001234",
"nota_impresso": "S",
"chave_nfe": "00000000000000000000000000000000000000000000",
"tipo_venda": 0,
"status": 0,
"empresa": "_001"
},
{
"codven": 3825,
"codcli": "10100",
"nome": "CLIENTE PESSOA FISICA EXEMPLO",
"valor": 495.94,
"data": "01/01/2023",
"valor_bruto": 619.92,
"quantidade": 2,
"valor_liq": 619.92,
"cnpj": "000.000.000-00",
"codrep": "00001",
"nome_rep": "REPRESENTANTE",
"codrep2": "00002",
"nome_rep2": "REPRESENTANTE/GUIA",
"nota": "",
"fatura": "",
"nota_impresso": "",
"chave_nfe": "",
"tipo_venda": 0,
"status": 0,
"empresa": "_001"
}
]
URL
GET http://{ip_cliente}/VendaVarejoLista
Retorno
A consulta irá retornar todos os dados de todas as vendas varejo cadastradas no ERP EXCIA.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
| Campo | Tipo / Tamanho | Descrição |
|---|---|---|
| tipo_venda | number | Tipo da venda 0 - Venda 1 - Devolução 2 - Troca |
| status | number | Status da venda 0 - Aberta 1 - Finalizada 2 - Cancelada 3 - Conferida |
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/VendaVarejoLista?data=01/01/2023&empresa=_001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data inicial da consulta Utilizar o formato DD/MM/YYYY |
| data_fim | date | Não | Data final da consulta Utilizar o formato DD/MM/YYYY |
| empresa | string / 3 | Não | Número da empresa |
| tipo_venda | string / 1 | Não | Tipo da venda 0 - Venda 1 - Devolução 2 - Troca |
| status | string / 1 | Não | Status da venda 0 - Aberta 1 - Finalizada 2 - Cancelada 3 - Conferida |
| codrep | string / 5 | Não | Código do representante / vendedor |
| codrep2 | string / 5 | Não | Código do representante 2 / guia |
| pagina | number | Não | Número da página. Cada página contem 300 registros. |
Região
Consultar lista de regiões
Método responsável por disponibilizar uma listagem das regiões / tabelas de preço.
Exemplo de retorno:
[
{
"regiao": "00001",
"descricao": "REGIAO PADRAO",
"padrao": "S",
"indice": 1,
"liberado": "S",
"com1": 0,
"com2": 0,
"obs": "",
"bloq_desc": ""
},
{
"regiao": "00002",
"descricao": "VAREJO",
"padrao": "N",
"indice": 0,
"liberado": "S",
"com1": 0,
"com2": 0,
"obs": "",
"bloq_desc": ""
},
{
"regiao": "00003",
"descricao": "ATACADO",
"padrao": "N",
"indice": 0,
"liberado": "N",
"com1": 0,
"com2": 0,
"obs": "",
"bloq_desc": ""
}
]
URL
GET http://{ip_cliente}/RegiaoLista
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/RegiaoLista?regiao=00001&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| regiao | string / 5 | Não | Código da região. |
| liberado | string / 1 | Não | Status da região S - Liberada N - Bloqueada |
| descricao | string / 50 | Não | Descrição da região |
| empresa | string / 4 | Não | Número da empresa |
| pagina | integer | Não | Número da página. Cada página contem 300 registros. |
Tipo de Entidade
Consultar lista de tipos de entidade
Método responsável por disponibilizar uma listagem dos tipos de entidades
Exemplo de retorno:
[
{
"codigo": "01",
"descricao": "CLIENTES",
"cor": 8388736
},
{
"codigo": "02",
"descricao": "FORNECEDORES",
"cor": 32768
},
{
"codigo": "03",
"descricao": "TERCEIROS",
"cor": 128
}
]
URL
GET http://{ip_cliente}/TipoEntidade
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/TipoEntidade?descricao=CLIENTE&empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 2 | Não | Código do tipo de entidade |
| descricao | string / 20 | Não | Descrição do tipo de entidade |
| empresa | string / 4 | Não | Número da empresa |
| pagina | integer | Não | Número da página |
| offset | integer | Não | Quantidade de registros por página. Caso não informado, serão retornados 300 registros |
Mensagem
Consultar lista de mensagens
Método responsável por disponibilizar uma listagem de mensagens / motivos.
Exemplo de retorno:
[
{
"codmen": "1",
"descricao": "Geral",
"padrao": "0"
},
{
"codmen": "01",
"descricao": "DUPLICATA EM ATRASO",
"padrao": "0"
}
]
URL
GET http://{ip_cliente}/Mensagem
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
| Campo | Tipo / Tamanho | Descrição |
|---|---|---|
| codmen | string / 2 | Código da mensagem |
| descricao | string / 100 | Descrição da mensagem |
| padrao | string / 2 | Tipo da mensagem, sendo: 0 - Status pedido. 1 - Bloqueio pedido, tempo análise financeira. 2 - Bloqueio pedido, dupl. em atraso. 3 - Bloqueio pedido, cliente sem faturamentos anteriores. 4 - Bloqueio pedido, limite de crédito. 5 - Bloqueio pedido, numero de dias do ultimo faturamento. 6 - Nota Fiscal. 7 - Contatos 8 - Envio de e-mail de duplicatas em atraso. 9 - Bloqueio pedido, quantidade por volume não confere. 10 - Bloqueio OC - Orçamento Excedido 11 - Bloqueio OC - Limite Usuário Excedido 12 - Amostra 13 - Amostra Recusada |
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/Mensagem?descricao=teste&padrao=0
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codmen | string / 3 | Não | Código da mensagem |
| descricao | string / 100 | Não | Descrição da mensagem |
| empresa | string / 4 | Não | Número da empresa |
| padrao | string / 2 | Não | Tipo de mensagem |
Imagem
Consultar imagem de produto
Método responsável por disponibilizar a imagem de um produto.
URL
GET http://{ip_cliente}/Imagem/Produto/:codigo
Retorno
Em caso de sucesso será retornado status 200 e a imagem. O content-type será "image/jpeg" ou "image/png", de acordo com o tipo de arquivo.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Imagem/Produto/ABC1234
Onde "ABC1234" representa o código do produto consultado.
Para buscar a imagem de uma cor específica do produto deve ser feito da seguinte maneira:
GET http://{ip_cliente}/Imagem/Produto/ABC1234-0001
Onde "ABC1234" representa o código do produto, e "0001" representa a cor.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto / nome do arquivo |
Imagem cadastrada como documento
Para consultar uma imagem cadastrada na seção de documentos do produto, deve-se utilizar uma variação deste mesmo método:
GET http://{ip_cliente}/Imagem/Documento/Produto/:codigo/:nome_arquivo
Exemplo com os parâmetros:
GET http://{ip_cliente}/Imagem/Documento/Produto/ABC1234/foto-catalogo
Onde "ABC1234" representa o código do produto e "foto-catalogo" representa o nome do arquivo no disco.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / path param | Sim | Código do produto |
| nome_arquivo | string / path param | Sim | Nome da imagem |
Consultar imagem de protótipo
Método responsável por disponibilizar a imagem de um protótipo.
URL
GET http://{ip_cliente}/Imagem/Prototipo/:nome_arquivo
Retorno
Em caso de sucesso será retornado status 200 e a imagem. O content-type será "image/jpeg" ou "image/png", de acordo com o tipo de arquivo.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, como path param, exemplo:
GET http://{ip_cliente}/Imagem/Prototipo/ABC1234
Onde "ABC1234" representa o nome do arquivo de imagem, normalmente o código do protótipo + sequencial.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| nome_arquivo | string / path param | Sim | Código do protótipo / nome do arquivo |
Imagem em base 64
Para receber o retorno da imagem em base 64 deve-se utilizar o seguinte método:
GET http://{ip_cliente}/Prototipo/Imagem/:nome_arquivo
Exemplo de retorno:
[
{
"arquivo": "ABC123.jpg",
"documento": "W2NhbWluaG9dDQpwYX.."
}
]
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| nome_arquivo | string / path param | Sim | Código do protótipo / nome do arquivo |
Classificação Fiscal
Incluir classificação fiscal
Exemplo de retorno:
[
{
"resultado": "Classificação fiscal cadastrada com sucesso",
"codigo": "001"
}
]
Exemplo do corpo da requisição:
[
{
"codigo": "001",
"descricao": "00000000",
"tipo": "CLASSIFICAÇÃO EXEMPLO",
"icms": 0,
"ipi": 0,
"observacao": "OBSERVACAO EXEMPLo",
"perc_ii": 0,
"ibpt": 0,
"cest": "0000",
"unidade": "UN",
"ind_escala": "0",
"extipi": "00",
"pis": 0,
"cofins": 0,
"esp_fis": "0"
}
]
Método responsável pela inclusão de uma classificação fiscal.
URL
POST http://{ip_cliente}/ClassificacaoFiscal
Atributos
| Parâmetro | Tipo/Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 3 | Não (Caso não informado, será gerado automaticamente) |
Código da classificação fiscal |
| descricao | string / 15 | Sim | Código NCM |
| tipo | string / 100 | Não | Descrição da classificação fiscal |
| icms | number / 9,2 | Não | Alíquota ICMS |
| ipi | number / 9,2 | Não | Alíquota IPI |
| observacao | blob | Não | Observação |
| perc_ii | number / 9,2 | Não | Alíquota de imposto de importação |
| ibpt | number / 5,2 | Não | Alíquota IBPT |
| cest | string / 10 | Não | Código de enquadramento de ST |
| unidade | string / 6 | Não | Unidade de exportação |
| ind_escala | string / 1 | Não | Ind. Escala 0: Não informar 1: Relevante 2: Não relevante |
| extipi | Não | Exceção TIPI | |
| pis | number / 8,4 | Não | Alíquota PIS |
| cofins | number / 8,4 | Não | Alíquota COFINS |
| esp_fis | string / 1 | Não | Especificação fiscal 0: Nenhum 1: Veículo Novo 2: Medicamento/Químico 3: Armamento 4: Combustível |
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Código da empresa |
Consultar lista classificações fiscais
Método responsável por disponibilizar uma listagem do cadastro de classificação fiscal.
Exemplo de retorno:
[
{
"codigo": "001",
"descricao": "60041043",
"tipo": "TECIDOS DE MALHA - TECIDOS DE MALHA DE LARGURA SUPERIOR A 30CM, CONTENDO, EM PESO, 5% OU MAIS DE FIO",
"icms": 0,
"ipi": 0,
"observacao": "",
"padrao": "S",
"perc_ii": 0,
"ibpt": 0,
"cest": "",
"unidade": "",
"ind_escala": "0",
"extipi": "",
"pis": 0,
"cofins": 0,
"esp_fis": "0"
},
{
"codigo": "002",
"descricao": "72166190",
"tipo": "FERRO FUNDIDO, FERRO E AÇO - PERFIS DE FERRO OU AÇO NÃO LIGADO. - PERFIS SIMPLESMENTE OBTIDOS OU COM",
"icms": 0,
"ipi": 0,
"observacao": "",
"padrao": "N",
"perc_ii": 0,
"ibpt": 0,
"cest": "",
"unidade": "",
"ind_escala": "0",
"extipi": "",
"pis": 0,
"cofins": 0,
"esp_fis": "0"
}
]
URL
GET http://{ip_cliente}/ClassificacaoFiscal
Retorno
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição:
http://{ip_cliente}/ClassificacaoFiscal?descricao=10000001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 3 | Não | Código da classificação fiscal |
| descricao | string / 15 | Não | Código NCM |
| tipo | string / 100 | Não | Descrição da classificação fiscal |
| empresa | string / 4 | Não | Código da empresa |
Conversão de códigos de compra
Incluir conversão de código
Método responsável pela inclusão e alteração de conversão de código.
A alteração se dará pelo mesmo método de inclusão. Caso os atributos "codfor", "codigo_for", "codigo_mat" informados já existirem na base de dados, o cadastro será atualizado.
Exemplo de retorno
[
{
"resultado": "Código cadastrado com sucesso"
}
]
Exemplo do corpo da requisição:
[
{
"codfor": "00001",
"codigo_for": "ABC123",
"codigo_mat": "12345",
"cor": "0001",
"data": "01/01/2025",
"preco": 3.8,
"preco1": 3.8,
"acordo": "",
"uni_for": "UN",
"liberado": "S",
"dt_acordo": "01/01/2025",
"qtde_minima": 0.0,
"dias_entrega": 1
},
{
"codfor": "00001",
"codigo_for": "ABC124",
"codigo_mat": "12346",
"cor": "0001",
"data": "01/01/2025",
"preco": 0.8,
"preco1": 0.8,
"acordo": "",
"uni_for": "UN",
"liberado": "S",
"dt_acordo": "01/01/2025",
"qtde_minima": 0.0,
"dias_entrega": 1
}
]
URL
POST http://{ip_cliente}/ConversaoCodigo
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
POST http://{ip_cliente}/ConversaoCodigo?empresa=001
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| empresa | string / 4 | Não | Número da empresa (ex.: 001 ou _002) |
Atributos
Os atributos devem ser informados no corpo da requisição, conforme exemplo ao lado.
| Nome do atributo | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| acordo | string / 6 | Não | Código do acordo comercial |
| codfor | string / 5 | Sim | Código de cadastro do fornecedor |
| codigo_for | string / 60 | Sim | Código do item do fornecedor |
| codigo_mat | string / 15 | Sim | Código interno no EXCIA ERP |
| cor | string / 6 | Não | Código da cor |
| data | date | Não | Data de cadastro |
| dias_entrega | integer | Não | Dias para entrega |
| dt_acordo | date | Não | Data de validade do acordo comercial |
| liberado | string / 1 | Não | Status liberado ( S / N ) |
| preco | number / 13,5 | Não | Preço atual |
| preco1 | number / 13,5 | Não | Preço original / anterior |
| qtde_minima | number / 9,2 | Não | Quantidade mínima |
| uni_for | string / 3 | Não | Unidade do fornecedor |
Consultar lista de conversão de código
Método responsável por disponibilizar uma listagem do cadastro de conversão de códigos.
Exemplo de retorno:
[
{
"codfor": "00001",
"desc_for": "FORNECEDOR EXEMPLO",
"codigo_for": "ABC123",
"codigo_mat": "1234",
"descricao": "PRODUTO EXEMPLO",
"tipo": "Produto",
"cor": "0001",
"desc_cor": "UNICA",
"data": "01/01/2025",
"preco": 3.8,
"preco1": 3.8,
"acordo": "00001",
"uni_for": "UN",
"liberado": "S",
"dt_acordo": "01/01/2025",
"qtde_minima": 1.0,
"dias_entrega": 1
},
{
"codfor": "00001",
"desc_for": "FORNECEDOR EXEMPLO",
"codigo_for": "ABC124",
"codigo_mat": "1235",
"descricao": "PRODUTO EXEMPLO",
"tipo": "Produto",
"cor": "0001",
"desc_cor": "UNICA",
"data": "01/01/2025",
"preco": 3.8,
"preco1": 3.8,
"acordo": "00001",
"uni_for": "UN",
"liberado": "S",
"dt_acordo": "01/01/2025",
"qtde_minima": 1.0,
"dias_entrega": 1
}
]
URL
GET http://{ip_cliente}/ConversaoCodigo
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/ConversaoCodigo?codfor=00001
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codfor | string / 5 | Não | Código de cadastro do fornecedor |
| codigo_for | string / 60 | Não | Código do item do fornecedor |
| codigo_mat | string / 15 | Não | Código interno no EXCIA ERP |
| empresa | string / 4 | Não | Número da empresa |
Classe Gerencial
Consultar lista de classes gerenciais
Método responsável por disponibilizar uma listagem do cadastro de classes gerenciais.
Exemplo de retorno:
[
{
"codigo": "5100",
"conta": "1.",
"descricao": "RECEITAS",
"operacao": "+",
"tipo": "Normal",
"observacao": "",
"tp_conta": "T"
},
{
"codigo": "5101",
"conta": "1.01.",
"descricao": "RECEITAS OPERACIONAIS",
"operacao": "+",
"tipo": "Normal",
"observacao": "",
"tp_conta": "T"
},
{
"codigo": "5102",
"conta": "1.01.01",
"descricao": "VENDA REPRESENTANTES",
"operacao": "+",
"tipo": "Normal",
"observacao": "",
"tp_conta": "A"
}
]
URL
GET http://{ip_cliente}/ClasseGerencial
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/ClasseGerencial?descricao=Receita
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| codigo | string / 6 | Não | Código da classe gerencial |
| descricao | string / 50 | Não | Descrição |
| operacao | string / 1 | Não | " + " : Crédito " - " : Débito |
| tipo | string / 20 | Não | Tipo de conta: T: Título A: Analítica |
| tp_conta | string / 1 | Não | Tipo de classe gerencial: Normal Valor Pago Juros Desconto Devolucao Impostos Despesas Custo Producao CPV Loja Transferencia |
| conta | string / 20 | Não | Código da conta |
| empresa | string / 4 | Não | Número da empresa |
Natureza de Operação
Consultar natureza de operação
Método responsável por retornar os dados de uma determinada natureza de operação.
Exemplo de retorno:
[
{
"aliq_cofins": 0,
"aliq_pis": 0,
"aliquota": 17.0,
"ativo": "S",
"cfop": "1101",
"cfop_inversa": "",
"clafis": "",
"clatrib": "00",
"cod_aj_sped": "",
"codcct": "",
"codsped": "",
"comp_base_icms": "NNNS",
"comp_base_ipi": "N",
"comp_base_pico": "NNN",
"complemento": "",
"cons_final": "N",
"descricao": "COMPRA PARA INDUSTRIALIZAÇÃO",
"dupli": "S",
"ibscbs": "",
"icms": "1",
"ipi": "2",
"mensagem": "",
"mov_est": "S",
"nat_cont": "",
"natureza": "1101",
"pis_cofins": "S",
"subst_trib": "N",
"tipo": "V",
"tp_base": "2",
"trib_cofins": "70",
"trib_ipi": "49",
"trib_pis": "70"
}
]
URL
GET http://{ip_cliente}/Natureza/:natureza
Parâmetros
Os parâmetros devem ser passados no link da requisição. Sendo a natureza informada como path param.
GET http://{ip_cliente}/Natureza/1101?empresa=_001
Onde "1101" corresponde ao código da natureza de operação.
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| natureza | string / path param | Sim | Código da natureza de operação |
| empresa | string / 3 | Não | Número da empresa |
Consultar lista de naturezas de operação
Método responsável por disponibilizar uma listagem do cadastro de naturezas de operação
Exemplo de retorno:
[
{
"ativo": "S",
"cfop": "1101",
"descricao": "COMPRA PARA INDUSTRIALIZAÇÃO ",
"dupli": "S",
"natureza": "1101",
"tipo": "V",
"tp_base": "2"
},
{
"ativo": "S",
"cfop": "1101",
"descricao": "COMPRA PARA INDUSTRIALIZAÇÃO ",
"dupli": "S",
"natureza": "1101X",
"tipo": "V",
"tp_base": "2"
}
]
URL
GET http://{ip_cliente}/Natureza
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo:
GET http://{ip_cliente}/Natureza?ativo=S&tipo=V
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| ativo | string / 1 | Não | Situação do cadastro S: Ativo N: Inativo |
| descricao | string / 80 | Não | Descrição |
| tipo | string / 1 | Não | Tipo da natureza de operação V: Venda/Compra D: Devolução R: Retorno/Remessa C: Consignação A: Antecipação S: Serviço B: Bonificação/Brindes I: Imposto Complementar J: Ajuste |
| tp_base | string / 1 | Não | Operação 1: Saída 2: Entrada |
| cfop | string / 8 | Não | Código da CFOP |
| empresa | string / 4 | Não | Número da empresa |
Logs
Consultar lista de logs
Método responsável por disponibilizar uma listagem dos logs, gravados a partir de uma determinada data.
Exemplo de retorno dos logs do pedido:
http://{ip_cliente}/LogLista?data=15/02/2022&tela=pedido&chave=10352
[
{
"usuario": "USUARIO",
"data": "15/02/2022",
"hora": "13:43:04",
"tela": "PEDIDO",
"descricao": "CADASTRO DO PEDIDO Nº 10352 FAT 15/02/2022",
"empresa": "_001",
"operacao": "Inclusão",
"chave": "10352",
"formulario": "WaitForm"
}
]
Exemplo de retorno dos logs da duplicata:
http://{ip_cliente}/LogLista?data=15/02/2022&tela=duplicata&chave=0657233
[
{
"usuario": "USUARIO",
"data": "15/02/2022",
"hora": "13:45:25",
"tela": "FATURAMENTO DUPLICATAS",
"descricao": "ALTERACAO DA DUPLICATA 0657233/1 SITUACAO: 11 DATA VENC.: 17/03/2022",
"empresa": "_001",
"operacao": "Alteração",
"chave": "0657233",
"formulario": "fmAlteraDup"
}
]
Consulta onde nenhum registro do item foi encontrado:
http://{ip_cliente}/LogLista?data=15/02/2022&tela=pedido&chave=0
[
{
"method-error-400": "Não foi possível buscar Log: Nenhum registro encontrado."
}
]
URL
GET http://{ip_cliente}/LogLista
Retorno
A consulta irá considerar os logs com a data maior ou igual a data informada via parâmetro.
Em caso de sucesso será retornado status 200 e o objeto JSON.
Em caso de erro, será retornado error 400 e um descritivo do erro no objeto JSON.
Parâmetros
Os parâmetros devem ser passados no link da requisição, por exemplo, para consultar os logs de um determinado pedido, a parametrização deve ser feita da seguinte forma:
GET http://{ip_cliente}/LogLista?data=15/02/2022&tela=pedido&chave=10352
Os parâmetros que forem informados com a nomenclatura diferente da informada na tabela abaixo serão ignorados na consulta.
Lista de parâmetros
| Nome do parâmetro | Tipo / Tamanho | Obrigatório | Descrição |
|---|---|---|---|
| data | date | Sim | Data inicial da consulta (DD/MM/YYYY) |
| tela | string / 50 | Sim | Tela associada ao log |
| chave | string / 25 | Não | Número chave associado à determinada operação |
| descricao | string / 150 | Não | Descrição do log |
| operacao | string / 1 | Não | I: Inclusão A: Alteração E: Exclusão M: Movimentação |