| Estruturas de dados - Integração de Vendas |  |
|
Esta página mostras as estrutura de dados utilizadas pelo módulo de Integração de Vendas. Clique no nome da estrutura para ver a lista de campos que a constituem e uma breve descrição de cada um deles.
Os campos do tipo data no sistema são sempre representados como um número inteiro com 8 dígitos no formato AAAAMMDD,
onde AAAA é o ano (com século), MM é o número do mês (de 1 a 12) e DD é o dia.
TWRemStatus - Resultado de uma operação do módulo de Integração de Vendas.
| Code | int | Código de erro retornado pela operação. O valor 0 (zero) indica que a operação foi bem sucedida. |
| Msg | string | Mensagem retornada pela operação. Mesmo quando a operação é realizada com sucesso, este campo pode vir preenchido com informações adicionais. |
| Extra | string | Informações extras em formato JSON retornadas pela operação. Por exemplo, em operações que podem retornar vários registros, esse campo informará
se há mais registros para se buscar numa nova chamada. Nesse caso, é retornado o texto { "maisRegistros": 1 }. |
TWRemPageable - Configura a paginação em funções de busca.
| Pagina | int | Número da página de registros a ser buscada. A primeira página é a de número 0 (zero). |
| RegistrosPorPagina | int | Quantidade máxima de registros a serem retornados pela função de busca. Por padrão, são considerados 200 registros, sendo que o valor máximo permitido é de 300. |
TWRemFiltroBasico - Conjunto de filtros básicos para integrações usando o SDK.
| empresa | int | Código da empresa onde estão registradas as informações que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
TWRemFiltroPedidoVenda - Conjunto de filtros para operações envolvendo Pedidos de Venda no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão registradas as informações que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| pedidoDe | int | Número inicial do pedido de venda na faixa de pedidos sobre os quais se quer obter informações. |
| pedidoAte | int | Número final do pedido de venda na faixa de pedidos sobre os quais se quer obter informações. | dataPedidoDe | int | Data inicial dos pedidos de venda sobre os quais se quer obter informações. |
| dataPedidoAte | int | Data final dos pedidos de venda sobre os quais se quer obter informaçães. |
TWRemFiltroGrupo - Conjunto de filtros para operações envolvendo Grupos de Estoque no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão registradas as informações do grupo que se deseja recuperar. Se não for fornecido, apenas a empresa logada será considerada. |
| filial | int | Código da filial onde estão registradas as informações do grupo que se deseja recuperar. Se não for fornecido, apenas a filial logada será considerada. |
| grupoEstoque | int | Código do Grupo de Estoque sobre o qual se deseja recuperar as informações. |
TWRemFiltroProduto - Conjunto de filtros para operações envolvendo Itens de Estoque no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão registradas as informaçães de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| estab | short | Código do estabelecimento onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer informaçães do produto em todos os estabelecimentos onde ele estiver presente. |
| depos | short | Código do depósito onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer informações do produto em todos os depósitos onde ele estiver presente. |
| codigoProduto | string | Código do produto sobre o qual se deseja recuperar as informações. Se optar por fornecer o código do grupo de estoque, deixe este campo em branco. |
| grupoEstoque | int | Código do Grupo de Estoque dos produtos sobre os quais se deseja recuperar as informações. Será criada uma faixa de grupos, considerando os sub grupos que não tenham sido fornecidos. Por exemplo, se o grupo informado for 10250000, serão considerados os produtos na faixa entre 10250000 e 10259999. Lembrete: os grupos de estoque no ERP são compostos por 4 subgrupos de 2 dígitos cada um. Se optar por informar um código do produto, o grupo de estoque deve ser zero. |
TWRemFiltroCliente - Conjunto de filtros para operações envolvendo Clientes no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão registradas as informações que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| clienteDe | double | Código do cliente inicial em uma faixa de clientes que se deseja recuperar. |
| clienteAte | double | Código do cliente final em uma faixa de clientes que se deseja recuperar. |
| tipos | string | Lista dos tipos de clientes sobre os quais se deseja obter informaçães. Os valores básicos são C (Cliente comum), E (Exportador), O (Outros) e A (Associado), mas a lista pode ser extendida pela empresa usuária do ERP. Se precisar fornecer mais de um dos valores, apenas junte as letras. Por exemplo, fornecer o valor CA restringirá os resultados a clientes dos tipos comum e associados. Filtro não é obrigatório. |
| nome | string | Nome fantasia ou a razão social do cliente que se deseja consultar. Aceita % para busca parcial nos campos. Não é obrigatório. |
TWRemFiltroNFe - Conjunto de filtros para operações envolvendo Notas Fiscais Eletrônicas no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão registradas as informações que se deseja recuperar. |
| filial | int | Código da filial onde estão registradas as informações de que se deseja recuperar. |
| nroNotaDe | int | Número inicial da nota fiscal na faixa de notas sobre as quais se quer obter informações. |
| nroNotaAte | int | Número final da nota fiscal na faixa de notas sobre as quais se quer obter informações. | dataAutorizDe | int | Data inicial da faixa de datas de autorização das notas sobre as quais se quer obter informações. |
| dataAutorizAte | int | Data final da faixa de datas de autorização das notas sobre as quais se quer obter informações. |
| clienteFornec | double | Código do cliente ou do fornecedor cujas notas fiscais se quer obter as informações. |
| chaveAcesso | string | A chave de acesso de uma NFe em particular que se queira obter as informações. |
TWRemFiltroLista - Conjunto de filtros para operações envolvendo lista de preços de produtos no módulo de Integração de Vendas.
| empresa | int | Código da empresa onde estão as informações que se deseja recuperar. |
| filial | int | Código da filial onde estão as informações que se deseja recuperar. |
| estab | int | Código do estabelecimento do produto. |
| depos | int | Código do depósito onde se encontra o produto. |
| cProd | string | Código do produto para o qual se quer obter as informações. |
| nroLista | int | Código da lista de preço na qual se quer verificar o produto. |
| cnpjOuCpf | double | CNPJ ou CPF do cliente para obtenção da lista de preço específica. |
TWRemFiltroLocalNota - Conjunto de filtros para recuperação de locais de retirada de Notas Fiscais.
| empresa | int | Código da empresa onde estão registradas as informações que se deseja recuperar. |
| filial | int | Código da filial onde estão registradas as informações de que se deseja recuperar. | dataNota | int | Data de emissão das notas que devem ser obtidas. |
| tipoMovto | short[] | Lista com os possíveis tipos de movimento para que uma nota seja considerada pela função. |
| tipoPessoa | char | Indica se a função deve retornar apenas notas de pessoas Jurídicas (J) ou de pessoas Físicas (F). |
TWRemFiltroVinculoProduto - Conjunto de filtros para operações envolvendo vínculo de Itens de Estoque.
| empresa | int | Código da empresa onde estão registradas as informações de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| clienteFornec | double | Código do Cliente ou Fornecedor cujos produtos vinculados se deseja recuperar. Se não for fornecido, todos os códigos presentes no banco de dados serão considerados. |
| estab | short | Código do estabelecimento onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer o vínculo do produto em todos os estabelecimentos onde ele estiver presente. |
| depos | short | Código do depósito onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer o vínculo do produto em todos os depósitos onde ele estiver presente. |
| codigoProduto | string | Código do produto cujas informações sobre vínculo se deseja recuperar. Se este campo estiver em branco, serão retornados todos os vínculos que atenderem os demais filtros fornecidos. |
TWRemFiltroProdutoECom - Conjunto de filtros para busca de informações de produtos marcados como
sendo do ECommerce.
| empresa | int | Código da empresa onde estão registradas as informações de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| filial | int | Código da filial onde estão registradas as informações de produtos que se deseja recuperar. Se não for fornecido, todas as empresas/filiais presentes no banco de dados serão consideradas. |
| estab | short | Código do estabelecimento onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer informações do produto em todos os estabelecimentos onde ele estiver presente. |
| depos | short | Código do depósito onde o produto está cadastrado. Informe zero para ignorar o filtro e trazer informações do produto em todos os depósitos onde ele estiver presente. |
| codigoProduto | string | Código do produto sobre o qual se deseja recuperar as informações. Se optar por fornecer o código do grupo de estoque, deixe este campo em branco. |
| grupoEstoque | int | Código do Grupo de Estoque dos produtos sobre os quais se deseja recuperar as informações. Será criada uma faixa de grupos, considerando os sub grupos que não tenham sido fornecidos. Por exemplo, se o grupo informado for 10250000, serão considerados os produtos na faixa entre 10250000 e 10259999. Lembrete: os grupos de estoque no ERP são compostos por 4 subgrupos de 2 dígitos cada um. Se optar por informar um código do produto, o grupo de estoque deve ser zero. |
| ApenasECom | bool | Indica se a operação deve considerar apenas os produtos que estejam em grupo de estoque marcado para integração com ECommerce. |
TWRemParamCalcPreco - Parâmetros para cálculo do preço de venda de Produtos.
| Estab | short | Código do estabelecimento onde o produto está cadastrado. |
| Depos | short | Código do depósito onde o produto está cadastrado. |
| CodigoProduto | string | Código do produto que se quer calcular o preço de venda. |
| ClienteFornec | double | Código do Cliente/Fornecedor para quem se calculará o preço. |
| TipoFrete | char | Tipo do frete a ser usado na transação. |
| Transportadora | double | Código da Transportadora a contratar para o transporte. |
| TipoFreteRedesp | char | Tipo do frete de redespacho, se aplicável. |
| TransportRedesp | double | Código da Transportadora de redespacho, se aplicável. |
| Qtde | double | Quantidade do produto que será vendida. |
| VlrUnitVenda | double | Valor unitário de venda para o produto. |
| Unidade | string | Unidade de venda do produto. |
| CondPagto | short | Código da Condição de Pagamento para a transação. |
| CodEndEntrega | string | Código do endereço de entrega a ser considerado no cálculo do preço de venda. |
| PorcComiss | double | Porcentagem de comissão prevista para a transação. |
| ValorFrete | double | Valor do frete contratado para a transação, se aplicável. |
| TipoVenda | short | Código do tipo da venda. |
| PorcMargem | double | Porcentagem da margem a ser aplicada ao preço nessa transação. |
| PrecoMargem | double | Valor fixo da margem prevista para a transação. |
| CodMuniOrigem | int | Código do município de origem da mercadoria. |
| FreteFrac | char | Indica se o frete da transação será fracionado ('S') ou não ('N' ou ' '). |
| QtdeFreteFrac | double | Quantidade para fracionamento do frete, se aplicável. |
| VlrFreteFrac | double | Valor do frete fracionado, se aplicável. |
| DestRemessa | double | Destinatário da remessa. |
| CodIndice | int | Código da moeda em que o preço será considerado. |
| TipoMovto | short | Código do tipo de movimento da transação de venda. |
| TranspCooperativa | char | Indica se a transportadora é uma cooperativa ('S') ou não ('N' ou ' '). |
| TranspContratada | char | Indica se a transportadora é contratada ('S') ou não ('N' ou ' '). |
| OperVendaDireta | char | Indica se se trata de uma operação de venda direta ('S') ou não ('N' ou ' '). |
| DataEntrega | int | Data prevista para a entrega. |
TWStatusPedidoVenda - Valores para o status de um Pedido de Venda
| spvNCADASTRADO | 0 | Pedido NÃO CADASTRADO no ERP. |
| spvCONFIRMADO | 1 | Pedido está CONFIRMADO no ERP. |
| spvSEPARACAO | 2 | Os produtos do Pedido estão EM SEPARAÇÃO |
| spvCAPTURA_PGTO | 3 | O Pedido está AGUARDANDO CAPTURA DO PAGAMENTO. |
| spvAGUARDE_NFE | 4 | O Pedido está AGUARDANDO EMISSÃO DA NFE. |
| spvFATURADO | 5 | O Pedido foi FATURADO. |
| spvLIB_ENTREGA | 6 | Pedido LIBERADO PARA ENTREGA. |
| spvENTREGUE_DEVOL | 7 | O Pedido foi ENTREGUE OU DEVOLVIDO. |
