Shop Control 9 / Integrações Documentação da API

Integrações

Documentação técnica da API do módulo Integrações do Shop Control 9.

Introdução

O Integrações é um módulo desenvolvido para receber requisições de um serviço web para coleta de informações do banco de dados do Shop Control 9, permitindo assim a atualização de sites e/ou sistemas de vendas online. Ele também é responsável por receber os dados de vendas feitas na plataforma online e gerar as sequências de saídas no sistema, bem como a emissão de nota fiscal.

Através deste manual técnico, informamos as linhas de comando necessárias para o webservice tratar as requisições entre ele e o módulo Integrações.

A ativação em uma base real adiciona valor à renovação de licença do cliente que fará uso. O módulo Integrações está disponível apenas para clientes com o Shop Control 9 Corporate. Consulte o departamento comercial sobre os valores antes de iniciar o processo de homologação.

E-mail: comercial@idealsoft.com.br  ·  Fone: (41) 3013-1161

Visão Geral

Segue abaixo a lista de informações que estão no Shop Control 9 e que o módulo Integrações disponibiliza para o webservice:

Cadastros

  • Classes, Subclasses, Grupos, Famílias e Fabricantes
  • Unidades de Venda, Cores, Tamanhos e Moedas
  • Campos de Pesquisa 1, 2 e 3
  • Clientes e Contatos dos Clientes (telefones, e-mail, data de nascimento, etc.)
  • Produtos, Fotos das mercadorias, Preços, Estoque e Promoções

Movimento

  • Recebimento das vendas feitas no site, para a criação das sequências de saída no Shop Control 9, com efetivação de estoque/financeiro e emissão de NF-e/NFC-e
  • Entradas, Devoluções, Ordens de Serviço, Contagem de Estoque e Crédito de Cliente

Arquitetura

A arquitetura da API do módulo Integrações é separada entre a requisição de autenticação e as demais requisições. A requisição de autenticação traz o token a ser utilizado em todas as outras requisições.

O token possui validade limitada (informada no campo expireAt da resposta de autenticação) e deve ser gerado novamente após expirar, para que as validações de data e hora com o servidor e o licenciamento do módulo ocorram.

Cabeçalho da Requisição

Todas as requisições devem passar uma série de parâmetros no header:

HeaderDescrição
SignatureAssinatura HMAC SHA256 da requisição (ver cálculo abaixo).
CodFilialCódigo da filial do Shop Control 9 para a qual o token foi gerado.
AuthorizationToken gerado pela requisição de Autenticação, no modelo Token [tokenGerado].
TimestampO timestamp utilizado para gerar o campo Signature, para conferência.

Cálculo da Signature

Para garantir que as informações enviadas na requisição estejam íntegras e não tenham sofrido modificações até o servidor, o campo Signature deve ser calculado da seguinte forma:

  1. Concatenar os campos: Método HTTP + Timestamp + Conteúdo do BODY (se houver).
    • O método HTTP precisa estar em minúsculo (ex.: get, post, put, delete).
    • O conteúdo do body precisa estar sem espaços no começo e no fim e convertido para Base64.
  2. Encriptar os dados concatenados com o algoritmo HMAC SHA256, utilizando a senha informada nas configurações do módulo.
  3. Converter o resultado encriptado para Base64.
conteudo  = metodoHttpMinusculo + timestamp + base64(trim(body))
signature = base64( HMACSHA256(conteudo, senhaDoModulo) )

Resposta

Todas as requisições processadas e respondidas pelo servidor retornam o status HTTP 200 OK, independente do sucesso da resposta. Todas as respostas são retornadas no padrão JSON e têm o seguinte formato:

{
  "sucesso": [bool],
  "mensagem": [string],
  "tipo": [string],
  "complementoTipo": [string],
  "statusCode": [int],
  "dados": [json]
}

Descrição dos campos

CampoDescrição
sucessoBooleano que indica se a resposta pode ser considerada válida para processamento. Caso seja false, o campo dados virá sem valor e os campos mensagem e tipo serão preenchidos com mais informações a respeito do problema.
mensagemInformações do erro da requisição, caso sucesso seja false. Pode ser uma mensagem simples de validação das regras de negócio ou uma mensagem de erro retornada pelo servidor (algumas vezes em inglês). Utilizar em conjunto com tipo, complementoTipo e statusCode para tratamento de erros e logs.
tipoInformação técnica do tipo do erro, para auxiliar a depuração. Tipos possíveis: EXCECAO_SERVIDOR, AUTENTICACAO_INVALIDA, HEADER_INVALIDO, BODY_INVALIDO, CAMPO_INVALIDO, LICENCA_EXPIRADA_OU_INVALIDA, FIM_DE_PAGINA, REGISTRO_NAO_ENCONTRADO, TIPO_BUSCA_INVALIDO.
complementoTipoSó virá preenchido caso o campo tipo seja ambíguo ou complexo a ponto de precisar de um complemento.
statusCodeTraz 200 nos casos de sucesso. Nos casos de erro, traz um código HTTP relativo ao problema (ex.: 401 Não autorizado, para token inválido).
dadosCampo onde as informações requisitadas são apresentadas. Pode ser um objeto simples ou uma lista, dependendo da requisição.

Convenções

  • Base URL: nos exemplos desta documentação, {{server}} representa a URL do serviço fornecida pela IdealSoft para o seu ambiente.
  • Paginação: as requisições paginadas trazem no máximo 20 registros por página (10 em alguns endpoints). Para obter o cadastro completo, percorra as páginas a partir da página 1 até que a requisição retorne o tipo FIM_DE_PAGINA.
  • Filtros de data: os parâmetros datade / dataate filtram por data de alteração e permitem sincronizações incrementais. Formato: YYYY-MM-DD HH:MM:SS.
  • Autenticação: todas as requisições (exceto /auth) exigem os headers descritos em Cabeçalho da Requisição.

Homologação

A IdealSoft disponibiliza uma área de homologação com uma base de testes para clientes em processo de integração realizarem os testes das requisições antes de utilizar o módulo Integrações em produção. Ao requisitar o módulo com o setor comercial, você deverá receber o código da filial de homologação para autenticar o serviço.

Caso deseje seguir o roteiro de homologação, leia a seção Roteiro de Teste.

Roteiro de Teste

A IdealSoft disponibiliza uma base de dados com uma simulação dos dados de uma empresa de testes para que o desenvolvedor possa testar as chamadas para o serviço sem alterar dados em produção. Antes de adquirir o módulo Integrações, será disponibilizado um número de série, um código de filial de testes e uma senha para montar as requisições no serviço web desenvolvido. Dessa forma, certificamos que o serviço web desenvolvido estará em conformidade com este manual técnico e realizará corretamente a comunicação com o módulo Integrações.

Para solicitar o número de série e o código de filial, envie um e-mail para suporte@idealsoft.com.br.

A URL do ambiente de testes é:

http://idealsoftexportaweb.eastus.cloudapp.azure.com:60500/

Primeiramente, requisite um token através do endpoint de Autenticação, informando a série e o código de filial recebidos. O token será utilizado em todas as outras requisições.

Autenticação

Faz a validação do licenciamento para o número de série e filial informados. Retorna o token para utilização nas demais requisições.

GET Gerar Token

{{server}}/auth/?serie=[string]&codfilial=[integer]

Parâmetros de query

ParâmetroDescrição
serieNúmero de série licenciado para uso.
codfilialCódigo da filial do Shop Control 9 licenciada para uso.

Resposta (campo dados)

CampoDescrição
tokenToken para utilização nas demais requisições. Após expirar, deve ser feita outra requisição de token.
expireAtData/hora em UTC (YYYY-MM-DDTHH:MM:SS.0000000+00:00) do momento em que o token irá expirar. Pode ser utilizada para controlar a requisição de novos tokens.

Filiais

GET Filiais Paginado

{{server}}/filiais/1

Parâmetros de query

ParâmetroExemplo
ativotrue
datade2025-04-01 00:00:00
dataate2025-04-30 23:59:59

GET Filiais Detalhado

{{server}}/filiais/detalhes/1

Funcionários

GET Funcionário Paginado

{{server}}/funcionarios/1

Parâmetros de query

ParâmetroExemplo
ativotrue
vendedortrue
tecnicotrue

GET Funcionário Detalhado

{{server}}/funcionarios/detalhes/1

Auxiliares

GET Classes

{{server}}/aux/classes

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Classes - Clientes e Fornecedores

{{server}}/aux/cli_for_classes

Parâmetros de query

ParâmetroExemplo
datade2026-01-01
dataate2026-05-06

GET Subclasses

{{server}}/aux/subclasses

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Grupos

{{server}}/aux/grupos

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Famílias

{{server}}/aux/familias

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Fabricantes

{{server}}/aux/fabricantes

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Unidades de Venda

{{server}}/aux/unidades_venda

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Cores

{{server}}/aux/cores

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Tamanhos

{{server}}/aux/tamanhos

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Moedas

{{server}}/aux/moedas

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Pesquisa 1

{{server}}/aux/pesquisa_1

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Pesquisa 2

{{server}}/aux/pesquisa_2

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

GET Pesquisa 3

{{server}}/aux/pesquisa_3

Parâmetros de query

ParâmetroExemplo
datade2025-04-01
dataate2025-04-30

Clientes

GET Clientes Detalhes

{{server}}/clientes/detalhes/1

GET Clientes Detalhes por Cpf Cnpj

{{server}}/clientes/detalhes/cpfcnpj/1

GET Clientes Detalhes por Ordem

{{server}}/clientes/detalhes/porordem/1

GET Clientes Paginado

{{server}}/clientes/1

Parâmetros de query

ParâmetroExemplo
datade2020-01-01 00:00:00
dataate2025-12-31 23:59:59
ativoA

GET Grupos Cliente

{{server}}/clientes/grupos/1

POST Cadastrar Cliente

{{server}}/clientes

Corpo da requisição (exemplo)

{
  "nome": "Teste 110425-2",
  "fantasia": "",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "49130796032",
  "rg": "",
  "ie": "ISENTO",
  "cep": "80045135",
  "endereco": "Rua professor brandão, 281",
  "numero": "11",
  "complemento": "",
  "bairro": "",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": true,
  "codigoClasse": "",
  "inativo": false,
  "vendedor1": {
    "ordem": 1,
    "codigo": null
  },
  "vendedor2": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico1": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico2": {
    "ordem": 1,
    "codigo": null
  },
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "bloqueado": false,
  "comentarios": ""
}

Variações do corpo da requisição

Cadastrar com Código
{
  "codigo": 360,
  "nome": "Teste 110425-2",
  "fantasia": "",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "71817232002",
  "rg": "",
  "ie": "PR",
  "cep": "",
  "endereco": "",
  "numero": "11",
  "complemento": "",
  "bairro": "",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": true,
  "codigoClasse": "",
  "inativo": false,
  "vendedor1": {
    "ordem": 1,
    "codigo": null
  },
  "vendedor2": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico1": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico2": {
    "ordem": 1,
    "codigo": null
  },
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "bloqueado": false,
  "comentarios": ""
}
Cadastrar com Código - Análise Crédito
{
  "codigo": 360,
  "nome": "Teste 110425-2",
  "fantasia": "",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "71817232002",
  "rg": "",
  "ie": "PR",
  "cep": "",
  "endereco": "",
  "numero": "11",
  "complemento": "",
  "bairro": "",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": true,
  "codigoClasse": "",
  "inativo": false,
  "vendedor1": {
    "ordem": 1,
    "codigo": null
  },
  "vendedor2": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico1": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico2": {
    "ordem": 1,
    "codigo": null
  },
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "analiseDeCredito": {
    "fichaAguardandoAnalise": false,
    "empresa": "IdealSoft",
    "salario": 3000.0,
    "cargo": "Diretor",
    "contratacao": "2001-01-01",
    "telefone": "4131121312",
    "estadoCivil": "S",
    "tipoResidencia": "P",
    "tempoResidencia": "10",
    "sexo": "M",
    "nascimento": "2001-01-01",
    "naturalidade": "Brasileiro",
    "rgExpedidoPor": "DETRAN",
    "rgExpedidoEm": "2001-01-01",
    "nomeConjuge": "Janice",
    "cpfConjuge": "111111111111",
    "empresaConjuge": "IdealSoft",
    "salarioConjuge": 3000.0,
    "cargoConjuge": "RH",
    "contratacaoConjuge": "2001-01-01",
    "telefoneConjuge": "41333333",
    "nascimentoConjuge": "2001-01-01",
    "observacao": "",
    "nomePai": "Luiz",
    "nomeMae": "Ana"
  },
  "tabelaPrecosPadrao": "Tabela",
  "bloqueado": false,
  "comentarios": ""
}
Cadastrar Cliente - Analise Crédito
{
  "nome": "Teste 110425-2",
  "fantasia": "",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "49130796032",
  "rg": "",
  "ie": "ISENTO",
  "cep": "80045135",
  "endereco": "Rua professor brandão, 281",
  "numero": "11",
  "complemento": "",
  "bairro": "",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": true,
  "codigoClasse": "",
  "inativo": false,
  "vendedor1": {
    "ordem": 1,
    "codigo": null
  },
  "vendedor2": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico1": {
    "ordem": 1,
    "codigo": null
  },
  "tecnico2": {
    "ordem": 1,
    "codigo": null
  },
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "TabelaPrecosPadrao": "TABELA 1",
  "analiseDeCredito": {
    "fichaAguardandoAnalise": false,
    "empresa": "IdealSoft",
    "salario": 3000.0,
    "cargo": "Diretor",
    "contratacao": "2001-01-01",
    "telefone": "4131121312",
    "estadoCivil": "S",
    "tipoResidencia": "P",
    "tempoResidencia": "10",
    "sexo": "M",
    "nascimento": "2001-01-01",
    "naturalidade": "Brasileiro",
    "rgExpedidoPor": "DETRAN",
    "rgExpedidoEm": "2001-01-01",
    "nomeConjuge": "Janice",
    "cpfConjuge": "111111111111",
    "empresaConjuge": "IdealSoft",
    "salarioConjuge": 3000.0,
    "cargoConjuge": "RH",
    "contratacaoConjuge": "2001-01-01",
    "telefoneConjuge": "41333333",
    "nascimentoConjuge": "2001-01-01",
    "observacao": "",
    "nomePai": "Luiz",
    "nomeMae": "Ana"
  },
  "tabelaPrecosPadrao": "Tabela",
  "bloqueado": false,
  "comentarios": ""
}

POST Adicionar Grupo Cliente

{{server}}/clientes/grupos/1

Corpo da requisição (exemplo)

{
  "codigoGrupo": 2
}

PUT Atualizar Cliente

{{server}}/clientes

Corpo da requisição (exemplo)

{
  "nome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
  "fantasia": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "49130796032",
  "rg": "",
  "ie": "ISENTO",
  "cep": "80045135",
  "endereco": "Rua Professor Brandão",
  "numero": "281",
  "complemento": "",
  "bairro": "Alto da Rua XV",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "41997389831",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": false,
  "codigoClasse": "",
  "inativo": false,
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "bloqueado": false,
  "comentarios": ""
}

Variações do corpo da requisição

Atualizar Cliente - Análise de Crédito
{
  "nome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
  "fantasia": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
  "tipo": "C",
  "fisicaJuridica": "F",
  "cpfCnpj": "49130796032",
  "rg": "",
  "ie": "ISENTO",
  "cep": "80045135",
  "endereco": "Rua Professor Brandão",
  "numero": "281",
  "complemento": "",
  "bairro": "Alto da Rua XV",
  "cidade": "Curitiba",
  "uf": "PR",
  "pais": "Brasil",
  "telefone1": "41997389831",
  "lGPD_Receber_Campanhas_Marketing": false,
  "lGPD_Receber_Contato_Situacao_Pedido": false,
  "lGPD_Telefone_Contato_Formatado": "",
  "telefone2": "",
  "fax": "",
  "entregaCep": "",
  "entregaEndereco": "",
  "entregaNumero": "",
  "entregaComplemento": "",
  "entregaBairro": "",
  "entregaCidade": "",
  "entregaUf": "",
  "entregaPais": "",
  "entregaPontoRef1": "",
  "entregaPontoRef2": "",
  "faturamentoCep": "",
  "faturamentoEndereco": "",
  "faturamentoNumero": "",
  "faturamentoComplemento": "",
  "faturamentoBairro": "",
  "faturamentoCidade": "",
  "faturamentoUf": "",
  "faturamentoPais": "",
  "faturamentoPontoRef1": "",
  "faturamentoPontoRef2": "",
  "indicadorIE": 1,
  "utiliza_Fidelidade": false,
  "codigoClasse": "",
  "inativo": false,
  "vendedorExclusivo": false,
  "tecnicoExclusivo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "analiseDeCredito": {
    "fichaAguardandoAnalise": false,
    "empresa": "IdealSoft",
    "salario": 3000.0,
    "cargo": "Diretor",
    "contratacao": "2001-01-01",
    "telefone": "4131121312",
    "estadoCivil": "S",
    "tipoResidencia": "P",
    "tempoResidencia": "10",
    "sexo": "M",
    "nascimento": "2001-01-01",
    "naturalidade": "Brasileiro",
    "rgExpedidoPor": "DETRAN",
    "rgExpedidoEm": "2001-01-01",
    "nomeConjuge": "Janice",
    "cpfConjuge": "111111111111",
    "empresaConjuge": "IdealSoft",
    "salarioConjuge": 3000.0,
    "cargoConjuge": "RH",
    "contratacaoConjuge": "2001-01-01",
    "telefoneConjuge": "41333333",
    "nascimentoConjuge": "2001-01-01",
    "observacao": "",
    "nomePai": "Luiz",
    "nomeMae": "Ana"
  },
  "bloqueado": false,
  "comentarios": ""
}

PATCH Atualizar Cliente Parcialmente por Código

{{server}}/clientes/1

Corpo da requisição (exemplo)

{
  "codigoClasse": 0,
  "inativo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "bloqueado": false,
  "comentarios": ""
}

Variações do corpo da requisição

Atualizar Parcialmente por Código - Análise Crédito
{
  "codigoClasse": 0,
  "inativo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "analiseDeCredito": {
    "fichaAguardandoAnalise": false,
    "empresa": "IdealSoft",
    "salario": 3000.0,
    "cargo": "Diretor",
    "contratacao": "2001-01-01",
    "telefone": "4131121312",
    "estadoCivil": "S",
    "tipoResidencia": "P",
    "tempoResidencia": "10",
    "sexo": "M",
    "nascimento": "2001-01-01",
    "naturalidade": "Brasileiro",
    "rgExpedidoPor": "DETRAN",
    "rgExpedidoEm": "2001-01-01",
    "nomeConjuge": "Janice",
    "cpfConjuge": "111111111111",
    "empresaConjuge": "IdealSoft",
    "salarioConjuge": 3000.0,
    "cargoConjuge": "RH",
    "contratacaoConjuge": "2001-01-01",
    "telefoneConjuge": "41333333",
    "nascimentoConjuge": "2001-01-01",
    "observacao": "",
    "nomePai": "Luiz",
    "nomeMae": "Ana"
  },
  "bloqueado": false,
  "comentarios": ""
}

PATCH Atualizar Cliente Parcialmente por Cpf/Cnpj

{{server}}/clientes

Corpo da requisição (exemplo)

{
  "cpfCnpj": "34894058000148",
  "codigoClasse": 0,
  "inativo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "bloqueado": false,
  "comentarios": ""
}

Variações do corpo da requisição

Atualizar Parcialmente por Cpf/Cnpj - Análise De Crédito
{
  "cpfCnpj": "34894058000148",
  "codigoClasse": 0,
  "inativo": false,
  "parcelamentoBoleto": false,
  "parcelamentoCarne": false,
  "parcelamentoCarteira": false,
  "cheque": false,
  "chequePre": false,
  "cartaoDebito": false,
  "cartaoCredito": false,
  "cartaoConvenio": false,
  "textoParaExibicao": "",
  "mostrarTextoNaEntrada": false,
  "limiteCredito": 600,
  "dataUltimaAnaliseCredito": "2022-01-24",
  "dataValidadeCredito": "2022-04-30",
  "filialExclusiva": false,
  "codigoFilial": 1,
  "tabelaPrecosPadrao": "Tabela",
  "analiseDeCredito": {
    "fichaAguardandoAnalise": false,
    "empresa": "IdealSoft",
    "salario": 3000.0,
    "cargo": "Diretor",
    "contratacao": "2001-01-01",
    "telefone": "4131121312",
    "estadoCivil": "S",
    "tipoResidencia": "P",
    "tempoResidencia": "10",
    "sexo": "M",
    "nascimento": "2001-01-01",
    "naturalidade": "Brasileiro",
    "rgExpedidoPor": "DETRAN",
    "rgExpedidoEm": "2001-01-01",
    "nomeConjuge": "Janice",
    "cpfConjuge": "111111111111",
    "empresaConjuge": "IdealSoft",
    "salarioConjuge": 3000.0,
    "cargoConjuge": "RH",
    "contratacaoConjuge": "2001-01-01",
    "telefoneConjuge": "41333333",
    "nascimentoConjuge": "2001-01-01",
    "observacao": "",
    "nomePai": "Luiz",
    "nomeMae": "Ana"
  },
  "bloqueado": false,
  "comentarios": ""
}

Fotos

GET Buscar Foto

{{server}}/clientes/foto/5

POST Adicionar Foto

{{server}}/clientes/foto/5

Corpo da requisição (exemplo)

/9j/4AAQSkZJRgABAQEASABIAAD/4QC8RXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABgAAkAcABAAAADAyMTABkQcABAAAAAECAwAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAAMADAAADoAQAAQAAAMADAAAAAAAA/9sAQwABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB/9sAQwEBAQEBAQEBAQEBAQEBAQEB… (conteúdo truncado — ex.: imagem em Base64)

DELETE Deletar Foto

{{server}}/clientes/foto/5

Contatos

GET Contatos

{{server}}/clientes/contatos/1

GET Contatos por Data

{{server}}/clientes/contatos

Parâmetros de query

ParâmetroExemplo
datade2025-04-01 00:00:00
dataate2025-04-30 23:59:59

POST Cadastrar Contato

{{server}}/clientes/contatos/10014

Corpo da requisição (exemplo)

[
  {
    "Sexo": "M",
    "Cargo": "Teste",
    "DiaAniversario": "1",
    "MesAniversario": "JAN",
    "AnoAniversario": "1995",
    "Telefone": "",
    "Ramal": "",
    "TipoEmail": "",
    "Email": "",
    "Ordem": 1,
    "Codigo": null,
    "Nome": ""
  }
]

PUT Atualizar Contato

{{server}}/clientes/contatos/10014/23

Corpo da requisição (exemplo)

{
  "Sexo": "M",
  "Cargo": "Teste",
  "DiaAniversario": "1",
  "MesAniversario": "JAN",
  "AnoAniversario": "1995",
  "Telefone": "",
  "Ramal": "",
  "TipoEmail": "",
  "Email": "",
  "Ordem": 23,
  "Codigo": null,
  "Nome": ""
}

Download Xml

POST Autorizar Download Xml

{{server}}/clientes/downloadXml/1

Corpo da requisição (exemplo)

{
  "Ordem": 1,
  "Ordem_Origem": null,
  "Tipo_Origem": "C",
  "Nome": "as",
  "Tipo": "F",
  "CPF_CNPJ": "1111111111",
  "Ordem_Funcionario_Validacao": 0,
  "Data_Alteracao": "0001-01-01T00:00:00"
}

PUT Autorizar Download Xml

{{server}}/clientes/downloadXml/1/1

Corpo da requisição (exemplo)

{
  "Ordem": 1,
  "Ordem_Origem": null,
  "Tipo_Origem": "C",
  "Nome": "as",
  "Tipo": "F",
  "CPF_CNPJ": "1111111111",
  "Ordem_Funcionario_Validacao": 0,
  "Data_Alteracao": "0001-01-01T00:00:00"
}

DELETE Autorizar Download Xml

{{server}}/clientes/downloadXml/1/1

Produtos

GET Produtos Detalhes

{{server}}/produtos/detalhes/1

Parâmetros de query

ParâmetroExemplo
ignorarNaoExportarWeb0

GET Produtos Detalhes por Ordem

{{server}}/produtos/detalhes/porordem/1

GET Produtos Paginado

{{server}}/produtos/1

Parâmetros de query

ParâmetroExemplo
datade2020-01-01 00:00:00
dataate2025-12-31 23:59:59

GET Grades

{{server}}/produtos/grades/1

POST Cadastrar Produto (Não disponível)

{{server}}/produtos

Corpo da requisição (exemplo)

{
  "codigo": "",
  "nome": "",
  "tipo": 0,
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Ordem

{{server}}/produtos/porordem/1573

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Ean

{{server}}/produtos/porean/1573

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Ean Tributável

{{server}}/produtos/poreantributavel/1234567890123

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código Adicional 1

{{server}}/produtos/poradicional1/1

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código Adicional 2

{{server}}/produtos/poradicional2/2

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código Adicional 3

{{server}}/produtos/poradicional3/3

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código Adicional 4

{{server}}/produtos/poradicional4/4

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código Adicional 5

{{server}}/produtos/poradicional5/5

Corpo da requisição (exemplo)

{
  "nome": "",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "",
  "ordemNcm": null,
  "codigoCest": "1",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PUT Editar Produto por Código

{{server}}/produtos/20

Corpo da requisição (exemplo)

{
  "nome": "Testaniiii",
  "inativo": false,
  "codigoUnidadeVenda": 1,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "codigoClasse": 1,
  "ordemClasse": null,
  "codigoSubClasse": 1,
  "ordemSubClasse": null,
  "codigoGrupo": 1,
  "ordemGrupo": null,
  "codigoFamilia": 1,
  "ordemFamilia": null,
  "codigoPesquisa1": 1,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 1,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 1,
  "ordemPesquisa3": null,
  "codigoFabricante": 1,
  "ordemFabricante": null,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoBarras": "",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 0.0,
  "pesoBruto": 0.0,
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": null,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": null,
  "ordemClasseImpostoEntrada": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoNcm": "04022130",
  "ordemNcm": null,
  "codigoCest": "0100400",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "1",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

PATCH Produtos

{{server}}/produtos/1

Corpo da requisição (exemplo)

{
  "nome": "Produto D",
  "tipo": 0,
  "inativo": false,
  "extra1": "",
  "extra2": "",
  "extra3": "",
  "obs": "",
  "codigoClasse": 10003,
  "ordemClasse": null,
  "codigoSubclasse": 10003,
  "ordemSubClasse": null,
  "codigoGrupo": 10003,
  "ordemGrupo": null,
  "codigoFamilia": 10003,
  "ordemFamilia": null,
  "codigoPesquisa1": 4,
  "ordemPesquisa1": null,
  "codigoPesquisa2": 16,
  "ordemPesquisa2": null,
  "codigoPesquisa3": 30,
  "ordemPesquisa3": null,
  "codigoFabricante": 0,
  "ordemFabricante": null,
  "codigoUnidadeVenda": 10000,
  "ordemUnidadeVenda": null,
  "codigoMoeda": 1,
  "ordemMoeda": null,
  "altura": 0.0,
  "largura": 0.0,
  "comprimento": 0.0,
  "pesoLiquido": 2.0,
  "pesoBruto": 2.0,
  "codigoBarras": "7896004715292",
  "codigoAdicional1": "",
  "codigoAdicional2": "",
  "codigoAdicional3": "",
  "codigoAdicional4": "",
  "codigoAdicional5": "",
  "nomeSite": "",
  "descWeb1": "",
  "descWeb2": "",
  "codigoClasseImpostoSaida": 1,
  "ordemClasseImpostoSaida": null,
  "codigoClasseImpostoEntrada": 2,
  "ordemClasseImpostoEntrada": null,
  "codigoNCM": "843",
  "ordemNcm": null,
  "origem": 0,
  "tipoItem": 0,
  "exTipi": "",
  "codigoCest": "",
  "ordemCest": null,
  "codigoEnquadramentoIpi": "",
  "ordemEnquadramentoIpi": null,
  "naoIncluirNasListasDePreco": false,
  "usoInterno": false,
  "bloquearVenda": false,
  "bloquearMovimento": false,
  "bloquearLancamentoEntrada": false,
  "bloquearLancamentoSaida": false,
  "bloqueadoApenasParaLancamento": false,
  "produtoEmContagem": false,
  "controlarEstoque": true,
  "casasDecimaisPreco": 2,
  "casasDecimaisQtde": 0,
  "utilizarMultiplicadorCodigosAdicionais": true,
  "multiplicadorCodigoAdicional1": 7,
  "multiplicadorCodigoAdicional2": 8,
  "multiplicadorCodigoAdicional3": 9,
  "multiplicadorCodigoAdicional4": 10,
  "multiplicadorCodigoAdicional5": 11
}

Preços

GET Preços de um produto

{{server}}/v2/precos/1

GET Preços de Produtos Paginado

{{server}}/v3/precos/1

Parâmetros de query

ParâmetroExemplo
datade06-05-2026
dataate06-05-2026
considerarPromocoesAlteradasfalse

PUT Alterar Preço Tabela

{{server}}/produtos/1/tabelasprecos/1

Corpo da requisição (exemplo)

{
  "precoAtualizado": 12.34
}

Fornecedores

POST Cadastrar Fornecedor Produto

{{server}}/produtos/1/fornecedores

Corpo da requisição (exemplo)

{
  "ordemFornecedor": null,
  "codigoFornecedor": null
}

DELETE Remover Fornecedor Produto

{{server}}/produtos/1/fornecedores/0

Fotos

GET Foto por posição

{{server}}/fotos/1/1

GET Produtos Fotos

{{server}}/fotos/1

GET Produtos Fotos Paginado

{{server}}/v2/fotos/1

Parâmetros de query

ParâmetroExemplo
datade2025-09-04 00:00:00
dataate2025-09-08 23:59:59

POST Cadastrar Foto Produto

{{server}}/produtos/1/fotos/0

Corpo da requisição (exemplo)

/9j/4AAQSkZJRgABAQAAAQABAAD/4QBiRXhpZgAATU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAEAAAITAAMAAAABAAEAAAAAAAAAAAABAAAAAQAAAAEAAAAB/+IB2ElDQ19QUk9GSUxFAAEBAAAByAAAAAAEMAAAbW50clJHQiBYWVogB+AAAQABAAAAAAAAYWNzcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAPbWAAEAAAAA0y0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJZGVzYwAAAPAAAAAkclhZWgAAARQAAAAUZ1hZWgAA… (conteúdo truncado — ex.: imagem em Base64)

DELETE Remover Foto Produto

{{server}}/produtos/1/fotos/3

Promoções

GET Promoções Paginado

{{server}}/promocoes/1

GET Promoções Detalhado

{{server}}/promocoes/produto/1

Tabelas de Preços

GET Tabela de Preço

{{server}}/tabelasprecos/1

Parâmetros de query

ParâmetroExemplo
datade2025-03-01 00:00:00
dataate2025-03-31 23:59:59
ativofalse

Estoque

GET Lote Paginado

{{server}}/v2/estoque/detalhes/1/lote

GET Lote Detalhado

{{server}}/v2/estoque/detalhes/1/lote/1

Contagem de Estoque

GET Contagem Paginada

{{server}}/contagemestoque/1

Parâmetros de query

ParâmetroExemplo
situacaoT

GET Contagem Detalhada Normal

{{server}}/contagemestoque/detalhes/1

POST Criar Contagem

{{server}}/contagemestoque

Corpo da requisição (exemplo)

{
  "tipo": "N",
  "descricao": "Normal Integrações",
  "listaProdutos": [
    {
      "codigoProduto": "1",
      "qtdeDigitada": 1
    },
    {
      "codigoProduto": "2",
      "qtdeDigitada": 2
    }
  ]
}

Variações do corpo da requisição

Lista Edição
{
  "tipo": "E",
  "descricao": "Edição Integrações",
  "listaProdutos": [
    {
      "codigoProduto": "1502600000123",
      "qtdeDigitada": 3,
      "codigoEdicao": 1
    },
    {
      "codigoProduto": "1502600000123",
      "codigoEdicao": 2
    }
  ]
}
Lista Grade
{
  "tipo": "G",
  "descricao": "Grade Integrações",
  "listaProdutos": [
    {
      "codigoProduto": "14725001001",
      "qtdeDigitada": 3
    },
    {
      "codigoProduto": "14725003001"
    }
  ]
}
Lista Lote
{
  "tipo": "L",
  "descricao": "Lote Integrações",
  "listaProdutos": [
    {
      "codigoProduto": "15023",
      "lotes": [
        {
          "lote": "123",
          "qtde": 300,
          "fabricacao": "2026-03-11 10:10:05",
          "validade": "2026-03-16 10:10:05"
        },
        {
          "lote": "15",
          "qtde": 2000,
          "fabricacao": "2026-03-10 10:10:05",
          "validade": "2026-03-17 10:10:05"
        }
      ]
    },
    {
      "codigoProduto": "LOTE",
      "lotes": [
        {
          "lote": "LB",
          "qtde": 100,
          "fabricacao": "2026-03-11 10:10:05",
          "validade": "2026-03-16 10:10:05"
        },
        {
          "lote": "teste 123",
          "qtde": 5000,
          "fabricacao": "2026-02-10 10:10:05",
          "validade": "2026-04-10 10:10:05"
        }
      ]
    }
  ]
}
Lista Série
{
  "tipo": "S",
  "descricao": "Séries Integrações",
  "listaProdutos": [
    {
      "codigoProduto": "147253",
      "series": [
        "1",
        "2"
      ]
    }
  ]
}

PUT Atualizar Contagem

{{server}}/contagemestoque/1/itens

Corpo da requisição (exemplo)

{
  "Numero": 1,
  "ListaProdutos": [
    {
      "OrdemContagemItem": 1,
      "QtdeDigitada": 10.0
    }
  ]
}

PUT Atualizar Contagem Lotes

{{server}}/contagemestoque/1/itens/lotes

Corpo da requisição (exemplo)

{
  "Numero": 1,
  "ListaProdutos": [
    {
      "OrdemContagemItem": 1,
      "Lotes": [
        {
          "Lote": "1",
          "Qtde": 10,
          "DataFabricacao": "2025-03-17T00:00:00",
          "DataValidade": "2025-03-31T00:00:00"
        }
      ]
    }
  ]
}

Saídas (Vendas)

GET Saida Detalhada

{{server}}/saidas/detalhes/19209

Exemplos de resposta

Saida Detalhada200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": null
}

GET Saidas Paginado

{{server}}/saidas/1

Parâmetros de query

ParâmetroExemplo
tipodataA
datade2025-04-01 00:00:00
dataate2025-04-30 23:59:59
tiposoperacaoVND

GET Consultar Venda

{{server}}/vendas/{{recibo}}

GET Campos Customizaveis

{{server}}/saidas/camposcustomizaveis

POST Gerar Saída (Assíncrono, via Recibo)

{{server}}/vendas

Corpo da requisição (exemplo)

{
  "codigoCliente": "1",
  "codigoOperacao": "500",
  "usarValoresTabelaPrecos": false,
  "desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "codigoCaixa": 1,
  "tabelaPreco": null,
  "considerarTabelaTransferenciaAutomatica": null,
  "data": "2025-04-09 14:10:05",
  "produtos": [
    {
      "codigo": "1",
      "quantidade": 12,
      "precoUnitario": 58.25,
      "descontoUnitario": 0.0
    },
    {
      "codigo": "2",
      "quantidade": 21.6,
      "precoUnitario": 47.27,
      "descontoUnitario": 0.0
    }
  ],
  "recebimentos": [
    {
      "valor": 1720.03,
      "codigoContabancaria": 1,
      "tipo": "CB",
      "tipoDocumento": "T"
    }
  ],
  "dadosEntrega": {
    "valor": 0,
    "opcoesFretePagoPor": "D",
    "pesoBruto": 1.2,
    "pesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "cnpjTransportadora": "",
    "codigoTransportadora": null,
    "naoSomarFreteTotalNota": true,
    "outroEndereco": {
      "cep": "29700020",
      "endereco": "Avenida João Zouain",
      "numero": "283",
      "complemento": null,
      "bairro": "Centro",
      "cidade": "Colatina",
      "uf": "ES"
    },
    "volumes": [
      {
        "quantidade": 3,
        "especie": "Pallets",
        "marca": "Beau",
        "numeracao": "SN871",
        "pesoLiquido": 10.0,
        "pesoBruto": 13.0,
        "lacres": [
          {
            "numero": "Lacre1"
          }
        ]
      },
      {
        "quantidade": 8,
        "especie": "Caixa",
        "marca": "Cents",
        "numeracao": "9969",
        "pesoLiquido": 16.0,
        "pesoBruto": 20.0,
        "lacres": [
          {
            "numero": "Lacre2"
          }
        ]
      }
    ],
    "opcoesFreteTipoEndereco": "O"
  }
}

Variações do corpo da requisição

Com estoque de outra filial, por pedido
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoFilialEstoque": 2,
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "18506",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0
    },
    {
      "Codigo": "16668",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Com estoque de outra filial, por produto
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "18506",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "CodigoFilialEstoque": 2
    },
    {
      "Codigo": "16668",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "CodigoFilialEstoque": 2
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Grade
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1111",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "codigoCor": "V1",
      "codigoTamanho": "2"
    },
    {
      "Codigo": "1111",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "codigoCor": "V2",
      "codigoTamanho": "2"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Lote
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1111",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "lote": "AABBCC",
      "loteFabricacao": "2025-04-05",
      "loteValidade": "2025-05-05"
    },
    {
      "Codigo": "1111",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "lote": "DDEEFF",
      "loteFabricacao": "2025-04-05",
      "loteValidade": "2025-05-05"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Série
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "41",
      "Quantidade": 1,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "serie": "11AA"
    },
    {
      "Codigo": "41",
      "Quantidade": 1,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "serie": "22BB"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Edição
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1010101010100",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "codigoEdicao": 10
    },
    {
      "Codigo": "1010101010100",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "codigoEdicao": 20
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}

POST Gerar Saída (Síncrono)

{{server}}/saidas

Corpo da requisição (exemplo)

{
  "codigoCliente": "8599",
  "cpfCnpj": "20.434.348/0001-02",
  "codigoOperacao": "209",
  "usarValoresTabelaPrecos": false,
  "desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "codigoCaixa": 1,
  "tabelaPreco": null,
  "considerarTabelaTransferenciaAutomatica": null,
  "data": "2025-02-05 17:10:05",
  "produtos": [
    {
      "codigo": "18506",
      "quantidade": 12,
      "precoUnitario": 58.25,
      "descontoUnitario": 0.0
    },
    {
      "codigo": "16668",
      "quantidade": 21.6,
      "precoUnitario": 47.27,
      "descontoUnitario": 0.0
    }
  ],
  "recebimentos": [
    {
      "valor": 1720.03,
      "codigoAdministradora": 1,
      "nsu": "0",
      "codigoContabancaria": 50,
      "tipo": "B",
      "valorParcelas": 1720.03,
      "quantidadeParcelas": "1"
    }
  ],
  "dadosEntrega": {
    "valor": 0,
    "opcoesFretePagoPor": "D",
    "pesoBruto": 1.2,
    "pesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "cnpjTransportadora": "",
    "codigoTransportadora": null,
    "naoSomarFreteTotalNota": true,
    "outroEndereco": {
      "cep": "29700020",
      "endereco": "Avenida João Zouain",
      "numero": "283",
      "complemento": null,
      "bairro": "Centro",
      "cidade": "Colatina",
      "uf": "ES"
    },
    "volumes": [
      {
        "quantidade": 3,
        "especie": "Pallets",
        "marca": "Beau",
        "numeracao": "SN871",
        "pesoLiquido": 10.0,
        "pesoBruto": 13.0,
        "lacres": [
          {
            "numero": "Lacre1"
          }
        ]
      },
      {
        "quantidade": 8,
        "especie": "Caixa",
        "marca": "Cents",
        "numeracao": "9969",
        "pesoLiquido": 16.0,
        "pesoBruto": 20.0,
        "lacres": [
          {
            "numero": "Lacre2"
          }
        ]
      }
    ],
    "opcoesFreteTipoEndereco": "O"
  }
}

Variações do corpo da requisição

Com estoque de outra filial, por pedido
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoFilialEstoque": 2,
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "18506",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0
    },
    {
      "Codigo": "16668",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Com estoque de outra filial, por produto
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "18506",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "CodigoFilialEstoque": 2
    },
    {
      "Codigo": "16668",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "CodigoFilialEstoque": 2
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Grade
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1111",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "codigoCor": "V1",
      "codigoTamanho": "2"
    },
    {
      "Codigo": "1111",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "codigoCor": "V2",
      "codigoTamanho": "1"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Lote
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1111",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "lote": "AABBCC",
      "loteFabricacao": "2025-04-05",
      "loteValidade": "2025-05-05"
    },
    {
      "Codigo": "1111",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "lote": "DDEEFF",
      "loteFabricacao": "2025-04-05",
      "loteValidade": "2025-05-05"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Série
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "18506",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "serie": "11AA"
    },
    {
      "Codigo": "16668",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "serie": "22BB"
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}
Gerar Saída com Produtos do tipo Edição
{
  "CodigoCliente": "8599",
  "CpfCnpj": "20.434.348/0001-02",
  "CodigoOperacao": "209",
  "UsarValoresTabelaPrecos": false,
  "Desconto_Total_Geral": 0,
  "Custo_Adicional_Ecommerce": 0.0,
  "observacao": "Forma de envio: Entrega",
  "codigoVendedor_1": 0,
  "codigoVendedor_2": 0,
  "CodigoIndicadorPresencial": 0,
  "ReferenciaInterna": "",
  "CodigoCaixa": 1,
  "TabelaPreco": null,
  "ConsiderarTabelaTransferenciaAutomatica": null,
  "Data": "2025-02-05 17:10:05",
  "Produtos": [
    {
      "Codigo": "1010101010100",
      "Quantidade": 12,
      "PrecoUnitario": 58.25,
      "descontoUnitario": 0.0,
      "codigoEdicao": 10
    },
    {
      "Codigo": "1010101010100",
      "Quantidade": 21.6,
      "PrecoUnitario": 47.27,
      "descontoUnitario": 0.0,
      "codigoEdicao": 20
    }
  ],
  "Recebimentos": [
    {
      "valor": 1720.03,
      "CodigoAdministradora": 1,
      "Nsu": "0",
      "codigoContaBancaria": 50,
      "Tipo": "B",
      "ValorParcelas": 1720.03,
      "QuantidadeParcelas": "1"
    }
  ],
  "DadosEntrega": {
    "Valor": 0,
    "OpcoesFretePagoPor": "D",
    "PesoBruto": 1.2,
    "PesoLiquido": 1.2,
    "dataEnvio": "2025-02-05 17:10:05",
    "CnpjTransportadora": "",
    "CodigoTransportadora": null,
    "NaoSomarFreteTotalNota": true,
    "OutroEndereco": {
      "Cep": "29700020",
      "Endereco": "Avenida João Zouain",
      "Numero": "283",
      "Complemento": null,
      "Bairro": "Centro",
      "Cidade": "Colatina",
      "Uf": "ES"
    },
    "OpcoesFreteTipoEndereco": "O"
  }
}

PUT Conferencia

{{server}}/saidas/1/conferencia

Corpo da requisição (exemplo)

[
  {
    "ordemProdServ": 1,
    "quantidadeConferida": 1.0
  }
]

PATCH Efetivar financeiro saidas

{{server}}/saidas/19203/efetivarfinanceiro

PATCH Efetivar estoque saidas

{{server}}/saidas/19203/efetivarestoque

PATCH Ativar Inativar

{{server}}/saidas/19203/ativar

PATCH Editar Saida

{{server}}/saidas/20151/editar

Corpo da requisição (exemplo)

{
  "Observacao": "Pedido teste para exportação2.",
  "CodigoOrigemVenda": 1,
  "CamposCustomizaveis": [
    {
      "ordem": 1235,
      "valor": 10.0
    },
    {
      "ordem": 1238,
      "valor": true
    },
    {
      "ordem": 1236,
      "valor": "2244462"
    },
    {
      "ordem": 1237,
      "valor": "2025-03-01T00:00:00Z"
    },
    {
      "ordem": 1239,
      "valor": "Iten 32"
    }
  ],
  "DadosEntrega": {
    "Valor": 15.0,
    "PesoBruto": 2.5,
    "PesoLiquido": 2.2,
    "dataEnvio": "2026-02-05 17:10:05",
    "Volume": 1,
    "OpcoesFretePagoPor": "D",
    "DataEntrega": "2025-03-01T00:00:00Z",
    "NaoSomarFreteTotalNota": false,
    "OutroEndereco": {
      "Cep": "01010-000",
      "Endereco": "Rua Exemplo",
      "Numero": "123",
      "Complemento": "Apto 101",
      "Bairro": "Centro",
      "Cidade": "São Paulo",
      "Uf": "SP"
    },
    "volumes": [
      {
        "quantidade": 10,
        "especie": "Pallets",
        "marca": "Beau",
        "numeracao": "SN871",
        "pesoLiquido": 10.0,
        "pesoBruto": 13.0,
        "lacres": [
          {
            "numero": "Lacre1"
          }
        ]
      },
      {
        "quantidade": 8,
        "especie": "Caixa",
        "marca": "Cents",
        "numeracao": "9969",
        "pesoLiquido": 16.0,
        "pesoBruto": 20.0,
        "lacres": [
          {
            "numero": "Lacre2"
          }
        ]
      }
    ],
    "CnpjTransportadora": "00961333000187",
    "OpcoesFreteTipoEndereco": "E"
  }
}

PATCH Editar Item Saida

{{server}}/saidas/20460/editar/329230

Corpo da requisição (exemplo)

[
  {
    "quantidade": "2"
  }
]

Variações do corpo da requisição

Item Normal
[
  {
    "Quantidade": 4
  }
]
Item Série
[
  {
    "Quantidade": 1,
    "Serie": 124
  },
  {
    "Quantidade": 1,
    "Serie": 123
  }
]
Item Lote
[
  {
    "Lote": "15",
    "Quantidade": 2
  },
  {
    "Lote": "16",
    "Quantidade": 3
  }
]
Item Grade
[
  {
    "Quantidade": 2
  }
]

PATCH Enviar NF-e

{{server}}/saidas/19205/enviarnota/nfe

PATCH Enviar NFC-e

{{server}}/saidas/19221/enviarnota/nfce

Parâmetros de query

ParâmetroExemplo
enviaCPFfalse

Devoluções

GET Devoluções Paginado

{{server}}/devolucao/1

Parâmetros de query

ParâmetroExemplo
tipodataA
datade2025-04-01 00:00:00
dataate2025-04-30 23:59:59

GET Devolução Detalhes

{{server}}/devolucao/detalhes/1

Entradas

GET Entradas Paginado

{{server}}/entradas/1

Parâmetros de query

ParâmetroExemplo
tipodataE
datade2025-04-01 00:00:00
dataate2025-04-30 23:59:59
tiposoperacaoCOM

GET Entrada Detalhado

{{server}}/entradas/detalhes/3

POST Gerar Entrada

{{server}}/entradas/

Corpo da requisição (exemplo)

{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "100",
      "quantidade": 2,
      "lote": "1",
      "loteValidade": "",
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5
    }
  ],
  "pagamentos": [
    {
      "valor": 259.04,
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "tipoDocumento": "Z"
    }
  ]
}

Variações do corpo da requisição

Com estoque de outra filial, por pedido
{
  "codigoCliFor": 2,
  "codigoFilialEstoque": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "1",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Com estoque de outra filial, por produto
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "1",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "codigoFilialEstoque": 2
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Gerar Entrada com Produtos do tipo Grade
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "1111",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "codigoCor": "A1",
      "codigoTamanho": "1"
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Gerar Entrada com Produtos do tipo Lote
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "5555",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "lote": "Lote",
      "loteFabricacao": "2025-04-29T00:00:00",
      "loteValidade": "2025-04-29T00:00:00"
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Gerar Entrada com Produtos do tipo Série
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "41",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "serie": "11AA"
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Gerar Entrada com Produtos do tipo Edição
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "1010101010100",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "codigoEdicao": 10
    }
  ],
  "pagamentos": [
    {
      "valorParcelas": 259.04,
      "vencimento": "2025-03-10T00:00:00",
      "quantidadeParcelas": 2,
      "tipo": "P"
    }
  ],
  "dadosFrete": {
    "valor": 30.0,
    "opcoesFretePagoPor": "D",
    "opcoesFreteTipoRecebimento": "S",
    "pesoBruto": 5.5,
    "pesoLiquido": 5.0,
    "dataEntrega": "2025-03-01T00:00:00",
    "descricao": "Conta frete",
    "cnpjTransportadora": "00961333000187",
    "pagamentos": [
      {
        "valorParcelas": 30.0,
        "vencimento": "2025-03-10T00:00:00",
        "quantidadeParcelas": 1
      }
    ]
  }
}
Gerar Entrada com XML
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 11,
  "codigoCaixa": 1,
  "data": "2025-10-02T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "produtos": [
    {
      "codigo": "1",
      "quantidade": 1,
      "precoUnitario": 15.0
    },
    {
      "codigo": "121",
      "quantidade": 1,
      "precoUnitario": 300.0
    }
  ],
  "documentosFiscais": [
    {
      "xmlDoc": "<?xml version=\"1.0\"?><nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infNFe versao=\"4.00\" Id=\"NFe41250900961333000187550080000110801294403426\"><ide><cUF>41</cUF><cNF>29440342</cNF><natOp>Venda Estadual</natOp><mod>55</mod><serie>8</serie><nNF>11080</nNF><dhEmi>2025-09-17T15:45:29-03:00</dhEmi><dhSaiEnt>2025-09-17T15:45:29-03:00</dhSaiEnt><tpNF>1</tpNF><idDest>1</idDest><cMunFG>4106902</cMunFG><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>6</cDV><tpAmb>1</tpAmb><finNFe>1</finNFe><indFinal>1</indFinal><indPres>0</indPres><procEmi>0</procEmi><verProc>9.7.30.0</verProc></ide><emit><CNPJ>00961333000187</CNPJ><xNome>T R VAREJO LTDA</xNome><xFant>T R VAREJO LTDA JARDIM SOCIAL teste</xFant><enderEmit><xLgr>Rua Prof Brandao</xLgr><nro>281</nro><xBairro>Alto da Rua XV</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>80045135</CEP><cPais>1058</cPais><xPais>Brasil</xPais><fone>4133333333</fone></enderEmit><IE>1000948787</IE><CRT>1</CRT></emit><dest><CNPJ>91636917000132</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderDest><xLgr>Rua Benedito Franca1</xLgr><nro>1</nro><xCpl>11</xCpl><xBairro>Capao da Imbuia</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>82810540</CEP><cPais>1058</cPais><xPais>BRASIL</xPais><fone>4130131161</fone></enderDest><indIEDest>2</indIEDest></dest><entrega><CNPJ>91636917000132</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><xLgr>Rua Benedito Franca1</xLgr><nro>1</nro><xCpl>11</xCpl><xBairro>Capao da Imbuia</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>82810540</CEP><fone>4130131161</fone></entrega><autXML><CNPJ>78552551000155</CNPJ></autXML><det nItem=\"1\"><prod><cProd>1</cProd><cEAN>7898715917309</cEAN><xProd>TV Samsung 60 pola</xProd><NCM>23091000</NCM><CEST>1710700</CEST><indEscala>S</indEscala><CFOP>5102</CFOP><uCom>T3</uCom><qCom>1.0000</qCom><vUnCom>15.0000000000</vUnCom><vProd>15.00</vProd><cEANTrib>7898715917309</cEANTrib><uTrib>KG</uTrib><qTrib>3.0000</qTrib><vUnTrib>5.0000000000</vUnTrib><indTot>1</indTot></prod><imposto><vTotTrib>5.45</vTotTrib><ICMS><ICMSSN900><orig>0</orig><CSOSN>900</CSOSN><modBC>3</modBC><vBC>15.00</vBC><pICMS>10.00</pICMS><vICMS>1.50</vICMS><modBCST>0</modBCST><vBCST>0.00</vBCST><pICMSST>0.00</pICMSST><vICMSST>0.00</vICMSST><pCredSN>0.00</pCredSN><vCredICMSSN>0.00</vCredICMSSN></ICMSSN900></ICMS><PIS><PISOutr><CST>99</CST><vBC>15.00</vBC><pPIS>5.00</pPIS><vPIS>0.75</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>15.00</vBC><pCOFINS>5.00</pCOFINS><vCOFINS>0.75</vCOFINS></COFINSOutr></COFINS><IBSCBS><CST>200</CST><cClassTrib>200022</cClassTrib><gIBSCBS><vBC>13.50</vBC><gIBSUF><pIBSUF>0.1000</pIBSUF><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vIBSUF>0.00</vIBSUF></gIBSUF><gIBSMun><pIBSMun>2.5000</pIBSMun><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vIBSMun>0.00</vIBSMun></gIBSMun><vIBS>0.00</vIBS><gCBS><pCBS>0.9000</pCBS><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vCBS>0.00</vCBS></gCBS><gTribRegular><CSTReg>200</CSTReg><cClassTribReg>200022</cClassTribReg><pAliqEfetRegIBSUF>1.1199</pAliqEfetRegIBSUF><vTribRegIBSUF>2.22</vTribRegIBSUF><pAliqEfetRegIBSMun>3.3399</pAliqEfetRegIBSMun><vTribRegIBSMun>4.44</vTribRegIBSMun><pAliqEfetRegCBS>5.4499</pAliqEfetRegCBS><vTribRegCBS>6.66</vTribRegCBS></gTribRegular></gIBSCBS></IBSCBS></imposto><infAdProd>Fonte da Carga Tributaria: IBPT / Unidade Tributavel: KG</infAdProd></det><det nItem=\"2\"><prod><cProd>2</cProd><cEAN>12312313</cEAN><xProd>Samsung Galaxy S24 5G 256GB</xProd><NCM>85176262</NCM><CEST>1710700</CEST><CFOP>5910</CFOP><uCom>Mt</uCom><qCom>1.0000</qCom><vUnCom>300.0000000000</vUnCom><vProd>300.00</vProd><cEANTrib>12312313</cEANTrib><uTrib>UN</uTrib><qTrib>1.0000</qTrib><vUnTrib>300.0000000000</vUnTrib><indTot>1</indTot></prod><imposto><vTotTrib>94.74</vTotTrib><ICMS><ICMSSN900><orig>4</orig><CSOSN>900</CSOSN><modBC>3</modBC><vBC>300.00</vBC><pICMS>0.00</pICMS><vICMS>0.00</vICMS><modBCST>2</modBCST><vBCST>300.00</vBCST><pICMSST>0.00</pICMSST><vICMSST>0.00</vICMSST><pCredSN>0.00</pCredSN><vCredICMSSN>0.00</vCredICMSSN></ICMSSN900></ICMS><PIS><PISOutr><CST>99</CST><vBC>300.00</vBC><pPIS>0.00</pPIS><vPIS>0.00</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>300.00</vBC><pCOFINS>0.00</pCOFINS><vCOFINS>0.00</vCOFINS></COFINSOutr></COFINS><IBSCBS><CST>000</CST><cClassTrib>000001</cClassTrib><gIBSCBS><vBC>300.00</vBC><gIBSUF><pIBSUF>0.1000</pIBSUF><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><vIBSUF>0.30</vIBSUF></gIBSUF><gIBSMun><pIBSMun>2.5000</pIBSMun><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><vIBSMun>7.50</vIBSMun></gIBSMun><vIBS>7.80</vIBS><gCBS><pCBS>0.9000</pCBS><vCBS>2.70</vCBS></gCBS></gIBSCBS></IBSCBS></imposto><infAdProd>Fonte da Carga Tributaria: IBPT / Unidade Tributavel: UN</infAdProd></det><total><ICMSTot><vBC>315.00</vBC><vICMS>1.50</vICMS><vICMSDeson>0.00</vICMSDeson><vFCP>0.00</vFCP><vBCST>300.00</vBCST><vST>0.00</vST><vFCPST>0.00</vFCPST><vFCPSTRet>0.00</vFCPSTRet><vProd>315.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vIPIDevol>0.00</vIPIDevol><vPIS>0.75</vPIS><vCOFINS>0.75</vCOFINS><vOutro>0.00</vOutro><vNF>315.00</vNF><vTotTrib>100.19</vTotTrib></ICMSTot><IBSCBSTot><vBCIBSCBS>313.50</vBCIBSCBS><gIBS><gIBSUF><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vIBSUF>0.30</vIBSUF></gIBSUF><gIBSMun><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vIBSMun>7.50</vIBSMun></gIBSMun><vIBS>7.80</vIBS><vCredPres>0.00</vCredPres><vCredPresCondSus>0.00</vCredPresCondSus></gIBS><gCBS><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vCBS>2.70</vCBS><vCredPres>0.00</vCredPres><vCredPresCondSus>0.00</vCredPresCondSus></gCBS></IBSCBSTot></total><transp><modFrete>9</modFrete><vol><pesoL>16.000</pesoL><pesoB>27.000</pesoB></vol></transp><pag><detPag><tPag>90</tPag><vPag>0.00</vPag></detPag></pag><infAdic><infAdFisco>Valor CBS 2,70Base CBS/IBS 313,50Valor IBS Est 0,30Valor IBS Mun 7,50</infAdFisco><infCpl>Valor CBS 2,70^Base CBS/IBS 313,50^Valor IBS Est 0,30^Valor IBS Mun 7,50^^V CARGA F 43,49^V CARGA E 56,70^V CARGA M 0,00^</infCpl></infAdic><infRespTec><CNPJ>00961333000187</CNPJ><xContato>Gustavo Guastini Trunci</xContato><email>idealsoft@idealsoft.com.br</email><fone>4130131161</fone></infRespTec></infNFe><Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\"><SignedInfo><CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/><SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"/><Reference URI=\"#NFe41250900961333000187550080000110801294403426\"><Transforms><Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/><Transform Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/></Transforms><DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>nm0Q02ZdNSFj4vboHuiizK/Y4Ww=</DigestValue></Reference></SignedInfo><SignatureValue>x76YGDyeB5TouBB9sdV8wxOeHvH13vV9OP/Ji6D5bxHYi71mYjp4K/cGezz+cEPG9qikZtmu8XaMYAPDlmHmvhhWll7glES1Uio5lF/jSd96PVnttkBpJaBnbraVVABQADtlXc+wdu7vICRIdtg1sv2mqfRgO9xcs2R3Jzxs718uNwHaaf6oIAcqGk9BdQtD4lZoGiTpNHDoFCP/0KJM9kXBpzSTi9Hp8L8/mgulnr0Q1Z1e2auT2Q+QkmoIqD0E4hBPt83J0xsDkFhwHM5E0CDSpn+H2dLcKLvmdPYT/G1teQop/4c9DFFAQAf+PBoFVrwIeh9XugyvQAb5aFrvCg==</SignatureValue><KeyInfo><X509Data><X509Certificate>MIIHQTCCBSmgAwIBAgIIJz8kEAg7LZIwDQYJKoZIhvcNAQELBQAwWTELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxFTATBgNVBAsTDEFDIFNPTFVUSSB2NTEeMBwGA1UEAxMVQUMgU09MVVRJIE11bHRpcGxhIHY1MB4XDTI0MTAwOTE3MTgwMFoXDTI1MTAwOTE3MTgwMFowgeAxCzAJBgNVBAYTAkJSMRMwEQYDVQQKEwpJQ1AtQnJhc2lsMQswCQYDVQQIEwJQUjERMA8GA1UEBxMIQ3VyaXRpYmExHjAcBgNVBAsTFUFDIFNPTFVUSSBNdWx0aXBsYSB2NTEXMBUGA1UECxMOMTMzNDk0NjYwMDAxNDkxGTAXBgNVBAsTEFZpZGVvY29uZmVyZW5jaWExGjAYBgNVBAsTEUNlcnRpZmljYWRvIFBKIEExMSwwKgYDVQQDDCNUUlVOQ0kgJiBUUlVOQ0kgTFREQTowMDk2MTMzMzAwMDE4NzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANNWM3hH5po0yTN9zZkqc7h+qnBt81nGtJzPTHQKqa6CN0luhkaxCleRdU5m4B3dhJ3qkRHNl1fELk6N+D4kL/3pfjRCnEGzd8ZF7koWT2bqKJ/PRMU7BZAZUTDOxB3xGQWNqk1Az1buPtgHhUE2daY2OMuI4T+ac5yLDV/VOWJwk7238xyB10sMKMyFY32u0nezjlZnAbkxJmxWBD6sL+/AZ0swt5I/z/fokte82YdoVthQla5e5WbXp0tFL02f3jhopvkTw2DXMmMF89kyzpoGWXZ5kvbs6rBOVv+Ykmy3SQf9Pr1BvTxkysv364gbt7KY4ESiJQz0rWuZtCkuPW8CAwEAAaOCAoMwggJ/MAkGA1UdEwQCMAAwHwYDVR0jBBgwFoAUxVLtJYAJ35yCyJ9Hxt20XzHdubEwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vY2NkLmFjc29sdXRpLmNvbS5ici9sY3IvYWMtc29sdXRpLW11bHRpcGxhLXY1LnA3YjCBvgYDVR0RBIG2MIGzgR9hZG1pbmlzdHJhdGl2b0BpZGVhbHNvZnQuY29tLmJyoCIGBWBMAQMCoBkTF0dVU1RBVk8gR1VBU1RJTkkgVFJVTkNJoBkGBWBMAQMDoBATDjAwOTYxMzMzMDAwMTg3oDgGBWBMAQMEoC8TLTE0MTExOTcwODU4NjAwMzQ5MjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMKAXBgVgTAEDB6AOEwwwMDAwMDAwMDAwMDAwXQYDVR0gBFYwVDBSBgZgTAECASYwSDBGBggrBgEFBQcCARY6aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvZG9jcy9kcGMtYWMtc29sdXRpLW11bHRpcGxhLnBkZjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYwGA1UdHwSBhDCBgTA+oDygOoY4aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvbGNyL2FjLXNvbHV0aS1tdWx0aXBsYS12NS5jcmwwP6A9oDuGOWh0dHA6Ly9jY2QyLmFjc29sdXRpLmNvbS5ici9sY3IvYWMtc29sdXRpLW11bHRpcGxhLXY1LmNybDAdBgNVHQ4EFgQUocdiNkdb6cjK8Q/BpPscUEDS3wIwDgYDVR0PAQH/BAQDAgXgMA0GCSqGSIb3DQEBCwUAA4ICAQCdAlCH5xo7aCPQffR8ve5aVGF4MFlTgR5r3fYgveji0V2vE5pRj+00MEyQKZkzgBjzrBmiSDlu3pVSU5c4Pcm9rRWGTRB+3nUfa9PdeS7wI1I8OXEYgPZotbn8A6oVb06AgHeMu5LByL2ukAU1KqCMkAGGSyz8aGRaE/XRZuf/XHQKmVFLG5AbnVgeXPOJUeycVvAg3trg+x1BaZTgo7bzbOozizNKGxghT/zvtoaT2kCWSbo1y/VRplgcm13CekOE/4wqWup0Ct/gi2Z5jZjFKepnVVp9l86JcGcOxaS/xubUIcRyOUcADa5kT9u265nuY2vDr7WbGQBwKTp3bIZA70fqziFKTlqNmfODBrfFXNbT43lIuJ/Q8MxKKry5ODNAvWvcQLj4d0pA/iUHAn5q35oOdxxeGxXa6m0Eu/IV9NNfHCM6DwSFTY8VcxjnQxHXe9vxVHTd3pwQOY81nQ2X8d752oiUlnOkpv9bGaoqtHiypIbSBHlPbcal6/PMQnfbIxfLDzffapmluiMJOoxXpP4N06M/OPdJUhe+A1+bfUBQNX6zli1q1WhkR7N9LarUf6XjUlNwc8hvBgIH1VxAikkVKJKyiXmLkOETNo7ZFopgbhXWXt5bZPxkWlbFqyQW/XdJApUM4/79zN+LvVupfUVeWTrAXOB4CwIqVJOayQ==</X509Certificate></X509Data></KeyInfo></Signature></NFe><protNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"><infProt Id=\"ID141250000561340\"><tpAmb>2</tpAmb><verAplic>PR-v4_9_25</verAplic><chNFe>41250900961333000187550080000110801294403426</chNFe><dhRecbto>2025-09-17T15:45:31-03:00</dhRecbto><nProt>141250000561340</nProt><digVal>nm0Q02ZdNSFj4vboHuiizK/Y4Ww=</digVal><cStat>100</cStat><xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></nfeProc>"
    }
  ],
  "pagamentos": [
    {
      "valor": 315.0,
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "tipoDocumento": "C"
    }
  ]
}
Gerar Entrada com XML e Recebimento
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 11,
  "codigoCaixa": 1,
  "data": "2025-10-02T08:30:00",
  "dataRecebimento": "2025-10-09T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "produtos": [
    {
      "codigo": "1",
      "quantidade": 1,
      "precoUnitario": 15.0
    },
    {
      "codigo": "121",
      "quantidade": 1,
      "precoUnitario": 300.0
    }
  ],
  "documentosFiscais": [
    {
      "xmlDoc": "<?xml version=\"1.0\"?><nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infNFe versao=\"4.00\" Id=\"NFe41250900961333000187550080000110801294403426\"><ide><cUF>41</cUF><cNF>29440342</cNF><natOp>Venda Estadual</natOp><mod>55</mod><serie>8</serie><nNF>11080</nNF><dhEmi>2025-09-17T15:45:29-03:00</dhEmi><dhSaiEnt>2025-09-17T15:45:29-03:00</dhSaiEnt><tpNF>1</tpNF><idDest>1</idDest><cMunFG>4106902</cMunFG><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>6</cDV><tpAmb>1</tpAmb><finNFe>1</finNFe><indFinal>1</indFinal><indPres>0</indPres><procEmi>0</procEmi><verProc>9.7.30.0</verProc></ide><emit><CNPJ>00961333000187</CNPJ><xNome>T R VAREJO LTDA</xNome><xFant>T R VAREJO LTDA JARDIM SOCIAL teste</xFant><enderEmit><xLgr>Rua Prof Brandao</xLgr><nro>281</nro><xBairro>Alto da Rua XV</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>80045135</CEP><cPais>1058</cPais><xPais>Brasil</xPais><fone>4133333333</fone></enderEmit><IE>1000948787</IE><CRT>1</CRT></emit><dest><CNPJ>91636917000132</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderDest><xLgr>Rua Benedito Franca1</xLgr><nro>1</nro><xCpl>11</xCpl><xBairro>Capao da Imbuia</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>82810540</CEP><cPais>1058</cPais><xPais>BRASIL</xPais><fone>4130131161</fone></enderDest><indIEDest>2</indIEDest></dest><entrega><CNPJ>91636917000132</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><xLgr>Rua Benedito Franca1</xLgr><nro>1</nro><xCpl>11</xCpl><xBairro>Capao da Imbuia</xBairro><cMun>4106902</cMun><xMun>Curitiba</xMun><UF>PR</UF><CEP>82810540</CEP><fone>4130131161</fone></entrega><autXML><CNPJ>78552551000155</CNPJ></autXML><det nItem=\"1\"><prod><cProd>1</cProd><cEAN>7898715917309</cEAN><xProd>TV Samsung 60 pola</xProd><NCM>23091000</NCM><CEST>1710700</CEST><indEscala>S</indEscala><CFOP>5102</CFOP><uCom>T3</uCom><qCom>1.0000</qCom><vUnCom>15.0000000000</vUnCom><vProd>15.00</vProd><cEANTrib>7898715917309</cEANTrib><uTrib>KG</uTrib><qTrib>3.0000</qTrib><vUnTrib>5.0000000000</vUnTrib><indTot>1</indTot></prod><imposto><vTotTrib>5.45</vTotTrib><ICMS><ICMSSN900><orig>0</orig><CSOSN>900</CSOSN><modBC>3</modBC><vBC>15.00</vBC><pICMS>10.00</pICMS><vICMS>1.50</vICMS><modBCST>0</modBCST><vBCST>0.00</vBCST><pICMSST>0.00</pICMSST><vICMSST>0.00</vICMSST><pCredSN>0.00</pCredSN><vCredICMSSN>0.00</vCredICMSSN></ICMSSN900></ICMS><PIS><PISOutr><CST>99</CST><vBC>15.00</vBC><pPIS>5.00</pPIS><vPIS>0.75</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>15.00</vBC><pCOFINS>5.00</pCOFINS><vCOFINS>0.75</vCOFINS></COFINSOutr></COFINS><IBSCBS><CST>200</CST><cClassTrib>200022</cClassTrib><gIBSCBS><vBC>13.50</vBC><gIBSUF><pIBSUF>0.1000</pIBSUF><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vIBSUF>0.00</vIBSUF></gIBSUF><gIBSMun><pIBSMun>2.5000</pIBSMun><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vIBSMun>0.00</vIBSMun></gIBSMun><vIBS>0.00</vIBS><gCBS><pCBS>0.9000</pCBS><gRed><pRedAliq>100.0000</pRedAliq><pAliqEfet>0.0000</pAliqEfet></gRed><vCBS>0.00</vCBS></gCBS><gTribRegular><CSTReg>200</CSTReg><cClassTribReg>200022</cClassTribReg><pAliqEfetRegIBSUF>1.1199</pAliqEfetRegIBSUF><vTribRegIBSUF>2.22</vTribRegIBSUF><pAliqEfetRegIBSMun>3.3399</pAliqEfetRegIBSMun><vTribRegIBSMun>4.44</vTribRegIBSMun><pAliqEfetRegCBS>5.4499</pAliqEfetRegCBS><vTribRegCBS>6.66</vTribRegCBS></gTribRegular></gIBSCBS></IBSCBS></imposto><infAdProd>Fonte da Carga Tributaria: IBPT / Unidade Tributavel: KG</infAdProd></det><det nItem=\"2\"><prod><cProd>2</cProd><cEAN>12312313</cEAN><xProd>Samsung Galaxy S24 5G 256GB</xProd><NCM>85176262</NCM><CEST>1710700</CEST><CFOP>5910</CFOP><uCom>Mt</uCom><qCom>1.0000</qCom><vUnCom>300.0000000000</vUnCom><vProd>300.00</vProd><cEANTrib>12312313</cEANTrib><uTrib>UN</uTrib><qTrib>1.0000</qTrib><vUnTrib>300.0000000000</vUnTrib><indTot>1</indTot></prod><imposto><vTotTrib>94.74</vTotTrib><ICMS><ICMSSN900><orig>4</orig><CSOSN>900</CSOSN><modBC>3</modBC><vBC>300.00</vBC><pICMS>0.00</pICMS><vICMS>0.00</vICMS><modBCST>2</modBCST><vBCST>300.00</vBCST><pICMSST>0.00</pICMSST><vICMSST>0.00</vICMSST><pCredSN>0.00</pCredSN><vCredICMSSN>0.00</vCredICMSSN></ICMSSN900></ICMS><PIS><PISOutr><CST>99</CST><vBC>300.00</vBC><pPIS>0.00</pPIS><vPIS>0.00</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>300.00</vBC><pCOFINS>0.00</pCOFINS><vCOFINS>0.00</vCOFINS></COFINSOutr></COFINS><IBSCBS><CST>000</CST><cClassTrib>000001</cClassTrib><gIBSCBS><vBC>300.00</vBC><gIBSUF><pIBSUF>0.1000</pIBSUF><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><vIBSUF>0.30</vIBSUF></gIBSUF><gIBSMun><pIBSMun>2.5000</pIBSMun><gDevTrib><vDevTrib>0.00</vDevTrib></gDevTrib><vIBSMun>7.50</vIBSMun></gIBSMun><vIBS>7.80</vIBS><gCBS><pCBS>0.9000</pCBS><vCBS>2.70</vCBS></gCBS></gIBSCBS></IBSCBS></imposto><infAdProd>Fonte da Carga Tributaria: IBPT / Unidade Tributavel: UN</infAdProd></det><total><ICMSTot><vBC>315.00</vBC><vICMS>1.50</vICMS><vICMSDeson>0.00</vICMSDeson><vFCP>0.00</vFCP><vBCST>300.00</vBCST><vST>0.00</vST><vFCPST>0.00</vFCPST><vFCPSTRet>0.00</vFCPSTRet><vProd>315.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vIPIDevol>0.00</vIPIDevol><vPIS>0.75</vPIS><vCOFINS>0.75</vCOFINS><vOutro>0.00</vOutro><vNF>315.00</vNF><vTotTrib>100.19</vTotTrib></ICMSTot><IBSCBSTot><vBCIBSCBS>313.50</vBCIBSCBS><gIBS><gIBSUF><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vIBSUF>0.30</vIBSUF></gIBSUF><gIBSMun><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vIBSMun>7.50</vIBSMun></gIBSMun><vIBS>7.80</vIBS><vCredPres>0.00</vCredPres><vCredPresCondSus>0.00</vCredPresCondSus></gIBS><gCBS><vDif>0.00</vDif><vDevTrib>0.00</vDevTrib><vCBS>2.70</vCBS><vCredPres>0.00</vCredPres><vCredPresCondSus>0.00</vCredPresCondSus></gCBS></IBSCBSTot></total><transp><modFrete>9</modFrete><vol><pesoL>16.000</pesoL><pesoB>27.000</pesoB></vol></transp><pag><detPag><tPag>90</tPag><vPag>0.00</vPag></detPag></pag><infAdic><infAdFisco>Valor CBS 2,70Base CBS/IBS 313,50Valor IBS Est 0,30Valor IBS Mun 7,50</infAdFisco><infCpl>Valor CBS 2,70^Base CBS/IBS 313,50^Valor IBS Est 0,30^Valor IBS Mun 7,50^^V CARGA F 43,49^V CARGA E 56,70^V CARGA M 0,00^</infCpl></infAdic><infRespTec><CNPJ>00961333000187</CNPJ><xContato>Gustavo Guastini Trunci</xContato><email>idealsoft@idealsoft.com.br</email><fone>4130131161</fone></infRespTec></infNFe><Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\"><SignedInfo><CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/><SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"/><Reference URI=\"#NFe41250900961333000187550080000110801294403426\"><Transforms><Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/><Transform Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/></Transforms><DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>nm0Q02ZdNSFj4vboHuiizK/Y4Ww=</DigestValue></Reference></SignedInfo><SignatureValue>x76YGDyeB5TouBB9sdV8wxOeHvH13vV9OP/Ji6D5bxHYi71mYjp4K/cGezz+cEPG9qikZtmu8XaMYAPDlmHmvhhWll7glES1Uio5lF/jSd96PVnttkBpJaBnbraVVABQADtlXc+wdu7vICRIdtg1sv2mqfRgO9xcs2R3Jzxs718uNwHaaf6oIAcqGk9BdQtD4lZoGiTpNHDoFCP/0KJM9kXBpzSTi9Hp8L8/mgulnr0Q1Z1e2auT2Q+QkmoIqD0E4hBPt83J0xsDkFhwHM5E0CDSpn+H2dLcKLvmdPYT/G1teQop/4c9DFFAQAf+PBoFVrwIeh9XugyvQAb5aFrvCg==</SignatureValue><KeyInfo><X509Data><X509Certificate>MIIHQTCCBSmgAwIBAgIIJz8kEAg7LZIwDQYJKoZIhvcNAQELBQAwWTELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxFTATBgNVBAsTDEFDIFNPTFVUSSB2NTEeMBwGA1UEAxMVQUMgU09MVVRJIE11bHRpcGxhIHY1MB4XDTI0MTAwOTE3MTgwMFoXDTI1MTAwOTE3MTgwMFowgeAxCzAJBgNVBAYTAkJSMRMwEQYDVQQKEwpJQ1AtQnJhc2lsMQswCQYDVQQIEwJQUjERMA8GA1UEBxMIQ3VyaXRpYmExHjAcBgNVBAsTFUFDIFNPTFVUSSBNdWx0aXBsYSB2NTEXMBUGA1UECxMOMTMzNDk0NjYwMDAxNDkxGTAXBgNVBAsTEFZpZGVvY29uZmVyZW5jaWExGjAYBgNVBAsTEUNlcnRpZmljYWRvIFBKIEExMSwwKgYDVQQDDCNUUlVOQ0kgJiBUUlVOQ0kgTFREQTowMDk2MTMzMzAwMDE4NzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANNWM3hH5po0yTN9zZkqc7h+qnBt81nGtJzPTHQKqa6CN0luhkaxCleRdU5m4B3dhJ3qkRHNl1fELk6N+D4kL/3pfjRCnEGzd8ZF7koWT2bqKJ/PRMU7BZAZUTDOxB3xGQWNqk1Az1buPtgHhUE2daY2OMuI4T+ac5yLDV/VOWJwk7238xyB10sMKMyFY32u0nezjlZnAbkxJmxWBD6sL+/AZ0swt5I/z/fokte82YdoVthQla5e5WbXp0tFL02f3jhopvkTw2DXMmMF89kyzpoGWXZ5kvbs6rBOVv+Ykmy3SQf9Pr1BvTxkysv364gbt7KY4ESiJQz0rWuZtCkuPW8CAwEAAaOCAoMwggJ/MAkGA1UdEwQCMAAwHwYDVR0jBBgwFoAUxVLtJYAJ35yCyJ9Hxt20XzHdubEwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vY2NkLmFjc29sdXRpLmNvbS5ici9sY3IvYWMtc29sdXRpLW11bHRpcGxhLXY1LnA3YjCBvgYDVR0RBIG2MIGzgR9hZG1pbmlzdHJhdGl2b0BpZGVhbHNvZnQuY29tLmJyoCIGBWBMAQMCoBkTF0dVU1RBVk8gR1VBU1RJTkkgVFJVTkNJoBkGBWBMAQMDoBATDjAwOTYxMzMzMDAwMTg3oDgGBWBMAQMEoC8TLTE0MTExOTcwODU4NjAwMzQ5MjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMKAXBgVgTAEDB6AOEwwwMDAwMDAwMDAwMDAwXQYDVR0gBFYwVDBSBgZgTAECASYwSDBGBggrBgEFBQcCARY6aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvZG9jcy9kcGMtYWMtc29sdXRpLW11bHRpcGxhLnBkZjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYwGA1UdHwSBhDCBgTA+oDygOoY4aHR0cDovL2NjZC5hY3NvbHV0aS5jb20uYnIvbGNyL2FjLXNvbHV0aS1tdWx0aXBsYS12NS5jcmwwP6A9oDuGOWh0dHA6Ly9jY2QyLmFjc29sdXRpLmNvbS5ici9sY3IvYWMtc29sdXRpLW11bHRpcGxhLXY1LmNybDAdBgNVHQ4EFgQUocdiNkdb6cjK8Q/BpPscUEDS3wIwDgYDVR0PAQH/BAQDAgXgMA0GCSqGSIb3DQEBCwUAA4ICAQCdAlCH5xo7aCPQffR8ve5aVGF4MFlTgR5r3fYgveji0V2vE5pRj+00MEyQKZkzgBjzrBmiSDlu3pVSU5c4Pcm9rRWGTRB+3nUfa9PdeS7wI1I8OXEYgPZotbn8A6oVb06AgHeMu5LByL2ukAU1KqCMkAGGSyz8aGRaE/XRZuf/XHQKmVFLG5AbnVgeXPOJUeycVvAg3trg+x1BaZTgo7bzbOozizNKGxghT/zvtoaT2kCWSbo1y/VRplgcm13CekOE/4wqWup0Ct/gi2Z5jZjFKepnVVp9l86JcGcOxaS/xubUIcRyOUcADa5kT9u265nuY2vDr7WbGQBwKTp3bIZA70fqziFKTlqNmfODBrfFXNbT43lIuJ/Q8MxKKry5ODNAvWvcQLj4d0pA/iUHAn5q35oOdxxeGxXa6m0Eu/IV9NNfHCM6DwSFTY8VcxjnQxHXe9vxVHTd3pwQOY81nQ2X8d752oiUlnOkpv9bGaoqtHiypIbSBHlPbcal6/PMQnfbIxfLDzffapmluiMJOoxXpP4N06M/OPdJUhe+A1+bfUBQNX6zli1q1WhkR7N9LarUf6XjUlNwc8hvBgIH1VxAikkVKJKyiXmLkOETNo7ZFopgbhXWXt5bZPxkWlbFqyQW/XdJApUM4/79zN+LvVupfUVeWTrAXOB4CwIqVJOayQ==</X509Certificate></X509Data></KeyInfo></Signature></NFe><protNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"><infProt Id=\"ID141250000561340\"><tpAmb>2</tpAmb><verAplic>PR-v4_9_25</verAplic><chNFe>41250900961333000187550080000110801294403426</chNFe><dhRecbto>2025-09-17T15:45:31-03:00</dhRecbto><nProt>141250000561340</nProt><digVal>nm0Q02ZdNSFj4vboHuiizK/Y4Ww=</digVal><cStat>100</cStat><xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></nfeProc>"
    }
  ],
  "pagamentos": [
    {
      "valor": 315.0,
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "tipoDocumento": "C"
    }
  ]
}
Gerar Entrada com Vendedores
{
  "codigoCliFor": 2,
  "cpfCnpj": "12345678000195",
  "codigoOperacao": 10,
  "codigoCaixa": 1,
  "data": "2025-02-27T08:30:00",
  "observacao": "Pedido gerado automaticamente",
  "descontoTotalGeral": 50.0,
  "produtos": [
    {
      "codigo": "100",
      "quantidade": 2,
      "precoUnitario": 150.75,
      "descontoUnitario": 10.5,
      "codigoVendedor1": 1,
      "codigoVendedor2": 2
    }
  ],
  "pagamentos": [
    {
      "valor": 259.04,
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "tipoDocumento": "Z"
    }
  ]
}

POST Bipagem

{{server}}/bipagem/

Corpo da requisição (exemplo)

{
  "OrdemMovimento": 1,
  "OrdemFuncionarioCriacao": 1,
  "ListaProdutosBipagem": [
    {
      "CodigoDigitado": "1",
      "Qtde": 1.0,
      "OrdemFuncionarioAlteracao": 1
    }
  ]
}

PATCH Efetivar estoque entrada

{{server}}/entradas/19178/efetivarestoque

PATCH Efetivar financeiro entrada

{{server}}/entradas/19185/efetivarfinanceiro

Ordem de Serviço

GET OS Paginado

{{server}}/ordemservico/1

Parâmetros de query

ParâmetroExemplo
tipodataA
datade2025-03-21
dataate2025-03-21

GET OS Detalhes Por Número

{{server}}/ordemservico/detalhes/133

GET OS Detalhes Por Ordem

{{server}}/ordemservico/detalhes/porordem/122

POST Gerar OS Sem Sinal

{{server}}/ordemservico

Corpo da requisição (exemplo)

{
  "codigoCliente": 1,
  "codigoProdServ": null,
  "nomeProdServ": "Novo Produto",
  "orcamentoContato": "",
  "orcamentoAprovadoPor": "",
  "orcamentoObs1": "",
  "orcamentoObs2": "",
  "tipoGeral": "Serviço",
  "detalhes": [
    "Detalhe 1",
    "Detalhe 2",
    "Detalhe 3",
    "Detalhe 4",
    "Detalhe 5",
    "Detalhe 6",
    "Detalhe 7",
    "Detalhe 8"
  ],
  "problemasRelatados": [
    "Problema Relatado 1",
    "Problema Relatado 2",
    "Problema Relatado 3",
    "Problema Relatado 4",
    "Problema Relatado 5",
    "Problema Relatado 6",
    "Problema Relatado 7",
    "Problema Relatado 8",
    "Problema Relatado 9",
    "Problema Relatado 10"
  ],
  "problemasEncontrados": [
    "Problema Encontrado 1",
    "Problema Encontrado 2",
    "Problema Encontrado 3",
    "Problema Encontrado 4",
    "Problema Encontrado 5",
    "Problema Encontrado 6",
    "Problema Encontrado 7",
    "Problema Encontrado 8",
    "Problema Encontrado 9",
    "Problema Encontrado 10"
  ],
  "servicosExecutados": [
    "Serviço Executado 1",
    "Serviço Executado 2",
    "Serviço Executado 3",
    "Serviço Executado 4",
    "Serviço Executado 5",
    "Serviço Executado 6",
    "Serviço Executado 7",
    "Serviço Executado 8",
    "Serviço Executado 9",
    "Serviço Executado 10"
  ],
  "orcamentoDataEntrega": null,
  "orcamentoClienteContactado": false,
  "orcamentoAprovado": false,
  "orcamentoValor": 0.0,
  "tipoOS": "Orçamento",
  "situacaoOS": "Em Análise",
  "orcamentoObs3": "",
  "orcamentoPrazoConclusao": null,
  "gerarCredito": null,
  "produtos": [
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": null,
      "codigoProdServ": "1",
      "precoUnitario": 1.0,
      "descontoValor": 0.0,
      "quantidade": 1.0
    },
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": 2,
      "codigoProdServ": "1",
      "precoUnitario": 1.0,
      "descontoValor": 4.0,
      "quantidade": 1.0
    }
  ],
  "servicos": [
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 1.0,
      "quantidade": 1.0
    },
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 0.0,
      "quantidade": 2.0
    }
  ]
}

Variações do corpo da requisição

Gerar OS Com Identificador
{
  "codigoCliente": 1,
  "codigoProdServ": null,
  "nomeProdServ": "Novo Produto",
  "orcamentoContato": "",
  "orcamentoAprovadoPor": "",
  "orcamentoObs1": "",
  "orcamentoObs2": "",
  "tipoGeral": "Serviço",
  "detalhes": [
    "Detalhe 1",
    "Detalhe 2",
    "Detalhe 3",
    "Detalhe 4",
    "Detalhe 5",
    "Detalhe 6",
    "Detalhe 7",
    "Detalhe 8"
  ],
  "problemasRelatados": [
    "Problema Relatado 1",
    "Problema Relatado 2",
    "Problema Relatado 3",
    "Problema Relatado 4",
    "Problema Relatado 5",
    "Problema Relatado 6",
    "Problema Relatado 7",
    "Problema Relatado 8",
    "Problema Relatado 9",
    "Problema Relatado 10"
  ],
  "problemasEncontrados": [
    "Problema Encontrado 1",
    "Problema Encontrado 2",
    "Problema Encontrado 3",
    "Problema Encontrado 4",
    "Problema Encontrado 5",
    "Problema Encontrado 6",
    "Problema Encontrado 7",
    "Problema Encontrado 8",
    "Problema Encontrado 9",
    "Problema Encontrado 10"
  ],
  "servicosExecutados": [
    "Serviço Executado 1",
    "Serviço Executado 2",
    "Serviço Executado 3",
    "Serviço Executado 4",
    "Serviço Executado 5",
    "Serviço Executado 6",
    "Serviço Executado 7",
    "Serviço Executado 8",
    "Serviço Executado 9",
    "Serviço Executado 10"
  ],
  "orcamentoDataEntrega": null,
  "orcamentoClienteContactado": false,
  "orcamentoAprovado": false,
  "orcamentoValor": 0.0,
  "tipoOS": "Orçamento",
  "situacaoOS": "Em Análise",
  "orcamentoObs3": "",
  "orcamentoPrazoConclusao": null,
  "gerarCredito": null,
  "produtos": [
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": null,
      "codigoProdServ": "1",
      "precoUnitario": 1.0,
      "descontoValor": 0.0,
      "quantidade": 1.0
    },
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": 2,
      "codigoProdServ": "1",
      "precoUnitario": 1.0,
      "descontoValor": 4.0,
      "quantidade": 1.0
    }
  ],
  "servicos": [
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 1.0,
      "quantidade": 1.0
    },
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 0.0,
      "quantidade": 2.0
    }
  ]
}

POST Gerar OS Com Sinal

{{server}}/ordemservico

Corpo da requisição (exemplo)

{
  "codigoCliente": 1,
  "codigoProdServ": null,
  "nomeProdServ": "Novo Produto",
  "orcamentoContato": "",
  "orcamentoAprovadoPor": "",
  "orcamentoObs1": "",
  "orcamentoObs2": "",
  "tipoGeral": "Serviço",
  "detalhes": [
    "Detalhe 1",
    "Detalhe 2",
    "Detalhe 3",
    "Detalhe 4",
    "Detalhe 5",
    "Detalhe 6",
    "Detalhe 7",
    "Detalhe 8"
  ],
  "problemasRelatados": [
    "Problema Relatado 1",
    "Problema Relatado 2",
    "Problema Relatado 3",
    "Problema Relatado 4",
    "Problema Relatado 5",
    "Problema Relatado 6",
    "Problema Relatado 7",
    "Problema Relatado 8",
    "Problema Relatado 9",
    "Problema Relatado 10"
  ],
  "problemasEncontrados": [
    "Problema Encontrado 1",
    "Problema Encontrado 2",
    "Problema Encontrado 3",
    "Problema Encontrado 4",
    "Problema Encontrado 5",
    "Problema Encontrado 6",
    "Problema Encontrado 7",
    "Problema Encontrado 8",
    "Problema Encontrado 9",
    "Problema Encontrado 10"
  ],
  "servicosExecutados": [
    "Serviço Executado 1",
    "Serviço Executado 2",
    "Serviço Executado 3",
    "Serviço Executado 4",
    "Serviço Executado 5",
    "Serviço Executado 6",
    "Serviço Executado 7",
    "Serviço Executado 8",
    "Serviço Executado 9",
    "Serviço Executado 10"
  ],
  "orcamentoDataEntrega": null,
  "orcamentoClienteContactado": false,
  "orcamentoAprovado": false,
  "orcamentoValor": 0.0,
  "tipoOS": "Orçamento",
  "situacaoOS": "Em Análise",
  "orcamentoObs3": "",
  "orcamentoPrazoConclusao": null,
  "gerarCredito": {
    "valor": 10,
    "codigoCaixa": 1,
    "descricao": "Teste sinal",
    "codigoPlanoContas": 10001,
    "recebimentos": [
      {
        "tipo": "D",
        "valor": 10
      }
    ]
  },
  "produtos": [
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": null,
      "codigoProdServ": "1",
      "precoUnitario": 10.0,
      "descontoValor": 0.0,
      "quantidade": 1.0
    },
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": 2,
      "codigoProdServ": "1",
      "precoUnitario": 400.0,
      "descontoValor": 4.0,
      "quantidade": 1.0
    }
  ],
  "servicos": [
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 1.0,
      "quantidade": 1.0
    },
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 200.0,
      "descontoValor": 0.0,
      "quantidade": 2.0
    }
  ]
}

Variações do corpo da requisição

Gerar OS Com Identificador
{
  "codigoCliente": 1,
  "codigoProdServ": null,
  "nomeProdServ": "Novo Produto",
  "orcamentoContato": "",
  "orcamentoAprovadoPor": "",
  "orcamentoObs1": "",
  "orcamentoObs2": "",
  "tipoGeral": "Serviço",
  "detalhes": [
    "Detalhe 1",
    "Detalhe 2",
    "Detalhe 3",
    "Detalhe 4",
    "Detalhe 5",
    "Detalhe 6",
    "Detalhe 7",
    "Detalhe 8"
  ],
  "problemasRelatados": [
    "Problema Relatado 1",
    "Problema Relatado 2",
    "Problema Relatado 3",
    "Problema Relatado 4",
    "Problema Relatado 5",
    "Problema Relatado 6",
    "Problema Relatado 7",
    "Problema Relatado 8",
    "Problema Relatado 9",
    "Problema Relatado 10"
  ],
  "problemasEncontrados": [
    "Problema Encontrado 1",
    "Problema Encontrado 2",
    "Problema Encontrado 3",
    "Problema Encontrado 4",
    "Problema Encontrado 5",
    "Problema Encontrado 6",
    "Problema Encontrado 7",
    "Problema Encontrado 8",
    "Problema Encontrado 9",
    "Problema Encontrado 10"
  ],
  "servicosExecutados": [
    "Serviço Executado 1",
    "Serviço Executado 2",
    "Serviço Executado 3",
    "Serviço Executado 4",
    "Serviço Executado 5",
    "Serviço Executado 6",
    "Serviço Executado 7",
    "Serviço Executado 8",
    "Serviço Executado 9",
    "Serviço Executado 10"
  ],
  "orcamentoDataEntrega": null,
  "orcamentoClienteContactado": false,
  "orcamentoAprovado": false,
  "orcamentoValor": 0.0,
  "tipoOS": "Orçamento",
  "situacaoOS": "Em Análise",
  "orcamentoObs3": "",
  "orcamentoPrazoConclusao": null,
  "gerarCredito": {
    "valor": 10,
    "codigoCaixa": 1,
    "descricao": "Teste sinal",
    "codigoPlanoContas": 10001,
    "recebimentos": [
      {
        "tipo": "D",
        "valor": 10
      }
    ]
  },
  "produtos": [
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": null,
      "codigoProdServ": "1",
      "precoUnitario": 10.0,
      "descontoValor": 0.0,
      "quantidade": 1.0
    },
    {
      "lote": "",
      "serie": "",
      "codigoVendedor1": 1,
      "codigoVendedor2": 2,
      "codigoProdServ": "1",
      "precoUnitario": 400.0,
      "descontoValor": 4.0,
      "quantidade": 1.0
    }
  ],
  "servicos": [
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 123.0,
      "descontoValor": 1.0,
      "quantidade": 1.0
    },
    {
      "codigoTecnico1": 1,
      "codigoTecnico2": null,
      "codigoProdServ": "4",
      "precoUnitario": 200.0,
      "descontoValor": 0.0,
      "quantidade": 2.0
    }
  ]
}

POST Adicionar Produtos OS Existente

{{server}}/ordemservico/133/produtos

Corpo da requisição (exemplo)

[
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": null,
    "codigoProdServ": "1",
    "precoUnitario": 10.0,
    "descontoValor": 0.0,
    "quantidade": 1.0
  },
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": 2,
    "codigoProdServ": "1",
    "precoUnitario": 400.0,
    "descontoValor": 4.0,
    "quantidade": 1.0
  }
]

Exemplos de resposta

Adicionar Produto Normal200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": "Produtos criados com sucesso"
}
Adicionar Produto Grade200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": "Produtos criados com sucesso"
}
Adicionar Produto Lote200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": "Produtos criados com sucesso"
}
Adicionar Produto Serie200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": "Produtos criados com sucesso"
}
Adicionar Produto Edição200 OK
{
  "sucesso": true,
  "mensagem": null,
  "tipo": null,
  "complementoTipo": null,
  "statusCode": 200,
  "dados": "Produtos criados com sucesso"
}

POST Adicionar Serviços OS Existente

{{server}}/ordemservico/133/servicos

Corpo da requisição (exemplo)

[
  {
    "codigoTecnico1": 1,
    "codigoTecnico2": null,
    "codigoProdServ": "4",
    "precoUnitario": 123.0,
    "descontoValor": 1.0,
    "quantidade": 1.0
  },
  {
    "codigoTecnico1": 1,
    "codigoTecnico2": null,
    "codigoProdServ": "4",
    "precoUnitario": 200.0,
    "descontoValor": 0.0,
    "quantidade": 2.0
  }
]

PUT Alterar OS

{{server}}/ordemservico/133

Corpo da requisição (exemplo)

{
  "codigoCliente": 1,
  "codigoProdServ": null,
  "nomeProdServ": "Novo Produto Alterado",
  "orcamentoContato": "",
  "orcamentoAprovadoPor": "",
  "orcamentoObs1": "",
  "orcamentoObs2": "",
  "tipoOS": "Orçamento",
  "situacaoOS": "Em Análise",
  "tipoGeral": "Serviço",
  "detalhes": [
    "Detalhe 1",
    "Detalhe 2",
    "Detalhe 3",
    "Detalhe 4",
    "Detalhe 5",
    "Detalhe 6",
    "Detalhe 7",
    "Detalhe 8"
  ],
  "problemasRelatados": [
    "Problema Relatado 1",
    "Problema Relatado 2",
    "Problema Relatado 3",
    "Problema Relatado 4",
    "Problema Relatado 5",
    "Problema Relatado 6",
    "Problema Relatado 7",
    "Problema Relatado 8",
    "Problema Relatado 9",
    "Problema Relatado 10"
  ],
  "problemasEncontrados": [
    "Problema Encontrado 1",
    "Problema Encontrado 2",
    "Problema Encontrado 3",
    "Problema Encontrado 4",
    "Problema Encontrado 5",
    "Problema Encontrado 6",
    "Problema Encontrado 7",
    "Problema Encontrado 8",
    "Problema Encontrado 9",
    "Problema Encontrado 10"
  ],
  "servicosExecutados": [
    "Serviço Executado 1",
    "Serviço Executado 2",
    "Serviço Executado 3",
    "Serviço Executado 4",
    "Serviço Executado 5",
    "Serviço Executado 6",
    "Serviço Executado 7",
    "Serviço Executado 8",
    "Serviço Executado 9",
    "Serviço Executado 10"
  ],
  "orcamentoDataEntrega": null,
  "orcamentoClienteContactado": false,
  "orcamentoAprovado": false,
  "orcamentoValor": 0.0,
  "orcamentoObs3": "",
  "orcamentoPrazoConclusao": null
}

PUT Efetivar Estoque OS

{{server}}/ordemservico/{{numOS}}/produtos/{{numLinha}}/efetivarestoque

PUT Desefetivar Estoque OS

{{server}}/ordemservico/{{numOS}}/produtos/{{numLinha}}/desefetivarestoque

PUT Marcar Serviço Concluido

{{server}}/ordemservico/{{numOS}}/servicos/{{numLinha}}/marcarcomoconcluido

PUT Desmarcar Serviço Concluido

{{server}}/ordemservico/{{numOS}}/servicos/{{numLinha}}/desmarcarcomoconcluido

DELETE Remover Produtos OS Existente

{{server}}/ordemservico/133/produtos/6

Corpo da requisição (exemplo)

[
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": null,
    "codigoProdServ": "1",
    "precoUnitario": 10.0,
    "descontoValor": 0.0,
    "quantidade": 1.0
  },
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": 2,
    "codigoProdServ": "1",
    "precoUnitario": 400.0,
    "descontoValor": 4.0,
    "quantidade": 1.0
  }
]

DELETE Remover Serviços OS Existente

{{server}}/ordemservico/133/servicos/7

Corpo da requisição (exemplo)

[
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": null,
    "codigoProdServ": "1",
    "precoUnitario": 10.0,
    "descontoValor": 0.0,
    "quantidade": 1.0
  },
  {
    "lote": "",
    "serie": "",
    "codigoVendedor1": 1,
    "codigoVendedor2": 2,
    "codigoProdServ": "1",
    "precoUnitario": 400.0,
    "descontoValor": 4.0,
    "quantidade": 1.0
  }
]

Documentos Fiscais

GET Documentos Inutilizados Paginado

{{server}}/documentosfiscais/inutilizados/1

Parâmetros de query

ParâmetroExemplo
modelo55
datade2015-01-01 00:00:00
dataate2025-12-31 23:59:59
tipodataE

Documentos

GET Documentos Paginado

{{server}}/documentos/1

Parâmetros de query

ParâmetroExemplo
codigoArea9999
tiposOutros
dataCadastroDe2026-01-01
dataCadastroAte2026-12-31
codigoCliente1

POST Documentos

{{server}}/documentos

Corpo da requisição (exemplo)

{
  "titulo": "Documento Ver",
  "nomeArquivo": "Verificações.png",
  "origem": "Origem",
  "codigoCliente": 1,
  "codigoArea": 9999,
  "destino": "Destino",
  "tipo": "Outros",
  "armazenarAte": "2026-12-31",
  "observacoes": "Observação do Documento",
  "recebido": true,
  "enviado": false,
  "apagarAutomaticamente": false,
  "conteudo": {
    "contentType": "image/png",
    "dados": "iVBORw0KGgoAAAANSUhEUgAAAMgAAABQCAYAAABcbTqwAAACcElEQVR4nO3cMUtqcRzG8cfb2W0Jmn0DUVsI6RANNbVbBEJD9B4cDRwbGtpqcQjOptTmFr6BlpbwBVRiNXl+d5Mb5ENwr9U9fj/TkcMj/+XLUQcLEREC8KFf330A4CcjEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMDITSBpmqparaparSpJksn11dXVp9/j5ORkhifE/6iQx//mXVxc1NPT05ftkF+5eYJM8/j4qFqtps3NTW1sbKjf70uSTk9Ptbq6qrW1Nd3c3KjRaGg0Gmlra2vqBnMocqhYLE6u6/V63N7eRkTEw8NDrKysRETE0tJSDIfDuLu7i729vXe7aRvMn+S7A5216+tr3d/fT16/vLxoPB5re3tb+/v7Ojo60sXFxac2CwsLX3Zu/BDfXegs/PkEWV5ejre3t4iIGI/H0ev1Jvd6vV7s7u7GwcHBu53bYL7k/jtIuVxWmqaSpG63q2azqefnZ1UqFa2vr+vy8lKdTkeSlGWZsiz7cIP5lPtfsQaDgQ4PD/X6+qokSXR+fq5SqaRWq6V2u60sy1Sv13V8fKydnR0VCgWdnZ19uMH8yWUgwL+S+49YwN8gEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMAgEMD4DWvCn9QGJAzPAAAAAElFTkSuQmCC"
  }
}

Financeiro

Crédito

GET Consulta Saldo Crédito Código

{{server}}/credito/cliente/saldo/6

GET Consulta Saldo Crédito Ordem

{{server}}/credito/cliente/saldo/porordem/8

GET Consulta Saldo Paginado Período

{{server}}/credito/cliente/saldos/1/

Parâmetros de query

ParâmetroExemplo
datade2025-01-01 00:00:00
dataAte2025-04-23 23:50:50

POST Gerar Crédito por Código

{{server}}/credito/cliente/1

Corpo da requisição (exemplo)

{
  "tipo": "Crédito",
  "data": "2025-04-11",
  "valor": 100.0,
  "codigoCaixa": 1,
  "descricao": "Teste sinal",
  "codigoPlanoContas": 10001,
  "recebimentos": [
    {
      "tipo": "D",
      "valor": 25
    },
    {
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "valor": 25
    },
    {
      "tipo": "R",
      "valor": 50,
      "vencimento": "2025-04-11",
      "quantidadeParcelas": 2
    }
  ]
}

Variações do corpo da requisição

Gerar Crédito por Código
{
  "tipo": "Crédito",
  "data": "2025-04-11",
  "valor": 100.0,
  "codigoCaixa": 1,
  "descricao": "Teste sinal",
  "codigoPlanoContas": 10001,
  "recebimentos": [
    {
      "tipo": "D",
      "valor": 25
    },
    {
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "valor": 25
    },
    {
      "tipo": "R",
      "valor": 50,
      "vencimento": "2025-04-11",
      "quantidadeParcelas": 2
    }
  ]
}
Gerar Débito por Código
{
  "tipo": "Débito",
  "data": "2025-04-11",
  "valor": 100.0,
  "descricao": "Teste sinal"
}

POST Gerar Crédito por Ordem

{{server}}/credito/cliente/porordem/1

Corpo da requisição (exemplo)

{
  "tipo": "Crédito",
  "data": "2025-04-11T00:00:00",
  "valor": 10.0,
  "codigoCaixa": 1,
  "descricao": "Teste sinal",
  "codigoPlanoContas": 10001,
  "recebimentos": [
    {
      "tipo": "D",
      "valor": 10
    }
  ]
}

Variações do corpo da requisição

Gerar Crédito por Ordem
{
  "tipo": "Crédito",
  "data": "2025-04-11T00:00:00",
  "valor": 10.0,
  "codigoCaixa": 1,
  "descricao": "Teste sinal",
  "codigoPlanoContas": 10001,
  "recebimentos": [
    {
      "tipo": "D",
      "valor": 10
    }
  ]
}
Gerar Débito por Ordem
{
  "tipo": "Débito",
  "data": "2025-04-11",
  "valor": 100.0,
  "descricao": "Teste sinal"
}

POST Gerar Estorno Crédito por Código

{{server}}/credito/cliente/estorno/6

Corpo da requisição (exemplo)

{
  "data": "2025-04-14",
  "valor": 100.0,
  "codigoCaixa": 1,
  "descricao": "Estorno",
  "codigoPlanoContas": 1,
  "pagamentos": [
    {
      "tipo": "D",
      "valor": 25
    },
    {
      "tipo": "CB",
      "codigoContaBancaria": 1,
      "valor": 25
    },
    {
      "tipo": "R",
      "valor": 50,
      "vencimento": "2025-04-14",
      "quantidadeParcelas": 2
    }
  ]
}

POST Gerar Estorno Crédito por Ordem

{{server}}/credito/cliente/estorno/porordem/6

Corpo da requisição (exemplo)

{
  "data": "2025-04-11T00:00:00",
  "valor": 10.0,
  "codigoCaixa": 1,
  "descricao": "Estorno",
  "codigoPlanoContas": 10001,
  "pagamentos": [
    {
      "tipo": "D",
      "valor": 10
    }
  ]
}

Motivos Descontos

GET Motivos Descontos

{{server}}/motivos_desconto

Parâmetros de query

ParâmetroExemplo
datade2026-01-01
dataate2026-05-06