Sankhya
Manage your finances, customers and operations with Sankhya ERP.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 152 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_login | h1Regras de negócio/h1 O procedimento de autenticação é realizado utilizando o usuário e senha válidos e vinculado ao bSankhyaID/b, e deve ser o primeiro passo em uma sessão de chamadas de serviços. br / Com uma autenticação é possível chamar outros serviços em sequência, como por exemplo os serviços loadrecords e saverecords. Isso porque o ib bearer token /i/b obtido a partir dessa requisição é que deverá ser informado no cabeçalho das chamadas subsequentes, permite que a sessão fique aberta pe | token (string) required appkey (string) required username (string) required password (string) required |
| post_pedidos | h1Regras de negócio/h1 O cadastro de pedidos no sistema, permite que você registre e gerencie o que foi vendido e precisa ser faturado e entregue indicando, para qual cliente ou parceiro, quais as condições comerciais e financeiras negociadas e demais informações, proporcionando uma clara visão do que está em cada etapa do processo.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/36 | No parameters |
| get_pedidos | h1Regras de negócio/h1 Permite a consulta das informações relacionadas aos pedidos de venda e permite validar os valores e condições negociadas entre empresa e parceiro.O detalhamento de cada parametrização e/ou preenchimento, deve ser verificado junto aos gestores de sua empresa e/ou consultores Sankhya.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044612654-Portal-de-Vendas | No parameters |
| post_inc_alt_item_pedido | h1Regras de negócio/h1 O objetivo é incluir no ERP um bpedido de venda/b ou bpedido de compra/b negociado, por exemplo em 01/01 para ser entregue em até 31/12, durante esse prazo de negociação, ocorrem algumas variações do preço na quantidade dos itens, assim como itens excluídos e incluídos na negociação, por isso existe a necessidade de manter um bpedido de venda/b faturado parcialmente e que poderá sofrer manutenções/alterações.br / Para realizar configuração no sistema com o butipo de operaç | No parameters |
| post_exc_alt_item_pedido | h1Regras de negócio/h1 O objetivo é incluir um bpedido de venda/b ou bpedido de compra/b negociado, por exemplo em 01/01 para ser entregue em até 31/12, durante esse prazo de negociação, ocorrem algumas variações do preço e quantidade dos itens, assim como itens excluídos e incluídos na negociação, por isso existe a necessidade de manter um bpedido de venda/b faturado parcialmente e que poderá sofrer manutenções/alterações.br / Será necessário efetuar algumas, configurações como do tipo de opera | No parameters |
| get_status_pedidos | h1Regras de negócio/h1 Para realizar consulta de status dos pedidos será necessário realizar uma consulta envolvendo 3 tabelas, são elas: bTGFCAB,TGFVAR/b e bTGFCAN/b.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044612654-Portal-de-Vendas oqueumpedidodevendabr / h3Dependências/h3 bÉ/b necessário a criação da view VW_STPEDIDOS_JSON para poder efetuar a consulta dos status dos ped | No parameters |
| post_cancelamento_pedidos | h1Regras de negócio/h1 Para realizar o cancelamento de pedidos no ERP será necessário efetuar criação de um filtro para acessar os títulos que precisam ser cancelados e efetuar o preenchimento dos dados necessários para efetuar o cancelamento.No ERP a partir do momento que é cancelada uma nota fiscal, não é mais possível reverter este processo, sendo necessário lançar a nota fiscal novamente.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de | No parameters |
| post_faturamento_pedidos | h1Regras de negócio/h1 Para finalizar uma venda, o pedido de vendas precisa ser faturado, ou seja, transformado em nota fiscal ou Ordem de Entrega.br / O conceito prático de faturamento, consiste em transformar um pedido de venda em uma nota fiscal de Venda; porém, na passagem de um orçamento para um pedido de venda, pode-se entender que também houve um faturamento, mas não com as mesmas validações mencionadas acima.br / bVale ressaltar que, os comportamentos citados, poderão variar de acordo | No parameters |
| post_grupo_produto | h1Regras de negócio/h1 Para realizar o cadastramento no ERP de grupos de produtos o serviço obrigatoriamente deve pertencer a um grupo. Para que seja definido uma forma de classificação e agrupamento de produtos e serviços com características semelhantes, objetivando facilitar operações como:Atualização de preços;Análises de relatórios gerenciais;impressão de listas de preços, inventários etc.br / Porém no sistema é necessário evitar um grande número de níveis, pois isso torna os lançamentos mui | No parameters |
| post_produto | h1Regras de negócio/h1 Para realizar o cadastro de produto no ERP é necessário preencher os dados obrigatórios, pois todo produto/serviço obrigatoriamente deve pertencer a um grupo. Esta tela permite que você defina uma forma de classificação e agrupamento de produtos e serviços com características semelhantes, objetivando facilitar operações como: atualização de preços,análises de relatórios gerenciais e impressão de listas de preços.br / bOBS/b: Caso tenha alguma necessidade de configuração do | No parameters |
| get_produto | h1Regras de negócio/h1 Atualmente, em uma empresa de comercialização de itens palpáveis, o produto é considerado a ferramenta de cunho fundamental para os processos de Compra e Venda. br/ A instituição adquire os produtos para revenda ou as matérias primas para produção de itens próprios.br / Além disso, temos em meio ao processo de Compras, as solicitações internas, que tem por objetivo sanar as deficiências de materiais nos vários setores da empresa.br /br / Esta documentação permitirá que vo | No parameters |
| get_produto_empresa | h1Regras de negócio/h1 A empresa pode possuir mais de uma tabela de preço cadastrada para seus produtos, sendo que podem ser concedidos descontos promocionais com o mesmo período e produto para tabelas diferentes com percentuais diferentes.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044600034-Descontos-Promocionaisbr / h3Dependências/h3 bfont color=redNão possui dependências | No parameters |
| get_promocao_produto | h1Regras de negócio/h1 O ERP permite o cadastro de descontos, restringindo este por b'produto/serviço'/b, b'grupo de produto'/b ou b'Todos'/b, sendo que quando definido com esta última opção, todos os produtos sem exceção serão b'afetados'/b pelo desconto configurado.Para que o processo seja validado é importante efetuar as devidas configurações no ERP e informar o produto para o qual será concedido o desconto.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure b“Consultor”/b | No parameters |
| get_promocao_grupo_produto | h1Regras de negócio/h1 Para realizar uma consulta por grupo de produtos, primeiramente é necessário realizar uma venda com produto promocional por b“grupo de Produtos”/b no ERP para que o desconto em percentual seja aplicado no produto. br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044600034-Descontos-Promocionaisbr / h3Dependências/h3 bfont color=redNão possui dependências/f | No parameters |
| get_promocao_empresa | h1Regras de negócio/h1 Para realizar consulta de promoções por empresa é necessário efetuar devidas configurações no ERP conforme configurações do tipo de negociação aplicado e produto cadastrado precificado.A empresa pode, possuir mais de uma tabela de preço, cadastrada para seus produtos, sendo que podem ser concedidos, descontos promocionais com o mesmo período e produto para tabelas diferentes com percentuais diferentes.br / bImportante:/b Quando a promoção é por empresa no ERP isolamento pr | No parameters |
| get_promocao_parceiro | h1Regras de negócio/h1 Para realizar uma consulta de b“promoções por parceiros”/b no ERP devemos, efetuar configurações necessárias para que seja possível aplicar algum tipo de negociação e informar no sistema qual o parceiro que receberá o desconto é inserir o produto que receberá o desconto e confirmar a nota então o valor de desconto será aplicado.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure b“Consultor”/b ou acesso o link de apoio:br / https://ajuda.sankhya.com | No parameters |
| get_promocao_quantidade | h1Regras de negócio/h1 Para realizar consulta de promoções por quantidade é necessário efetuar configurações necessárias de modo a restringir a quantidade a ser considerada para aplicação do desconto promocional, se este desconto será em 'valor' ou 'percentual' e o valor ou percentual de desconto propriamente dito.br/ Ressalto que o desconto por quantidade será válido apenas quando o 'Tipo de Negociação' possuir a opção b'Considerar por Quantidade'/b.br / bImportante:/b Não é possível a configur | No parameters |
| get_ligacao_nota_pedido | h1Regras de negócio/h1 Esta “Ligação Nota Pedido” recebe uma ação, que é feita no portal de vendas que armazena o número do pedido original, ligando ele ao número da nota gerado.Sendo assim, o sistema busca número da nota, quantidade atendida, status nota e pedido de origem.br / bfont color=redIMPORTANTE:/font/b Um pedido pode ser faturado várias vezes, caso isto aconteça o mesmo pedido pode estar ligado a várias notas conforme o pedido foi sendo faturado.br / bOBS:/b Caso tenha alguma necessida | No parameters |
| post_salve | h1Regras de negócio/h1 Utilizando a API é possível realizar a inclusão, ou atualização, de dados no SankhyaOm. Para isso, utilizamos o serviço 'DatasetSP.save'. O mesmo serviço é utilizado para ambos os casos, o que vai indicar se é inclusão ou atualização é o envio da chave primária do registro ou não, ou seja, ao enviar a chave primária indica a necessidade de atualização, e caso a chave primária não seja enviada, a API entende que é necessário fazer a inclusão do registro.br / h3Exemplo de us | No parameters |
| get_salve | h1Regras de negócio/h1 Para realizar a consulta de clientes é necessário definir as funções do parceiro no sistema.Quando você incluir um novo registro do tipo clientes ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br | No parameters |
| get_clientes_vendedores | h1Regras de negócio/h1 Para realizar a consulta de cliente x vendedores no ERP será necessário efetuar o cadastramento preencher, inicialmente, os campos obrigatórios. Pois este cadastro ligará o vendedor/Comprador ao seu parceiro, ou seja, se o vendedor ou comprador é um cliente ou fornecedor da empresa.br / bOBS/b: Caso tenha alguma necessidade de configuração do ERP procure “consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045111133-Vendedores-Compra | No parameters |
| post_contato_cliente | h1Regras de negócio/h1 Para realizar o cadastro de clientes é necessário definir as funções do parceiro no sistema.Quando você incluir um novo registro do tipo contato de clientes ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente. br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.c | No parameters |
| get_contato_cliente | h1Regras de negócio/h1 Para realizar consulta de contatos de clientes no sistema ERP é necessário definir as funções do parceiro no sistema. Cada uma das possíveis definições deste campo possuem uma simbologia própria. br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044594494-Cadastro-de-Parceiros abacontatosbr / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h | No parameters |
| get_credito_cliente | h1Regras de negócio/h1 Para realizar a consulta de crédito do cliente é necessário acessar o ERP. O objetivo é agrupar os dados, relacionados às operações de venda do parceiro junto à empresa, ou seja, às informações utilizadas para limitar crédito no ato da venda.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / http://grupo.sankhya.com.br/hs/skwajuda-3.16.0/pt_BR/br_com_sankhya_core_cad_parceiros.html abacrditobr / h3Dependências/ | No parameters |
| get_load_records | h1Regras de negócio/h1 A API possui um serviço genérico para aplicar consultas em todas as Entidades disponíveis no ERP: bCRUDServiceProvider.loadRecords/b. Por definição, uma entidade mapeia uma tabela que está no banco de dados, vejamos a seguir alguns exemplos de Entidade:br / b•/b Entidade Produtos mapena a tabela TGFPRObr / b•/b Entidade Parceiros mapeia a tabela TGFPARbr / br / h3Exemplo de uso:/h3 br / bURL de chamada/b: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=C | No parameters |
| get_load_record | h1Regras de negócio/h1 A API possui um serviço genérico para aplicar consultas em todas as Entidades disponíveis no ERP: bCRUDServiceProvider.loadRecord/b com o objetivo de obter 1 registro. O escopo da requisição é mais simples que bCRUDServiceProvider.loadRecord/b e exige apenas o envio dos critérios por meio da tag 'rows'. br / h3Exemplo de uso:/h3 br / bURL de chamada/b: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecord and outputType=json br / | No parameters |
| get_bancos | h1Regras de negócio/h1 Para realizar consulta de bancos no ERP, será necessário efetuar cadastro correspondente ao banco e sua nomenclatura para o qual você pode pesquisar, inserir um novo registro, exibir a tela em modo grade, entre outras possibilidades.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044598894-Bancos h3Dependências/h3 bfont color=redNão possui dependências/fo | No parameters |
| get_conta_bancaria | h1Regras de negócio/h1 Dado que o usuário precisa cadastrar uma nova conta bancária. Quando a empresa houver uma nova conta, para brecebimentospagamentos/b então este será efetivado o cadastro.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044598894-Bancosbr / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h3Detalhes Técnicos/h3 A entidade utilizada é a bCo | No parameters |
| get_log_alteracoes_tabelas | h1Regras de negócio/h1 Esse serviço permite consultar a data de alteração de um período específico que seja passado no campo dhAlter e entidades específicas passadas no campo Entidade. br /br /Para utilizar a API, deve-se fazer uma requisição bPOST/b para o endpoint correspondente ao serviço desejado. br / h3Dependências/h31 Para que o serviço retorne informações, é necessário habilitar o parametro bLOGTABOPER/b disponível nas Preferencias do SankhyaOm. Este liga ou desliga a funcionalidade de L | No parameters |
| get_central_venda_rapida_sp_simular_valores_nota | h1Regras de negócio/h1 A API REST para cálculo de impostos foi criada para permitir que usuários obtenham informações sobre impostos de pedidos e notas. A API fornece um serviço para cálculo automático de impostos, a partir de dados informados pelo usuário. Esta documentação tem o objetivo de apresentar as funcionalidades e operações da API, bem como os parâmetros de entrada e saída necessários para cada operação. bComo usar a API/b É necessário enviar uma requisição HTTPS para o endpoint mge | No parameters |
| get_empresa | h1Regras de negócio/h1 Para realizar a consulta de empresa no sistema ERP é necessário efetuar o cadastramento da empresa com os dados fundamentais de cada uma delas.Pois cada empresa será as unidades que centralizaram a análise dos resultados, sejam de compras e vendas, receitas e despesas, entre outros. br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045118293-Empresasbr / h3D | No parameters |
| get_load_records_com_ligacoes | O serviço padrão 'CRUDServiceProvider.loadRecords' é considerado padrão para realizar consultas em entidades que estão no SankhyaOm. O retorno natural é trazer os dados que estão na entidade. O objetivo deste tutorial é apresentar as vantagens de utilizar as ligações nativas entre as entidades para retornar dados complementares aos registros, como por exemplo, é possível retornar além do Código do Grupo do Produto, também a descrição, informação esta que está em outra entidade. O código a seguir | No parameters |
| get_estoque | h1Regras de negócio/h1 Dentro de uma empresa, o estoque é representado por produtos que estão armazenados em locais que são utilizados para a produção de seu produto ou para suprimir a necessidade da própria empresa.br /br / No ERP Sankhya-Om devemos entender um local de estoque, como uma maneira de classificação e organização dos produtos no estoque da empresa; o destino dos itens a medida que as operações de compra, venda e movimentação interna são realizadas.br / bOBS:/b Caso tenha alguma nec | No parameters |
| post_fornecedor | h1Regras de negócio/h1 O cadastro de fornecedores no sistema ERP visa realizar controle de gestão que definirá as funções do parceiro no sistema.Quando você incluir um novo registro do tipo fornecedor ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https:// | No parameters |
| get_fornecedor | h1Regras de negócio/h1 Para realizar a consulta de fornecedores é necessário definir as funções do parceiro no sistema.Quando você, incluir um novo registro do tipo fornecedor ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/p | No parameters |
| post_motorista | h1Regras de negócio/h1 O cadastro de motoristas no sistema ERP visa realizar controle de gestão do responsável pelo veículo.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045111533-Ve%C3%ADculos-br / h3Dependências/h3 No cadastro de parceiro, a cidade deve constar no cadastro do ERP Sankhya-Om.br /br / Caso não seja informado o CPF ou CNPJ no campo CGC_CPF, deve se informar no | No parameters |
| get_motorista | h1Regras de negócio/h1 Consulta de motoristas no sistema ERP visa realizar controle de gestão do responsável pelo veículo.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045111533-Ve%C3%ADculos-br / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h3Detalhes Técnicos/h3 A entidade utilizada é a bParceiro/b que por sua vez instancia a tabela TGFPAR mapeando os | No parameters |
| post_transportadora | h1Regras de negócio/h1 As principais funções do transporte na logística estão ligadas basicamente às dimensões de tempo e utilidade do lugar. O transporte de mercadorias é utilizado para disponibilizar produtos onde existe demanda potencial, dentro do prazo adequado às necessidades do comprador.br / O parceiro transportador está vinculado à ordem de carga utilizada para entregar o item do apontamento de entrega.Quando você efetuar a marcação sistema b'transportadora própria'/b, estará indicando | No parameters |
| get_transportadora | h1Regras de negócio/h1 As principais funções do transporte na logística estão ligadas basicamente às dimensões de tempo e utilidade do lugar. O transporte de mercadorias é utilizado para disponibilizar produtos onde existe demanda potencial, dentro do prazo adequado às necessidades do comprador.br / O parceiro transportador está vinculado à ordem de carga utilizada para entregar o item do apontamento de entrega.Quando você efetuar a marcação sistema b'transportadora própria'/b, estará indicando | No parameters |
| get_natureza | h1Regras de negócio/h1 Para realizar o cadastro de natureza no sistema ERP deverá inicialmente configurar o parâmetro 'Máscara para o Grupo de Naturezas - MASCGRUPONAT'.br / Após a configuração deste parâmetro é possível efetuar a configuração dos grupos de natureza.Nesta tela são cadastrados os grupos de natureza e nesses grupos é possível vincular as naturezas já existentes no sistema através da aba de naturezas.br / bfont color=redImportante/font/b: O vínculo do Tipo de Natureza do Grupo de N | No parameters |
| post_kit | h1Regras de negócio/h1 Kit é um conjunto de objetos ‘Produtos’ que são utilizados, para um mesmo fim ou conjunto que podem ser usados, para fazer montagens de objetos ou construções sendo possível encontrar Kit de barbear, kit de Higiene ou kit de primeiros socorros.br / Através do ERP sankhya será possível que você efetue o cadastro de produtos Kit e seu respectivo produto substituto.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br | No parameters |
| get_kit | h1Regras de negócio/h1 Kit é conjunto de objetos ‘Produtos’ que são utilizados para um mesmo fim ou compõe-se um conjunto de objetos ou itens que para fazer montagens de kits, como por exemplo, um kit de barbear, kit de Higiene ou kit de primeiros socorros.br /br / Através desta tela, tem-se o início de configurações da utilização de Kit e que será possível que você efetue o cadastro de produtos para compor um kit e também seus respectivos substitutos. Será possível realizar configurações e vinc | No parameters |
| get_plano_contas | h1Regras de negócio/h1 Para realizar a consulta e plano de contas é necessário efetuar o cadastramento das contas contábeis que irão compor o plano de contas da empresa, para que seja possível fazer a inclusão/cadastro, exclusão, consulta e pesquisa das Contas Contábeis.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044608054-Plano-de-Contasbr / h3Dependências/h3 bfont color= | No parameters |
| get_centro_resultado | h1Regras de negócio/h1 Para realizar a consulta de centro de resultado no ERP necessário, consultar os registros para que o subconjunto ou parte de uma empresa possa ter suas receitas e despesas analisadas separadamente, possibilitando avaliar seu desempenho e compará-lo ao da empresa como um todo.br / bOBS/b: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044606754-Centros-de-Resultadobr / | No parameters |
| post_volume | h1Regras de negócio/h1 O cadastro de volume visa padronizar as unidades de medida que serão utilizadas para os produtos. É permitida a utilização de várias unidades de medida para o cadastro de um mesmo produto ou serviço; estas poderão ser empregadas nos lançamentos de todos os tipos de movimento, desde a compra até a venda.No ERP efetuar preenchimento dos campos obrigatórios.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / htt | No parameters |
| get_volume | h1Regras de negócio/h1 A consulta de volumes visa padronizar as unidades de medida que serão utilizadas para os produtos.Como no sistema, e permitido a utilização de várias unidades de medida para o cadastro de um mesmo produto ou serviço; estas poderão ser empregadas nos lançamentos de todos os tipos de movimento,desde a compra até a venda.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/a | No parameters |
| get_icmsprodutos | h1Regras de negócio/h1 No ERP sankhya existe várias formas de configurar alíquotas de ICMS para serem utilizadas como base para cálculos de impostos nas operações de entrada e saída de produtos dos estados, isto é, são utilizadas para tributação e fiscalização de empresas. Existem também a possibilidade de se configurar várias regras e exceções de alíquotas de estado para estado.br / Existem situações que serão necessárias que a empresa configure suas regras de cálculo de impostos nas notas fisc | No parameters |
| get_icmsgrupo_produtos | h1Regras de negócio/h1 No ERP sankhya existe várias formas de configurar alíquotas de ICMS para serem utilizadas como base para cálculos de impostos nas operações de entrada e saída de produtos dos estados, isto é, são utilizadas para tributação e fiscalização de empresas.Existe também, possibilidade de se configurar também várias regras e exceções de alíquotas de estado para estado.br / Existem situações em que será necessário a empresa,configurar suas regras de cálculo de impostos nas notas fi | No parameters |
| get_icmsgrupo_parceiros | h1Regras de negócio/h1 No ERP sankhya existe várias formas de configurar alíquotas de ICMS para serem utilizadas como base para cálculos de impostos nas operações de entrada e saída de produtos dos estados, isto é, são utilizadas para tributação e fiscalização de empresas.Existe também, possibilidade de se configurar também várias regras e exceções de alíquotas de estado para estado.br / Existem situações em que será necessário a empresa,configurar suas regras de cálculo de impostos nas notas fi | No parameters |
| get_load_records_com_criterio | Quando temos parâmetros variáveis, como é o caso da expressão aqui usada, devemos colocar um '?' onde o valor do parâmetro será injetado. Para cada '?' na expressão devemos ter um elemento 'parameter'. Os possíveis valores para o atributo 'type' são: ul liD = Data sem horário/li liH = Data com horário no seguinte formato: DD/MM/AAAA HH:MM:SS/li liF = Número decimal decimal separado por '.'/li liI = Número inteiro/li liS = Texto/li /ul br /IMPORTANTE: Sempre usar parâmetro para critério | No parameters |
| post_unidade_alternativa | h1Regras de negócio/h1 No ERP sankhya as unidades alternativas deverão ser configuradas considerando a unidade padrão que poderá ser unidade ou caixa, pois o sistema considera unidade padrão para o cálculo das “unidades alternativas”.br / Caso haja alguma unidade alternativa já cadastrada, o sistema permitirá que a Unidade Padrão seja alterada para a Unidade Alternativa já cadastrada, permitindo assim, que estas duas sejam iguais.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP | No parameters |
| get_unidade_alternativa | h1Regras de negócio/h1 No ERP sankhya as Unidades Alternativas deverão ser configuradas considerando a unidade padrão que poderá ser unidade ou caixa, pois o sistema considera unidade padrão para o cálculo das “Unidades Alternativas”.br / Caso haja alguma Unidade Alternativa já cadastrada, o sistema permitirá que a Unidade Padrão seja alterada para a Unidade Alternativa já cadastrada, permitindo assim, que estas duas sejam iguais.br / bOBS:/b Caso tenha alguma necessidade de configuração do ER | No parameters |
| get_cfop | h1Regras de negócio/h1 bCFOP/b é a abreviação de Código Fiscal de Operações e Prestações .É estabelecido pela Receita Federal e é utilizado desta forma no bERP/b. Para realizar as consultas referente aos bCFOP/b, os mesmos devem estar cadastrados corretamente no bERP/b.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044600714-CFOPbr / h3Dependências/h3 bfont color=redNão possui | No parameters |
| post_endereco | h1Regras de negócio/h1 Para realizar o cadastro de endereços no sistema ERP necessário realizar o cadastro de forma padronizada.Onde você pode pesquisar, inserir um novo registro, exibir a tela em modo grade, entre outras possibilidades.Uma vez definido o padrão de cadastro para um nome, aconselhamos que este não seja alterado, visando evitar que exista um mesmo registro cadastrado mais de uma vez com nomes diferentes.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure b“Co | No parameters |
| get_endereco | h1Regras de negócio/h1 Nesta rotina é realizado a consulta de endereços que serão utilizados nos diversos procedimentos do sistema. Para aprimorar, todos os cadastros e permitir a seleção uniforme, se faz necessário cadastrá-los de forma padronizada.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044602274-Endere%C3%A7osbr / h3Dependências/h3 bfont color=redNão possui dependênci | No parameters |
| post_bairro | h1Regras de negócio/h1 No sistema ERP será necessário, efetuar de forma padrão para cadastro do nome do bairro, para melhor organização e visualização dos mesmos; a seleção dos registros se dá independentemente de conter letras maiúsculas ou minúsculas.br / No sistema a consulta de bairros é independente da consulta de cidades, sendo necessário criar endereços ou bairros com o mesmo nome para cidades distintas; basta cadastrar uma única vez e o mesmo servirá para todas as cidades. Logo, o sistem | No parameters |
| get_bairro | h1Regras de negócio/h1 Para realizar a consulta Bairro no sistema, primeiramente será necessário efetuar o cadastro do bairro para melhor organização e visualização dos mesmos; a seleção dos registros se dá independentemente de conter letras maiúsculas ou minúsculas.br / No sistema a consulta de bairros é independente da consulta de cidades sendo necessário criar bendereços/b ou bbairros/b com o mesmo nome para bcidades/b distintas; basta cadastrar uma única vez e o mesmo servirá para todas as c | No parameters |
| post_cidade | h1Regras de negócio/h1 Para realizar o cadastro de cidades no ERP é necessário incluir o código referente a cidade que está sendo cadastrada. Este preenchimento pode ser realizado automaticamente, ou de forma manual.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045110913-Cidadesbr / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h3Detalhes Técnicos/h3 A en | No parameters |
| get_cidade | h1Regras de negócio/h1 Para realizar o consulta de cidades no sistema ERP é necessário efetuar o cadastro das cidades. Este preenchimento pode ser realizado automaticamente, ou de forma manual.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045110913-Cidadesbr / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h3Detalhes Técnicos/h3 A entidade utilizada é a bE | No parameters |
| post_regiao | h1Regras de negócio/h1 O cadastro de regiões no sistema ERP possibilita o fracionamento de determinado espaço geográfico em regiões, facilitando, por exemplo, a cobrança de frete de acordo com a região e a definição de áreas de atuação de vendedores.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044599074-Regi%C3%B5esbr / h3Dependências/h3 Para realizar a importação do cadas | No parameters |
| get_regiao | h1Regras de negócio/h1 O cadastro de regiões no sistema ERP possibilita o fracionamento de determinado espaço geográfico em regiões, facilitando, por exemplo, a cobrança de frete de acordo com a região e a definição de áreas de atuação de vendedores.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360044599074-Regi%C3%B5esbr / h3Dependências/h3 bfont color=redNão possui dependênc | No parameters |
| get_projetos | h1Regras de negócio/h1 Um projeto pode ser definido como uma decisão empresarial cujos resultados devem ser apurados separadamente do restante do negócio, de modo a avaliar se aquela iniciativa estará gerando os resultados financeiros esperados.br / Para realizar uma consulta de Projetos no ERP o usuário deverá efetuar cadastro preenchendo os campos obrigatórios. br / bfont color = redNota/font:/b As opções no sistema de 'Ativo' e 'Analítico' são automáticas do sistema, tem-se que estas já est | No parameters |
| get_rotas | h1Regras de negócio/h1 Para realizar a consulta de rotas no sistema ERP é necessário preencher os dados obrigatórios.Para que seja possível,consultar a rota e o valor que será gasto em cada trajeto do veículo.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio: a href='https://ajuda.sankhya.com.br/hc/pt-br/articles/360045108613-Rotas' target=_blankhttps://ajuda.sankhya.com.br/hc/pt-br/articles/360045108613-Rotas/d h3Dependênci | No parameters |
| post_marcaproduto | h1Regras de negócio/h1 Por meio do ERP é possível realizar o cadastro de diversas marcas a serem posteriormente utilizadas no cadastro de produtos; é uma configuração que tem por objetivo a padronização das marcas empregadas nos produtos; uma vez que existem algumas marcas que podem ser cadastradas de maneira equivocada utilização de hífens, espaços etc, a uniformidade deste cadastro atua na prevenção desse tipo de ocorrência.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP proc | No parameters |
| get_marcaproduto | h1Regras de negócio/h1 Para realizar consulta de marca de produto primeiramente, se deve realizar cadastramento da marca que tem por objetivo a padronização das marcas empregadas nos produtos; uma vez que existem algumas marcas que podem ser cadastradas de maneira equivocada utilização de hífens, espaços etc, a uniformidade deste cadastro atua na prevenção desse tipo de ocorrência.br / Além disso, ao inserir uma marca no ERP da mesma nomenclatura de uma marca contida, as modificações efetuadas n | No parameters |
| get_supervisores | h1Regras de negócio/h1 Para realizar a consulta de supervisores no sistema ERP,será necessário efetuar o cadastro no sistema,preenchendo os dados obrigatórios como parceiros e cadastro de empresa para que seja possível realizar a consulta e acompanhar negociações de preços e prazos de entrega e estabelecer metas para cumprimento dos objetivos,assim como acompanhar os pedidos dos clientes e identificar suas necessidades, para definir a melhor forma de atendimento.br / bOBS:/b Caso tenha alguma ne | No parameters |
| get_tabelapreco | h1Regras de negócio/h1 Para realizar consulta “Tabela de Preço” no carregamento das regras/exceções da tabela de preço, o sistema irá trazer os registros de forma paginada, ou seja, os dados não irão ser carregados todos de uma vez só. O sistema irá trazer aos poucos os registros, para que você possa ir utilizando a tela enquanto as informações não são totalmente carregadas.br / Além disso, é possível que seja editado um registro somente no modo formulário enquanto os demais registros são carre | No parameters |
| get_usuarios | h1Regras de negócio/h1 Usuários são todas as pessoas que irão executar qualquer rotina no sistema, seja administrativa, financeira, comercial, etc.Para efetuar,consulta de usuários primeiro é necessário efetuar cadastramento no ERP preenchendo os campos obrigatórios com nome da pessoa responsável pelo acesso logo após criar uma senha, feito isso salvar os dados.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankh | No parameters |
| get_vendedores | h1Regras de negócio/h1 Para efetuar consulta vendedores/compradores, e otimizar controle de pagamentos de comissões e acompanhamento de desempenho de vendas e de compras com determinadas características.br / Para efetuar, consulta necessário efetuar cadastramento dos vendedores/compradores preenchendo no sistema os campos obrigatórios,como parceiros e cadastro da empresa, para que seja possível realizar consulta.br / OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” o | No parameters |
| get_metas_venda | h1Regras de negócio/h1 Para realizar a consulta de metas por vendedor no ERP, necessário efetuar as devidas configurações e definição de metas por vendedor primeiramente, pois logo que uma vez que as metas já estão configuradas, você também poderá definir metas por períodos mensais. Além de lançar metas, você poderá também configurar para quais TOP's o sistema considerará na atualização do realizado.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o | No parameters |
| get_metas_grupo_prod | h1Regras de negócio/h1 Para realizar consultas de metas é necessário efetuar a configuração no ERP e definir quais bmetas por grupo de produtos/b e quais seções grupo de produto. Permite ainda configurar se a meta será lançada em termos de b'quantidade'/b, b'Peso'/b, ou b'Valor'/b.br / No ERP é possível selecionar o ano para qual as metas mensais serão lançadas, e dos anos anteriores, podem ser consultados.Também é possível gravar no banco de dados metas e descartar as digitações realizadas e r | No parameters |
| get_metas_produtos | h1Regras de negócio/h1 Para realizar consultas de metas por produtos é necessário efetuar configurações no ERP e definir b“Metas por Produto”/b .Uma vez que as metas já estão configuradas, você poderá definir metas por períodos mensais. Estas metas podem ser estabelecidas para Produtos e ainda configurar se a meta será lançada em termos de b'quantidade'/b, b'peso'/b, ou b'valor'/b. No painel b“produto”/b teremos além dos recursos de filtros rápidos, a opção de se exibir o complemento do produto | No parameters |
| post_ordem_carga | h1Regras de negócio/h1 Permite gerar uma ordem de carga com base nos pedidos de venda e informando os dados da entrega,como região, veículo e motorista. Uma ordem de carga é emitida e utilizada na rotina de formação de cargas, agrupando e vinculando os pedidos a elas.br bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br https://ajuda.sankhya.com.br/hc/pt-br/articles/360045119713-Ordens-de-Cargabr h3Dependências/h3 bfont color=redNão p | No parameters |
| get_ordem_carga | h1Regras de negócio/h1 Permite gerar uma ordem de carga com base nos pedidos de venda e informando os dados da entrega,como região, veículo e motorista. Uma ordem de carga é emitida e utilizada na rotina de formação de cargas, agrupando e vinculando os pedidos a elas.br bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br https://ajuda.sankhya.com.br/hc/pt-br/articles/360045119713-Ordens-de-Cargabr h3Dependências/h3 bfont color=redNão p | No parameters |
| post_vincular_ordem_carga | h1Regras de negócio/h1 Como o objetivo é vincular os pedidos a uma ordem de carga, pesquisar somente os pedidos de venda pendentes. Quando se define que serão pesquisados apenas lançamentos do Tipo de Movimento b'pedido de venda'/b, através do painel de filtros, o sistema habilita as opções b'exibir pedidos não confirmados'/b e b'exibir somente pedidos pendentes'/b.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.s | No parameters |
| post_sequenciar_ordem_carga | h1Regras de negócio/h1 A sequência de ordem de carga tem a função de informar quais cidades farão parte da rota de entrega.Será necessário efetuar o cadastro no ERP da sequência de entrega.A primeira cidade da rota deverá ter a sequência 1, a segunda a sequência 2, e assim por diante.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045108613-Rotas abasequenciadeentregabr / h3Depe | No parameters |
| get_tipo_titulo | h1Regras de negócio/h1 Os tipos de títulos que, ao serem vinculados a um tipo de negociação, serão utilizados pela empresa na geração de documentos para pagamento ou recebimento tais como, boletos, duplicatas e etc; são empregados nas centrais em emissões de notas, de modo a alimentar o financeiro além de compor os lançamentos.br /br / bfont color=redOBS/font/b: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio: https://ajuda.sankhya.com.br/hc/pt- | No parameters |
| get_titulo_aberto | h1Regras de negócio/h1 É tudo aquilo que é arrecadado pela empresa, a título de Lançamentos financeiros a pagar com status “Em Aberto” ou “Parcialmente Baixado”.br / bOBS:/b Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:br / https://ajuda.sankhya.com.br/hc/pt-br/articles/360045114753-Movimenta%C3%A7%C3%A3o-Financeira oquesoreceitasedespesasbr / h3Dependências/h3 bfont color=redNão possui dependências/font/bbr / h3Detalhes Técnicos/h3 A entidad | No parameters |
| get_tipo_negociacao | h1Regras de negócio/h1 Os tipos de negociação se referem às formas de pagamento utilizadas pela empresa, seja nas operações de compra ou venda. Nos tipos de negociação são realizadas diversas parametrizações que serão utilizadas nas negociações com os parceiros da empresa; portanto, tem-se aqui um cadastro de extrema importância.br / bfont color=redOBS/font/b: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio: https://ajuda.sankhya.com.br/hc/pt-br | No parameters |
| get_parcelas_tipo_negociacao | h1Regras de negócio/h1 Os tipos de negociação se referem às formas de pagamento utilizadas pela empresa, seja nas operações de compra ou venda. Nos tipos de negociação são realizadas diversas parametrizações que serão utilizadas nas negociações com os parceiros da empresa; portanto, tem-se aqui um cadastro de extrema importância.br / bfont color=redOBS/font/b: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio: https://ajuda.sankhya.com.br/hc/pt-br | No parameters |
| get_load_view | A API disponibiliza o serviço loadView CRUDServiceProvider.loadView para realizar consulta em VIEWs. br /Existem algumas considerações importantes que devem ser levadas em consideração antes de sua utilização. Seguem: ul liO serviço não possui paginação nativa, portanto, a paginação deve ser feita pelo integrador que realiza a requisição./li liCaso a view não seja performática, é indicado a utilização de mecanismos de indexação para que a performance seja adequada, como Materialized Views f | No parameters |
| get_veiculo | h1Regras de negócio/h1 Para realizar consulta de veículos é necessário efetuar cadastro pois é primordial para funcionamento da rotina de controle de veículos.Depois de efetuados os cadastros corretamente e realizados os lançamentos dos devidos registros como por exemplo, nota de compra, despesas ou requisições referentes ao veículo.br / bfont color=redNota/font/b: É possível realizar o cadastro de vários veículos no ERP para o mesmo produto desde que o código vinculado seja diferente uns dos ou | No parameters |
| get_anexar_arquivos | h1Anexando documentos em registros específicos/h1 A maioria das entidades do sistema permite anexar documentos em suas respectivas telas ex.: cadastro de parceiros, cadastro de produtos, item da nota, contratos, etc.. O objetivo deste tutorial é apresentar como isso pode ser feito via API. O processo é realizado em duas etapas: ul lio primeiro passo é enviar o arquivo para o servidor./li lio segundo passo salva o anexo e endereça ao respectivo registro./li /ul Para ilustrar, apresentamos a s | No parameters |
| post_v1_vendas_cfe_sat | Inclui um Cupom Fiscal eletronico modelo 59 emitido em um PDV externo. | data: { . notaModelo (integer) . ambiente (integer) . tipoEmissao (integer) . finalidade (integer) . protocolo (string) . dataProtocolo (string) . horaProtocolo (string) . numeroAleatorio (integer) . numeroDocumento (string) . serie (string) . data (string) . hora (string) . codigoPedidoOrigem (integer) . codigoVendedor (integer) . codigoCaixa (integer) . consumidor (object) . observacao (string) . valorFrete (number) . valorIcms (number) . valorPis (number) . valorCofins (number) . valorFcp (number) . valorJuro (number) . valorTotal (number) . numeroSerieSat (string) . chaveNfe (string) . xml (string) . itens (array) . financeiros (array) } (object) required |
| post_v1_vendas_cfe_sat_cancelar | Cancela um Cupom Fiscal eletronico modelo 59 emitido em um PDV externo. | data: { . chaveNfe (string) . motivo (string) . protocolo (string) . data (string) . hora (string) . xml (string) } (object) required |
| post_v1_vendas_cfe_sat_inutilizar | Inutiliza Numeração de Cupom Fiscal eletronico modelo 59 emitido em um PDV externo. | data: { . codigoEmpresa (integer) . protocolo (string) . serie (string) . data (string) . hora (string) . motivo (string) . numeroInicial (number) . numeroFinal (number) . xml (string) } (object) required |
| post_v1_vendas_nfce | Inclui uma Nota Fiscal de Consumidor eletronico modelo 65 emitido em um PDV externo. | data: { . notaModelo (integer) . ambiente (integer) . tipoEmissao (integer) . finalidade (integer) . protocolo (string) . dataProtocolo (string) . horaProtocolo (string) . numeroAleatorio (integer) . numeroDocumento (string) . serie (string) . data (string) . hora (string) . codigoPedidoOrigem (integer) . codigoVendedor (integer) . codigoCaixa (integer) . consumidor (object) . observacao (string) . valorFrete (number) . valorIcms (number) . valorPis (number) . valorCofins (number) . valorFcp (number) . valorJuro (number) . valorTotal (number) . numeroSerieSat (string) . chaveNfe (string) . xml (string) . itens (array) . financeiros (array) } (object) required |
| post_v1_vendas_nfce_autorizar | Autoriza um Nota Fiscal de Consumidor eletronico modelo 59 emitido em um PDV externo que está armazenado no SankhyaOm. É importante ressaltar que a NFC-e deve ter sido previamente emitida em modo contingência tipoEmissao = 9. | data: { . chaveNfe (string) . protocolo (string) . data (string) . hora (string) . desvincularCnpjCpf (boolean) . xml (string) } (object) required |
| post_v1_vendas_nfce_cancelar | Cancela uma Nota Fiscal de Consumidor eletronico modelo 65 emitido em um PDV externo. | data: { . chaveNfe (string) . motivo (string) . protocolo (string) . data (string) . hora (string) . xml (string) } (object) required |
| post_v1_vendas_nfce_inutilizar | Inutiliza Numeração de Nota Fiscal de Consumidor eletronico modelo 65 emitido em um PDV externo. | data: { . codigoEmpresa (integer) . protocolo (string) . serie (string) . data (string) . hora (string) . motivo (string) . numeroInicial (number) . numeroFinal (number) . xml (string) } (object) required |
| post_v1_caixa_abertura | Este endpoint permite realizar a abertura de um Caixa/PDV no SankhyaOm. Para que o processo ocorra corretamente, o operador deve estar previamente vinculado ao cadastro do PDV no SankhyaOm. É importante observar que o SankhyaOm não permite mais de um 'Caixa Aberto' simultaneamente para o mesmo PDV, isso para garantir a integridade da operação. Ao abrir o Caixa/PDV, a API retornará o identificador codigoCaixa, que representa o 'Caixa Aberto' para o período em questão. Esse codigoCaixa deve ser | data: { . codigoPdv (integer) . cpfOperador (string) . data (string) . hora (string) . observacao (string) } (object) required |
| get_v1_caixa_aberto | Retorna o codigoCaixa que está aberto para o critério enviado para consulta. | codigoPdv (integer) required cpfOperador (integer) required |
| post_v1_caixa_fechamento | Este serviço realiza o fechamento do Caixa/PDV que está aberto. Este processo permite enviar os valores transacionados no Caixa/PDV por 'Tipo de Pagamento', isso irá apoiar no processo de Gestão de Caixa disponível no SankhyaOm. | data: { . codigoCaixa (integer) . data (string) . hora (string) . observacao (string) . conferencia (array) } (object) required |
| post_v1_caixa_sangria | Registra sagria para um Caixa/PDV. | data: { . codigoCaixa (integer) . data (string) . hora (string) . valor (number) . observacao (string) } (object) required |
| post_v1_caixa_suprimento | Registra suprimento para um Caixa/PDV. | data: { . codigoCaixa (integer) . data (string) . hora (string) . valor (number) . observacao (string) } (object) required |
| post_v1_caixa_recebimento | Registra recebimento para um Caixa/PDV. | data: { . codigoTipoOperacao (integer) . codigoNatureza (integer) . codigoProjeto (integer) . codigoCentroResultado (integer) . codigoParceiro (integer) } (object) required |
| post_v1_caixa_recebimento_baixa | Registra recebimento para um Caixa/PDV. | data: { . codigoFinanceiro (integer) } (object) required |
| get_v1_precos_produto_by_codigo_produto_tabela_by_codigo_tabela | Este serviço retorna os preços do produto enviado no contexto e que estão associados à tabela de preços enviada no contexto. Pode haver mais de um preço, pois o produto pode ter volume alternativo, variação de preço por local de armazenamento e também preço variado por controle ex.: sabor, cor, tamanho, etc.. Este serviço retorna até 50 registros por página. | codigoProduto (integer) codigoTabela (integer) pagina (integer) required |
| get_v1_precos_produto_by_codigo_produto | Este serviço retorna os preços do produto enviado no contexto, bem como as tabelas de preços nele relacionado. Vale ressaltar que cada produto x tabela de preços pode possuir mais de um preço, pois o produto pode ter volume alternativo, variação de preço por local de armazenamento e também preço variado por controle ex.: sabor, cor, tamanho, etc.. Este serviço retorna até 50 registros por página. | codigoProduto (integer) pagina (integer) required |
| get_v1_precos_tabela_by_codigo_tabela | Este serviço retorna os preços de todos os produtos vinculados à tabela de preços enviada no contexto. Vale ressaltar que cada produto x tabela de preços pode possuir mais de um preço, pois o produto pode ter volume alternativo, variação de preço por local de armazenamento e também preço variado por controle ex.: sabor, cor, tamanho, etc.. Este serviço retorna até 50 registros por página. | codigoTabela (integer) pagina (integer) required |
| post_v1_precos_contextualizado | Este serviço retorna os preços dos produtos de forma contextualizada, levando em conta as condições específicas de uma negociação. O preço pode variar com base em diversos fatores, como forma de pagamento, localização do cliente, vendedor responsável pela negociação, entre outros. A consulta permite até 50 produtos por solicitação. | data: { . codigoEmpresa (integer) . codigoCliente (integer) . codigoVendedor (integer) . codigoTipoOperacao (integer) . codigoTipoNegociacao (integer) . dataNegociacao (string) . simularInclusao (boolean) . produtos (array) } (object) required |
| post_v1_funcionarios_admissao | Este endpoint permite o registro de uma nova requisição de admissão, incluindo informações detalhadas sobre o trabalhador, seu cargo, categoria, dados contratuais e cadastrais. | data: { . nome (string) . cpf (string) . estadoCivil (integer) . possuiFilhos (boolean) . identidadeGenero (string) . nivelEscolaridade (integer) . nomeSocial (string) . orientacaoSexual (string) . sexo (string) . racaEtnia (integer) . observacaoDeficiencia (string) . urlFotoPerfil (string) . anexoCpf (object) . anexoAdmissao (object) . nascimento (object) . contato (object) . endereco (object) . contrato (object) . documentos (object) . trabalhadorEstrangeiro (object) . informacoesBancarias (object) . convenios (object) . observacao (string) . deficiencias (array) . dependentes (array) } (object) required |
| get_v1_funcionarios_admissao_by_codigo_requisicao_admissao | Este endpoint permite buscar os detalhes de uma requisição de admissão existente. | codigoRequisicaoAdmissao (integer) |
| post_v1_fiscal_servicos_tomados_nfse | Disponível a partir da versão 4.32 do SankhyaOm, a API de Importação de Notas Fiscais de Serviços Tomados foi projetada para simplificar e automatizar o processo de importação de notas fiscais emitidas por fornecedores. Essa integração permite que empresas importem de forma eficiente e segura os dados fiscais diretamente para seus sistemas de gestão, eliminando a necessidade de inserção manual e reduzindo erros humanos. - Benefícios de utilizar a API estão na eficiência operacional, redução de e | data: { . notaModelo (integer) . prestador (object) . numeroNota (string) . numeroRPS (integer) . serieRPS (string) . dataEmissao (string) . horaEmissao (string) . valorTotalNota (number) . valorDescontoCondicionado (number) . valorDescontoIncondicionado (number) . valorDeducoes (number) . issRetido (boolean) . aliquotaiss (number) . valorIss (number) . ir (object) . inss (object) . pis (object) . cofins (object) . csll (object) . observacao (string) . codigoVerificacao (string) . servico (object) } (object) required |
| post_v1_vendas_pedidos | Inclui um Pedido de Venda no Sankhya Om, SEMPRE A CONFIRMAR. Os financeiros que serão enviados não serão registrados como baixados, e sim pendentes. Obs.: a API não preve configurações de parceiro, alíquotas de impostos, etc, os mesmos já devem estar previamente configurados. - Versão mínima requirida do Sankhya Om para utilizar essa API: 4.34 | data: { . notaModelo (integer) . data (string) . hora (string) . codigoVendedor (integer) . cliente (object) . observacao (string) . valorFrete (number) . valorSeguro (number) . valorOutros (number) . valorIcms (number) . valorFcp (number) . valorJuro (number) . valorTotal (number) . itens (array) . financeiros (array) } (object) required |
| put_v1_vendas_pedidos_by_codigo_pedido | A atualização de um Pedido de Venda já confirmado só é permitida se a TOP do pedido estiver configurada com a opção 'Permitir Alteração após Confirmar' ativada. Alem disto, na alteração de pedido, sempre enviar o itens e os financeiros. - Versão mínima requirida do Sankhya Om para utilizar essa API: 4.34 | codigoPedido (integer) data: { . data (string) . hora (string) . codigoVendedor (integer) . codigoCliente (integer) . observacao (string) . valorFrete (number) . valorSeguro (number) . valorOutros (number) . valorIcms (number) . valorCofins (number) . valorFcp (number) . valorJuro (number) . valorTotal (number) . itens (array) . financeiros (array) } (object) required |
| post_v1_vendas_pedidos_by_codigo_pedido_cancela | Cancela um Pedido de Venda disponível do Sankhya Om. Obs.: Pedidos faturados não serão cancelados. - Versão mínima requirida do Sankhya Om para utilizar essa API: 4.34 | codigoPedido (integer) data: { . motivo (string) } (object) required |
| get_v1_parceiros_clientes | Permite acessar a lista de clientes cadastrados no ERP. A resposta da API contém apenas os clientes ativos ou inativos que já foram cadastrados previamente no ERP. | pagina (integer) required dataHoraAlteracao (string) |
| post_v1_parceiros_clientes | Permite incluir um cliente no ERP. | data (undefined) required |
| post_v1_parceiros_clientes_by_codigo_cliente_contatos | Permite incluir um contato para um cliente já cadastrado. | codigoCliente (integer) data (undefined) required |
| put_v1_parceiros_clientes_by_codigo_cliente | Permite atualizar um cliente previamente cadastrado. | codigoCliente (integer) data (undefined) required |
| put_v1_parceiros_clientes_by_codigo_cliente_contatos_by_codigo_contato | Permite atualizar um contato de um cliente previamente cadastrado | codigoCliente (integer) codigoContato (integer) data (undefined) required |
| get_v1_estoque_produtos_by_codigo_produto | - Este serviço verifica apenas o estoque registrado no ERP Sankhya, sem considerar o estoque do WMS. - Ele leva em conta apenas o estoque próprio da empresa, ignorando produtos armazenados por terceiros ou produtos de terceiros armazenados na empresa. - Além disso, a API só retorna informações sobre produtos que tiveram movimentação de estoque entrada ou saída. Caso um produto tenha sido cadastrado, mas nunca tenha tido movimentação, ele não aparecerá na resposta da API, em vez de retornar um v | codigoProduto (integer) |
| get_v1_estoque_produtos | - Permite obter o estoque de vários produtos. - Este serviço verifica apenas os estoques registrado no ERP Sankhya, sem considerar os estoques do WMS. - Ele leva em conta apenas os estoques próprio da empresa, ignorando produtos armazenados por terceiros ou produtos de terceiros armazenados na empresa. - Além disso, a API só retorna informações sobre produtos que tiveram movimentação de estoque entrada ou saída. Caso produtos tenham sido cadastrados, mas nunca tenham tido movimentação, eles não | pagina (integer) required |
| post_v1_fiscal_impostos_calculo | Este endpoint calcula os impostos incidentes sobre uma operação de venda. Com base nos dados fornecidos, como empresa, cliente, produtos e despesas acessórias, a API retorna os valores calculados, incluindo base de cálculo, alíquotas e valores de impostos. É importante ressaltar que toda a parametrização tributária deve ser previamente configurada no SankhyaOm, pois o endpoint não realiza essa configuração, apenas aplica as regras já definidas no SankhyaOm. | data: { . notaModelo (integer) . codigoCliente (integer) . codigoEmpresa (integer) . codigoTipoOperacao (integer) . finalidadeOperacao (integer) . despesasAcessorias (object) . produtos (array) } (object) required |
| get_v1_naturezas | Retorna a lista de Naturezas, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_naturezas_by_codigo_natureza | Retorna uma Natureza específica com base no parâmetro enviado na requisição. | codigoNatureza (integer) |
| get_v1_centros_resultado | Retorna a lista de Centro de Resultado, com paginação, cadastradas no SankhyaOM. | page (integer) |
| get_v1_centros_resultado_by_codigo_centro_resultado | Retorna um Centro de Resultado específico com base no parâmetro enviado na requisição. | codigoCentroResultado (integer) |
| get_v1_projetos | Retorna a lista de Projetos, com paginação, cadastradas no SankhyaOM. | page (integer) |
| get_v1_projetos_by_codigo_projeto | Retorna um Projeto específico com base no parâmetro enviado na requisição. | codigoProjeto (integer) |
| get_v1_tipos_operacao | Retorna a lista de Tipos de Operação, com paginação, cadastradas no SankhyaOM. | tipoMovimento (integer) page (integer) modifiedSince (integer) |
| get_v1_tipos_operacao_by_codigo_tipo_operacao | Retorna um Tipo de Operação específico com base no parâmetro enviado na requisição. | codigoTipoOperacao (integer) |
| get_v1_financeiros_tipos_pagamento | Retorna a lista de Tipos de Pagamento Tipos de Títulos, com paginação, cadastradas no SankhyaOM. | subTipoPagamento (integer) page (integer) modifiedSince (integer) |
| get_v1_financeiros_tipos_pagamento_by_codigo_tipo_pagamento | Retorna um Tipo de Pagamento específico com base no parâmetro enviado na requisição. | codigoTipoPagamento (integer) |
| get_v1_financeiros_moedas | Retorna a lista de Moedas, com paginação, cadastradas no SankhyaOM. | page (integer) |
| get_v1_financeiros_moedas_by_codigo_moeda | Retorna uma Moeda específica com base no parâmetro enviado na requisição. | codigoMoeda (integer) |
| get_v1_financeiros_moedas_by_codigo_moeda_cotacoes | Retorna uma lista de cotações da moeda envidad no contexto, com paginação, cadastradas no SankhyaOM. | codigoMoeda (integer) dataCotacao (string) page (integer) modifiedSince (integer) |
| get_v1_financeiros_bandeiras_tef | Retorna a lista de Bandeiras TEF, com paginação, cadastradas no SankhyaOM. | page (integer) |
| get_v1_financeiros_redes_tef | Retorna a lista de Redes Adquirentes TEF, com paginação, cadastradas no SankhyaOM. | page (integer) |
| get_v1_financeiros_contas_bancaria | Retorna uma lista de Conta Bancária, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_financeiros_contas_bancaria_by_codigo_conta_bancaria | Retorna uma Conta Bancária específica com base no parâmetro enviado na requisição. | codigoContaBancaria (integer) |
| get_v1_financeiros_receitas | Endpoint GET /v1/financeiros/receitas - Fornece acesso aos dados financeiros de receitas cadastrados no SankhyaOM. | pagina (integer) required codigoEmpresa (integer) codigoParceiro (integer) statusFinanceiro (integer) tipoFinanceiro (integer) dataNegociacaoInicio (string) dataNegociacaoFinal (string) |
| post_v1_financeiros_receitas | Registra financeiro de receita | data (object) required |
| put_v1_financeiros_receitas_by_codigo_financeiro | Endpoint PUT /v1/financeiros/receitas/codigoFinanceiro - Atualiza os dados financeiros de receitas cadastrados no SankhyaOM. | codigoFinanceiro (integer) data (object) required |
| post_v1_financeiros_receitas_by_codigo_financeiro_baixa | Realiza baixa da Receitas | codigoFinanceiro (integer) data: { . dataBaixa (string) . valorBaixa (number) . valorJuro (number) . valorMulta (number) . valorDesconto (number) . observacao (string) } (object) required |
| get_v1_financeiros_despesas | Endpoint GET /v1/financeiros/despesas - Fornece acesso aos dados financeiros de despesas lançados no SankhyaOM. | pagina (integer) required codigoEmpresa (integer) codigoParceiro (integer) statusFinanceiro (integer) tipoFinanceiro (integer) dataNegociacaoInicio (string) dataNegociacaoFinal (string) |
| post_v1_financeiros_despesas | Registra financeiro de despesa | data (object) required |
| put_v1_financeiros_despesas_by_codigo_financeiro | Endpoint PUT /v1/financeiros/despesas/codigoFinanceiro - Atualiza os dados financeiros de despesas cadastrados no SankhyaOM. | codigoFinanceiro (integer) data (object) required |
| post_v1_financeiros_despesas_by_codigo_financeiro_baixa | Realiza baixa da Despesa | codigoFinanceiro (integer) data: { . dataBaixa (string) . valorBaixa (number) . valorJuro (number) . valorMulta (number) . valorDesconto (number) . observacao (string) } (object) required |
| get_v1_pessoal_cargos | Retorna uma lista de Cargos, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_pessoal_cargos_by_codigo_cargo | Retorna um Cargo específico com base no parâmetro enviado na requisição. | codigoCargo (integer) |
| get_v1_pessoal_funcoes | Retorna uma lista de Funções, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_pessoal_funcoes_by_codigo_funcao | Retorna uma Função específica com base no parâmetro enviado na requisição. | codigoFuncao (integer) |
| get_v1_pessoal_departamentos | Retorna uma lista de Departamentos, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_pessoal_departamentos_by_codigo_departamento | Retorna um Departamento específico com base no parâmetro enviado na requisição. | codigoDepartamento (integer) |
| get_v1_pessoal_locais_ponto | Retorna uma lista de Locais De Trabalho, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_pessoal_locais_ponto_by_codigo_local_ponto | Retorna um Local De Trabalho específico com base no parâmetro enviado na requisição. | codigoLocalPonto (integer) |
| get_v1_pessoal_historicos_ocorrencia | Retorna uma lista de Histórico de ocorrências, com paginação, cadastradas no SankhyaOM. | page (integer) modifiedSince (integer) |
| get_v1_pessoal_historicos_ocorrencia_by_codigo_historico_ocorrencia | Retorna um Histórico ocorrência específico com base no parâmetro enviado na requisição. | codigoHistoricoOcorrencia (integer) |
| get_v1_pessoal_funcionarios_by_codigo_funcionario_empresas_by_codigo_empresa_ocorrencias | Retorna uma lista de Registros de Ocorrência, com paginação, cadastradas no SankhyaOM. | codigoFuncionario (integer) codigoEmpresa (integer) page (integer) modifiedSince (integer) dataInicial (string) dataFinal (string) |
| get_v1_pessoal_ocorrencias | Retorna todos os registros de ocorrência. | No parameters |