SapiensSID

8/2/2019 SapiensSID

http://slidepdf.com/reader/full/sapienssid 1/91

Sapiens SID

Guia de ReferênciaSapiens SIDServiço Interativo Dinâmico

(C) SeniorJulho 2011

(C) Senior 1

8/2/2019 SapiensSID


Sapiens SID

ÍNDICE ANALÍTICO

1 GUIA DE REFERÊNCIA.............................................................................................................................................51.1 AUTENTICAR (LOGIN/REGISTRO).............................................................................................................51.2 EXECUTAR AÇÕES (SUBMETER REQUISIÇÕES)..........................................................................................51.3 AUTENTICAÇÃO EMBUTIDA........................................................................................................................51.4 EXECUTAR SID ATRAVÉS DE SERVIÇO MC.................................................................................................61.5 NOTAS DE IMPLEMENTAÇÃO......................................................................................................................6

2 AÇÕES SID............................................................................................................................................................72.1 AÇÕES UTILITÁRIAS..................................................................................................................................7

2.1.1 Alterar empresa/filial (usuário ativo)................................................................................................72.1.2 Executar regra interna (regras LSP).................................................................................................72.1.3 IMPRIMIR RELATÓRIO (Imprimir ou gerar imagens)............................................................................72.1.4 IMPRIMIR BLOQUETOS (Imprimir, gerar imagens e gerar PDF).............................................................82.1.5 IMPRIMIR NOTAS FISCAIS DE SAÍDA................................................................................................82.1.6 OBTER INFORMAÇÕES DA CONEXÃO ATUAL (Uso interno)...................................................................82.1.7 ENCERRAR CONEXÃO ATUAL (Somente se invocado via HTTP)..............................................................9

2.2 MERCADO – PEDIDO DE VENDAS...............................................................................................................92.2.1 GRAVAR CABECALHO PEDIDO (Incluir/alterar)...................................................................................92.2.2 GRAVAR CABECALHO PEDIDO PREVISÃO (Incluir/alterar)....................................................................92.2.3 GRAVAR ITEM DE PRODUTO (Incluir/alterar)....................................................................................102.2.4 GRAVAR ITEM DE PRODUTO PREVISÃO (Incluir/alterar).....................................................................112.2.5 GRAVAR ITEM DE SERVIÇO (Incluir/alterar).....................................................................................112.2.6 FECHAR PEDIDO..........................................................................................................................12

2.2.7 FECHAR PEDIDO PREVISÃO...........................................................................................................122.2.8 EXCLUIR PEDIDO.........................................................................................................................122.2.9 EXCLUIR PEDIDO PREVISÃO..........................................................................................................122.2.10 EXCLUIR ITEM DE PRODUTO........................................................................................................122.2.11 Excluir item de PRODUTO PREVISÃO.............................................................................................132.2.12 Excluir item de serviço................................................................................................................132.2.13 GRAVAR OBSERVAÇÃO (Incluir/alterar).........................................................................................132.2.14 EXCLUIR OBSERVAÇÃO...............................................................................................................132.2.15 LISTAR EMBALAGENS DO PEDIDO................................................................................................132.2.16 CONFIRMAR CONFERÊNCIA DA EMBALAGEM..................................................................................142.2.17 SUBSTITUIR EMBALAGEM............................................................................................................142.2.18 ANALISAR ESTOQUE DE EMBALAGENS..........................................................................................142.2.19 ANALISAR OBSERVAÇÃO DE BLOQUEIO POR ÁREA..........................................................................152.2.20 GRAVAR PEDIDO VIA CONTRATO DE LICITAÇÃO.............................................................................152.2.21 GRAVAR PEDIDO EM GRADE........................................................................................................18

2.2.22 CANCELAR PEDIDO....................................................................................................................252.3 SUPRIMENTOS – COTAÇÕES.....................................................................................................................252.3.1 GRAVAR COTAÇÃO.......................................................................................................................25

2.4 MERCADO – NOTA FISCAL VENDA............................................................................................................262.4.1 GRAVAR CABEÇALHO DA NOTA FISCAL VENDA (Incluir).....................................................................262.4.2 FECHAR NOTA FISCAL VENDA........................................................................................................262.4.3 CANCELAR NOTA FISCAL VENDA....................................................................................................272.4.4 RECALCULAR PARCELAS (Baseado na cond. pgto.)............................................................................272.4.5 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL VENDA (Incluir)...........................................................272.4.6 GRAVAR ITEM DE SERVIÇO NA NOTA FISCAL VENDA (Incluir)............................................................282.4.7 CANCELAR FATURA......................................................................................................................292.4.8 LISTAR EMBALAGENS DA NFV PARA CONTROLE DE EMBARQUE..........................................................292.4.9 COMPOR O DOCUMENTO DE EMBARQUE COM A NFV.........................................................................292.4.10 2.4.10 ATUALIZAÇÃO DA SITUAÇÃO DA NFV ELETRÔNICA...............................................................302.4.11 ATUALIZAÇÃO DA SITUAÇÃO DO CT ELETRÔNICO...........................................................................31

2.4.12 ATUALIZAÇÃO DA SITUAÇÃO DA NFS ELETRÔNICA.........................................................................312.4.13 FECHAR CONTROLE DE EMBARQUE...............................................................................................322.4 SUPRIMENTOS – NOTA FISCAL COMPRA.................................................................................................32

2.4.14 GRAVAR CABEÇALHO DA NOTA FISCAL COMPRA (Incluir).................................................................322.4.15 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL COMPRA (Incluir)........................................................332.4.16 GRAVAR ITEM DE SERVIÇO NA NOTA FISCAL COMPRA (Incluir).........................................................352.4.17 GRAVAR PARCELAS MANUAIS NA NOTA FISCAL DE COMPRA.............................................................372.4.18 FECHAR NOTA FISCAL COMPRA....................................................................................................372.4.19 CANCELAR NOTA FISCAL COMPRA................................................................................................382.4.20 GERAR NOTA FISCAL VIA ORDEM DE COMPRA................................................................................382.4.21 GRAVAR RATEIO PARA ITEM DE PRODUTO.....................................................................................382.4.22 GRAVAR RATEIO PARA ITEM DE SERVIÇO......................................................................................39

2.5 SUPRIMENTOS – ORDEM DE COMPRA......................................................................................................392.4.23 GRAVAR CABEÇALHO ORDEM DE COMPRA.....................................................................................392.4.24 EXCLUIR ORDEM DE COMPRA......................................................................................................402.4.25 GRAVAR ITEM DE PRODUTO NA ORDEM DE COMPRA.......................................................................402.4.26 GRAVAR ITEM DE SERVIÇO NA ORDEM DE COMPRA........................................................................402.4.27 FECHAR ORDEM DE COMPRA.......................................................................................................412.4.28 GERAR ORDEM DE COMPRA VIA COTAÇÃO.....................................................................................41

2.5 SUPRIMENTOS – ESTOQUES.....................................................................................................................412.5.1 GERAR REQUISIÇÃO....................................................................................................................41

(C) Senior 2

8/2/2019 SapiensSID


Sapiens SID

2.5.2 ATENDER REQUISIÇÃO.................................................................................................................422.5.3 EXCLUIR REQUISIÇÃO..................................................................................................................422.5.4 GRAVAR RATEIO REQUISIÇÃO.......................................................................................................422.5.5 MOVIMENTAR ESTOQUE...............................................................................................................432.5.6 EXCLUIR MOVIMENTO DE ESTOQUE...............................................................................................432.5.7 LISTAR ITENS DA EMBALAGEM......................................................................................................432.5.8 CONFIRMAR CONFERÊNCIA DA EMBALAGEM....................................................................................442.5.9 GRAVAR SOLICITAÇÃO DE COMPRA (Incluir/alterar).........................................................................442.5.10 EXCLUIR SOLICITAÇÃO DE COMPRA.............................................................................................45

2.5.11 BUSCAR ESTOQUE DISPONÍVEL...................................................................................................452.5.12 BUSCAR PREÇO MÉDIO...............................................................................................................452.5.13 BUSCAR ESTOQUE GRADE...........................................................................................................452.5.14 ESTOQUE PAF/ECF (VAREJO).......................................................................................................47

2.6 MERCADO – NOTA FISCAL TRANSFERÊNCIA............................................................................................472.6.1 Marcar embalagem/produto para transferência.................................................................................472.6.2 BUSCAR ITENS DA NOTA FISCAL DE TRANSFERÊNCIA.......................................................................482.6.3 CONFIRMAR CONFERÊNCIA DOS ITENS DA NFT................................................................................48

2.7 MERCADO – PRÉ-FATURAS.......................................................................................................................492.7.1 CRIAR EMBALAGEM PARA PRÉ-FATURA...........................................................................................492.7.2 INCLUIR OS CONTEÚDOS DAS EMBALAGEM DA PRÉ-FATURA..............................................................492.7.3 EXCLUIR EMBALAGEM DA PRÉ-FATURA...........................................................................................49

2.8 CADASTROS – CLIENTES..........................................................................................................................502.8.1 GRAVAR CLIENTE (Incluir/alterar)..................................................................................................502.8.2 GRAVAR DEFINIÇÕES DO CLIENTE (Incluir/alterar)...........................................................................51

2.8.3 EXCLUIR CLIENTE........................................................................................................................522.8.4 EXCLUIR DEFINIÇÕES DO CLIENTE.................................................................................................522.8.5 GRAVAR DADOS PESSOA JURÍDICA (Incluir/alterar)..........................................................................522.8.6 EXCLUIR DADOS PESSOA JURÍDICA...............................................................................................532.8.7 GRAVAR DADOS PESSOA FÍSICA (Incluir/alterar).............................................................................532.8.8 EXCLUIR DADOS PESSOA FÍSICA...................................................................................................542.8.9 GRAVAR CONTATO DO CLIENTE (Incluir/alterar)...............................................................................542.8.10 EXCLUIR CONTATO DO CLIENTE...................................................................................................552.8.11 GRAVAR ENDEREÇO DE ENTREGA.................................................................................................552.8.12 EXCLUIR ENDEREÇO DE ENTREGA................................................................................................552.8.13 GRAVAR ENDEREÇO DE COBRANÇA..............................................................................................562.8.14 EXCLUIR ENDEREÇO DE COBRANÇA..............................................................................................56

2.9 CADASTROS – REPRESENTANTES.............................................................................................................562.9.1 GRAVAR REPRESENTANTE (Incluir/alterar).......................................................................................562.9.2 GRAVAR DEFINIÇÕES DO REPRESENTANTE (Incluir/alterar)...............................................................572.9.3 EXCLUIR REPRESENTANTE............................................................................................................582.9.4 EXCLUIR DEFINIÇÕES DO REPRESENTANTE.....................................................................................58

2.10 CADASTROS – FORNECEDORES..............................................................................................................582.10.1 GRAVAR FORNECEDOR (Incluir/alterar).........................................................................................582.10.2 GRAVAR DEFINIÇÕES DO FORNECEDOR (Incluir/alterar)..................................................................592.10.3 EXCLUIR FORNECEDOR...............................................................................................................602.10.4 EXCLUIR DEFINIÇÕES DO FORNECEDOR.......................................................................................60

2.11 CADASTROS – PRODUTOS......................................................................................................................602.11.1 GRAVAR PRODUTO (Incluir/alterar)...............................................................................................602.11.2 EXCLUIR PRODUTO....................................................................................................................602.11.3 GRAVAR DERIVAÇÃO (Incluir/alterar)............................................................................................612.11.4 EXCLUIR DERIVAÇÃO.................................................................................................................61

2.12 FINANÇAS – CONTAS A RECEBER...........................................................................................................612.12.1 GRAVAR TÍTULO CR....................................................................................................................612.12.2 BAIXAR TÍTULO CR....................................................................................................................622.12.3 GRAVAR RATEIO TÍTULO CR........................................................................................................63

2.12.4 EXCLUIR TÍTULO CR...................................................................................................................632.12.5 EXCLUIR BAIXA CR.....................................................................................................................642.12.6 ALTERAR TÍTULO CR (Somente data de vencimento).......................................................................642.12.7 SELECIONAR TÍTULO CR.............................................................................................................642.12.8 PROCESSAR BAIXAS AUTOMÁTICAS..............................................................................................65

2.13 FINANÇAS – CONTAS A PAGAR ............................................................................................................652.13.1 GRAVAR TÍTULO CP....................................................................................................................652.13.2 BAIXAR TÍTULO CP.....................................................................................................................662.13.3 GRAVAR RATEIO TÍTULO CP........................................................................................................672.13.4 EXCLUIR TÍTULO CP...................................................................................................................672.13.5 EXCLUIR BAIXA CP.....................................................................................................................67

2.14 FINANÇAS – TESOURARIA ....................................................................................................................682.14.1 GRAVAR MOVIMENTO (Incluir/alterar)...........................................................................................682.14.2 GRAVAR RATEIO DO MOVIMENTO.................................................................................................682.14.3 PROCESSAR MOVIMENTO (CHEQUE).............................................................................................68

2.15 FINANÇAS – PROJETOS..........................................................................................................................692.15.1 GRAVAR LANÇAMENTO...............................................................................................................692.15.2 EXCLUIR LANÇAMENTO...............................................................................................................69

2.16 CONTROLADORIA – TRIBUTOS - REDUÇÃO Z.........................................................................................702.16.1 GRAVAR TOTALIZADORES DA REDUÇÃO Z.....................................................................................702.16.2 GRAVAR MOVIMENTOS DA REDUÇÃO Z.........................................................................................70

(C) Senior 3

8/2/2019 SapiensSID


Sapiens SID

2.16.3 GRAVAR RATEIOS DOS MOVIMENTOS DA REDUÇÃO Z.....................................................................712.16.4 GRAVAR ITENS DA REDUÇÃO Z....................................................................................................71

2.17 CONTROLADORIA – TRIBUTOS – NOTA FISCAL COMPRA......................................................................722.17.1 GRAVAR DADOS GERAIS (Incluir/alterar).......................................................................................722.17.2 GRAVAR RATEIOS DOS DADOS GERAIS.........................................................................................732.17.3 GRAVAR ITEM (Incluir/alterar).....................................................................................................742.17.4 EXCLUIR ITEM...........................................................................................................................762.17.5 GRAVAR PARCELA COMPRA (Incluir/alterar)...................................................................................762.17.6 EXCLUIR PARCELA COMPRA.........................................................................................................76

2.17.7 GRAVAR ENTRADA, VENCIMENTO, LOTE E SÉRIE (Incluir/alterar)......................................................762.17.8 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SÉRIE ...........................................................................772.17.9 GRAVAR LIGAÇÃO ENTRE ITENS (Incluir/alterar)............................................................................772.17.10 EXCLUIR LIGAÇÃO ENTRE ITENS................................................................................................77

2.18 CONTROLADORIA – TRIBUTOS – NOTA FISCAL VENDA.........................................................................772.18.1 GRAVAR DADOS GERAIS (Incluir/alterar).......................................................................................772.18.2 GRAVAR RATEIOS DOS DADOS GERAIS.........................................................................................792.18.3 GRAVAR ITEM (Incluir/alterar).....................................................................................................802.18.4 EXCLUIR ITEM...........................................................................................................................812.18.5 GRAVAR CONHECIMENTO DE TRANSPORTE (Incluir/alterar)..............................................................822.18.6 EXCLUIR CONHECIMENTO DE TRANSPORTE...................................................................................822.18.7 GRAVAR PARCELAS DE VENDA (Incluir/alterar)...............................................................................822.18.8 EXCLUIR PARCELAS DE VENDA....................................................................................................822.18.9 GRAVAR ENTRADA, VENCIMENTO, LOTE E SÉRIE (Incluir/alterar)......................................................832.18.10 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SÉRIE .........................................................................83

2.18.11 GRAVAR LIGAÇÃO ENTRE ITENS (Incluir/alterar)...........................................................................832.18.12 EXCLUIR LIGAÇÃO ENTRE ITENS ...............................................................................................832.18.13 GRAVAR INFORMACOES DOCUMENTO ELETRÔNICO (Incluir/Alterar) ...............................................842.18.14 EXCLUIR INFORMACOES DOCUMENTO ELETRÔNICO .....................................................................84

2.19 CONTROLADORIA – TRIBUTOS – INVENTÁRIO DE ESTOQUES..............................................................842.19.1 GRAVAR SALDOS FÍSICOS MENSAIS (Incluir/alterar).......................................................................842.19.2 GRAVAR SALDOS CONSIGNADOS (Incluir/alterar)...........................................................................85

2.20 CONTROLADORIA – CONTABILIDADE ...................................................................................................852.20.1 GERAR LOTE CONTÁBIL..............................................................................................................852.20.2 EXCLUIR LOTE CONTÁBIL............................................................................................................852.20.3 GERAR LANÇAMENTO.................................................................................................................852.20.4 INTEGRAÇÃO CONTÁBIL.............................................................................................................86

2.21 CONTROLADORIA – PATRIMÔNIO .........................................................................................................872.21.1 MOVIMENTAR BEM.....................................................................................................................872.21.2 BUSCAR DEPRECIAÇÃO DO BEM...................................................................................................87

2.22 MANUFATURA – ORDEM DE PRODUÇÃO.................................................................................................882.22.1 APONTAR ORDENS DE PRODUÇÃO................................................................................................882.22.2 REMETER/RETORNAR SERVIÇO DE TERCEIROS...............................................................................882.22.3 BAIXAR COMPONENTES DA O.P./O.S.............................................................................................88

2.23 INTEGRAÇÕES – CARTÃO PRESENTE......................................................................................................892.23.1 GRAVAR CARTÃO PRESENTE........................................................................................................892.23.2 CONSULTAR CARTÃO PRESENTE...................................................................................................892.23.3 CONSUMIR CARTÃO PRESENTE....................................................................................................89

3 SIDXML...............................................................................................................................................................903.1 SINTAXE XML...........................................................................................................................................903.2 EXEMPLO..................................................................................................................................................90

(C) Senior 4

8/2/2019 SapiensSID


1 GUIA DE REFERÊNCIA

1.1 AUTENTICAR (LOGIN/REGISTRO)

O primeiro procedimento a ser efetuado é a autenticação da integração. Para tal, deve-se enviar uma ação de "login" ao SapiensServer para que o mesmo valide as permissões do usuário que irá interagir com a base Sapiens.

Sintaxe:http://<servidor>/<diretório_virtual>/conector.exe?

SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usuário>&SENUSU=<senha>

Onde:<servidor> Nome ou IP do servidor web.<diretório_virtual> Nome do diretório virtual.SIS=CO Parâmetro interno: obrigatório em todas as açõesLOGIN=SID Parâmetro interno: obrigatório em todas as ações<usuário> Nome do usuário do Sistema Sapiens.<senha> Senha do usuário do Sistema Sapiens.

Se a validação do usuário for efetivada, o retorno da requisição acima deverá ser um "código de conexão", que será repassadoposteriormente como parâmetro para validar e garantir a autenticidade das demais ações.

IMPORTANTE: Deve-se utilizar uma conta de usuário Sapiens exclusivamente para este fim.

Exemplo:http://servidor/sapiensweb/conector.exe?

SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=USUARIO&SENUSU=SENHA

Exemplo de retorno devolvido pelo Sapiens Server, caso login seja bem sucedido:38659379861527810

Exemplo de retorno devolvido pelo Sapiens Server, caso erro:ERRO: Usuário ou senha inválidoOu<html>Time-out error...</html>

1.2 EXECUTAR AÇÕES (SUBMETER REQUISIÇÕES)Nesta etapa, são enviadas as ações que interagem diretamente com a base do Sapiens. O código de conexão, retornado no login,deverá ser acrescido em todas estas ações enviadas ao Sapiens Server.

Sintaxe:http://<servidor>/<diretório_virtual>/conector.exe?

SIS=CO&LOGIN=SID&USER=<usuário>&CONNECTION=<código_de_conexão>&ACAO=<ação>&<parâmetro>=<valor>&...

Exemplo:http://servidor/sapiensweb/conector.exe?

SIS=CO&LOGIN=SID&USER=USUARIO&CONNECTION=38659379861527810&ACAO=SID.PED.GRAVAR&CODCLI=99

Neste exemplo, envia-se uma requisição ao Sapiens Server para que seja gerado um pedido (cabeçalho) na base Sapiens,

cujo código de cliente seja “99”. A ação SID.PED.GRAVAR retorna o número do pedido gerado (caso não ocorra erro).Parâmetro opcional:

AcceptEmptyField Indicase os campos passados sem valor ("CAMPO=") devem ser considerados ou não nas ações. Valores possíveis: "0" - não considera; "1"(padrão) - considera.

1.3 AUTENTICAÇÃO EMBUTIDA

É possível executar uma ação comum juntamente com a ação de autenticação EXESENHA. Este método facilita a implementação emelhora o desempenho. A forma de escrevê-la é semelhante à ação de login, acrescido do parâmetro "PROXACAO=<ação>" e mais osparâmetros da próxima ação. Recomenda-se utilizá-la apenas quando houver necessidade de executar ações isoladas.

Formato:http://<servidor>/<diretório_virtual>/conector.exe?

SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usuário>&SENUSU=<senha>&PROXACAO=<ação_a_executar_após_login>&<parâmetro>=<valor>&...

Exemplo:

8/2/2019 SapiensSID


http://servidor/sapiensweb/conector.exe?SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=USUARIO&SENUSU=SENHA&PROXACAO=SID.PED.GRAVAR&CODCLI=99

1.4 EXECUTAR SID ATRAVÉS DE SERVIÇO MC

Haverá cada vez mais incentivos para que os Web Services substituam o SID, pois são implementados sob uma arquitetura maisrobusta, segura e com melhor desempenho. No entanto, para suprir a variedade reduzida Web Services disponíveis, haverápossibilidade de invocar ações SID por meio de um deles.

O benefício, neste caso, é o fato do processamento ser totalmente local a não necessitar do ambiente "Sapiens Server" instalado. Noentanto, o serviço MC SID limita-se a processar apenas ações de "negócio" e dentro da empresa/filial ativa do usuário que executar aregra.

O exemplo abaixo demonstra a execução de uma ação SID através de serviço MC local. É necessário habilitar a opção “Utiliza serviços” em Recursos/Implementações/Serviços/Configurações.

@ Define o serviço e porta @definir interno.com.senior.g5.co.ger.sid.executar vAcaoSID;

@ Adiciona os parâmetros SID -- cada parâmetro em linha distinta @vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "ACAO=SID.TCR.BAIXAR";

vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "NUMTIT=TX003/A";

vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "CODTPT=DM";

vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "VLRMOV=7700";

vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "VCTORI=20/10/2005";

vAcaoSID.SID.CriarLinha();vAcaoSID.SID.Param = "NUMCCO=BCX C/C";

@ Executar ação @vAcaoSID.ModoExecucao = 1;vAcaoSID.Executar();

@ Processar resultado @definir alfa ValStr;ValStr = vAcaoSID.Resultado;

1.5 NOTAS DE IMPLEMENTAÇÃO

As notas abaixo enfatizam dicas e limitações importantes para a utilização do SID nas requisições HTTP:

a) Recomenda-se limpar o retorno das ações, ou seja, remover eventuais "CR+LF" e excesso de espaços.

b) Toda ação enviada sempre retorna alguma informação, seja ela, uma simples literal "OK" ou várias linhas de dados.

c) Algumas ações possuem um parâmetro opcional denominado "Delim". Sua função é determinar o caractere separador dos camposde retorno da ação. O valor padrão é ";" (ponto-e-vírgula).

d) O código de conexão perde a validade após a execução da ação de LOGOFF ou quando o tempo de ociosidade expira. Quando issoocorrer, é necessário um efetuar novo login.

e) Os valores de cada parâmetro devem ser sempre atribuídos diretamente sem caracteres tipo aspas, independente do tipo de dadoesperado pelo parâmetro (Exemplo: NOMCLI=SENIOR, CODCLI=33, DATATU=01/01/2003, VALDSC=199.50). Não deve serutilizado espaços antes ou depois do caractere "=" (Exemplo incorreto: CODCLI = 123 Exemplo correto: CODCLI=123).

f) Todas as operações serão realizadas sempre baseadas na empresa/filial ativa do usuário utilizado no login. Deve-se criar umusuário Sapiens exclusivo para o SID. Havendo necessidade de operar em múltiplas empresas/filial, deve-se criar e posicionar um

usuário distinto para cada uma delas.g) O separador decimal utilizado nos parâmetros numéricos deve ser o ponto ".".

8/2/2019 SapiensSID


h) É recomendável consistir o retorno de cada ação para certificar-se que a mesma foi executada com sucesso. Na maioria delas,basta verificar se o retorno é igual ao literal "OK". Já em outras (exemplo SID.PED.GRAVAR) é interessante verificar se o retorno éum número válido, ou seja, contendo apenas dígitos numéricos.

i) O servidor (Sapiens Server) gera sempre um histórico de ações recebidas e processadas por ele. Estes arquivos são gerados nodiretório de LOGs do sistema, com o nome: SAPIENSRV_DUMPLOG_<nnn>_<DATAHORA>.LOG.

j) IMPORTANTE: O tempo máximo de processamento de uma ação é cinco minutos (limite do IIS). Depois deste tempo, acomunicação é interrompida seguida de uma mensagem de time-out . Deve-se ficar atento à esta limitação, principalmente quandoutilizar o recurso SIDXML.

2 AÇÕES SIDSegue abaixo a relação das ações implementadas no Sapiens Server até a data de revisão deste documento.

2.1 AÇÕES UTILITÁRIASAções de uso genérico e utilitárias.

2.1.1 ALTERAR EMPRESA/FILIAL (USUÁRIO ATIVO)

Ação:SID.Srv.AltEmpFil

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filial

Retorno:"OK"

Observação:Esta ação deve ser utilizada com cautela, pois modifica a empresa/filial ativa do usuário utilizado na autenticação. Alterações

de empresa/filial no Sapiens podem conflitar com as ações SID, assim como ações concorrentes, caso estejam todos usando o mesmousuário. Recomenda-se criar e usar um usuário distinto para cada empresa/filial. Esta ação não deve ser utilizada em situações em quenão ocorre a autenticação do usuário (como no WebService de invocação SID).

2.1.2 EXECUTAR REGRA INTERNA (REGRAS LSP)

Ação:SID.Srv.Regra

Parâmetros obrigatórios:NumReg Número da regra

Parâmetros opcionais:Todo parâmetro adicional passado com algum valor, poderá ser utilizado internamente pela regra, bastando criar uma variável

de mesmo nome (definir alfa <parâmetro>)

Retorno:O retorno da regra deverá ser atribuído à variável alfa "ValStr".

2.1.3 IMPRIMIR RELATÓRIO (IMPRIMIR OU GERAR IMAGENS)

Ação:SID.Srv.ExeRel

Parâmetros obrigatóriosNome Nome do modelo (.ger)

Parâmetros opcionaisImpressora*² Nome ou compartilhamento da impressora, se desejar imprimir diretoFormato*³ Informar o valor "JPEG" ou "PDF"Qualidade Qualidade do JPEG (0-100 padrão 65)Dado_<Campo>... Nome do campo de entrada, definido no modelo* Acrescentar sempre o termo "Dado_" antes do nome do campo definido nos parâmetros de entrada do modelo*² Utilizar este parâmetro se desejar imprimir ao invés de apenas executar*³ Utilizar este parâmetro para gerar uma imagem JPEG ao inves de apenas executar

Retorno:<definido pelo modelo>Ou"OK" (caso seja informado o parâmetro "Impressora=...")Ou"<caminho do arquivo JPEG>" (caso seja informado o parâmetro "Formato=JPEG")

8/2/2019 SapiensSID


Ou"<caminho do arquivo PDF>" (caso seja informado o parâmetro "Formato= PDF")

2.1.4 IMPRIMIR BLOQUETOS (IMPRIMIR, GERAR IMAGENS E GERAR PDF)

Ação:SID.Srv.ExeBlo

Parâmetros obrigatórios

Nome Nome do modelo (.blo)Impressora Nome ou compartilhamento da impressora, caso desejar imprimir diretoNosNum* Nosso númeroCodPor Código do portadorCodCrt Código da carteira* Apenas quando requerido, se não informar, gravará “0” como último nosso número.

Parâmetros obrigatórios para bloquetos do comercialCodSnf Série da nota fiscalNumNfv Número da nota fiscal

Parâmetros obrigatórios para bloquetos do financeiroCodTpt Código do tipo de títuloNumTit Número do título

Parâmetros opcionaisWheCla Cláusula WHEREMens01 Texto da mensagem 1Mens02 Texto da mensagem 2Mens03 Texto da mensagem 3Mens04 Texto da mensagem 4Formato Informar valor "JPEG" ou “PDF” Qualidade Qualidade do JPEG (0-100 padrão 65)

Retorno:"OK" (caso seja informado o parâmetro "Impressora=...")Ou"<caminho>" (caso seja informado o parâmetro "Formato=JPEG")Ou"<caminho>" (caso seja informado o parâmetro "Formato=PDF")

2.1.5 IMPRIMIR NOTAS FISCAIS DE SAÍDA

Ação:SID.Srv.ExeNfs (RFNF)

Parâmetros obrigatórios:Nome Nome do modelo (.nfs)Impressora Nome ou compartilhamento da impressoraCodSnf Série da nota fiscal de saídaNumNfv Abrangência de números de notas fiscais de saída

Parâmetros opcionais:PreImp Número pré-impresso inicial

Retorno:"OK"

Observações:Esta ação respeita os formatos de saída e a lógica definida nos modelos, com exceção das definições de impressora

(selecionar impressora, impressora padrão, etc), por exemplo, se o objetivo é a "impressão para arquivo", isto deve ser definido nomodelo do relatório, pelo gerador de relatórios.

O modelo de nota fiscal de saída não pode estar configurado para pré-visualizar o relatório ou imprimir para vídeo, casocontrário a ação retornará um erro.

A impressora a ser usada (passada por parâmetro) deve obrigatoriamente estar instalada no servidor e ser do tipo texto.Importante ressaltar que, no SapiensWeb, o diretório padrão para geração dos arquivos de relatório definido no CFG (chave

REPORTS) é ignorado e é sempre usado o diretório temporário para este fim.

2.1.6 OBTER INFORMAÇÕES DA CONEXÃO ATUAL (USO INTERNO)

Ação:SID.Srv.Status

Retorno:Informações referentes à conexão ativa – uso interno

8/2/2019 SapiensSID


2.1.7 ENCERRAR CONEXÃO ATUAL (SOMENTE SE INVOCADO VIA HTTP)

Ação:LogOff

Retorno:"OK"

2.2 MERCADO – PEDIDO DE VENDAS

2.2.1 GRAVAR CABECALHO PEDIDO (INCLUIR/ALTERAR)

Ação:SID.Ped.Gravar (RVPE)

Parâmetros obrigatórios:CodCli Código do cliente

Parâmetros opcionais:NumPed Número do pedidoTipPed Tipo do pedidoTnsPro Transação para produtosTnsSer Transação para serviços

DatEmi Data da emissãoDatPrv Data de previsão do pedidoObsPed Observação do pedidoSeqEnt Seqüência do endereço de entrega do clienteSeqCob Seqüência do endereço de cobrança do clienteSeqCto Seqüência do contato do clientePedCli Número do pedido no clienteCodCpg Código da condição de pagamentoCodFpg Código da forma de pagamentoSitPed Situação do pedidoCodRep Código do representanteCodVen Código do vendedorCodTra Código da transportadoraCodRed Código da transportadora de redespachoCodRoe Código da rota de entrega

SeqRoe Seqüência do cliente na rotaCodPor Código do portadorCodCrt Código da carteiraVlrFre Valor de frete do pedidoPerFre Percentual de frete do pedidoCifFob Indicativo se o frete é CIF (C) ou FOB (F)QtdAbe Quantidade em abertoPerOf1 Percentual de oferta 1 para o pedidoPerOf2 Percentual de oferta 2 para o pedidoPerDs1 Percentual de desconto 1 do clientePerDs2 Percentual de desconto 2 do clientePerDs3 Percentual de desconto 3 do clientePerDs4 Percentual de desconto 4 do clientePedBlo Indicativo de pedido bloqueadoAcePar Indicativo se o pedido aceita faturamento parcialVlrDar Valor de Arredondamento (em caso de desconto esse valor deve ser negativo)PlaVei Placa do VeículoCodMoe Código da moeda/índice que o preço unitário está representadoCodMcp Moeda ou índice para correção do preço unitárioVlrEmb Valor das embalagens para o pedidoVlrFrd Valor frete destacadoVlrEnc Valor dos encargos para o pedidoVlrOud Valor outras despesas destacadoVlrOut Valor das outras despesas para o pedidoVlrSeg Valor do seguro para o pedido

Retorno:<NumPed> Número do pedido gerado

Observação:Esta ação aceita campos de usuário.

2.2.2 GRAVAR CABECALHO PEDIDO PREVISÃO (INCLUIR/ALTERAR)

Ação:SID.Ped.GravarPrevisao (RVPE)

8/2/2019 SapiensSID


Parâmetros opcionais:NumPed Número do pedidoDatEmi Data da emissãoDatPrv Data de previsão do pedidoSitPed Situação do pedidoCodPvp* Código do período de produção e venda* O campo codpvp não existe fisicamente na tabela de pedidos, mas é usado no cabeçalho da função apenas para atribuir a data final do

período à data de previsão do pedido

Retorno:<NumPed> Número do pedido gerado


2.2.3 GRAVAR ITEM DE PRODUTO (INCLUIR/ALTERAR)

Ação:SID.Ped.GravarProduto (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqIpd Seqüência – informar somente para alteraçãoCodPro Código do produto

CodDer Código da derivaçãoQtdPed Quantidade do produtoCodTpr* Código da tabela de preçoPreUni* Preço unitário* Utilizar CodTpr ou PreUni

Parâmetros opcionais:TnsPro Transação para produtosUniVen*³ Unidade de medida de vendaQtdVen*³ Quantidade de medida de vendaPreVen*³ Preço de vendaPedCli Número do pedido no clienteSeqPcl Seqüência do pedido no clienteCplIpd Complemento da descrição do produtoCodDep Código do depósitoCodLot Número do lote

QtdCan Quantidade canceladaDatEnt Data da entregaPerOfe Percentual de ofertaPerDsc Percentual de descontoPerCom Percentual de comissãoSitIpd Situação do itemResEst Reserva estoque (S=sim, N=não)IdxGrd Indexador da GradeCodFxa Código da faixa da gradeCodCcu Código do centro de custoCtaRed Código da conta contábil reduzidaPerIpi Percentual de IPIPerIcm Percentual de ICMSPerIrf Percentual de IRRFPerCff Percentual de COFINS

PerPif Percentual de PISPerCrt Percentual de COFINS RetidoPerPit Percentual de PIS RetidoPerCsl Percentual de CSLL RetidoCtaFin(n)* Conta financeiraCtaRed(n)* Conta contábil reduzidaCodCcu(n)* Código do centro de custoPerCta(n)* Percentual do rateio da conta*²VlrCta(n)* Valor do rateio da conta*²PerRat(n)* Percentual do rateio*²VlrRat(n)* Valor do rateio*²VlrDsc Valor do descontoNumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projetoObsRat(n)* Observação do rateio

* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.*² Informar apenas o percentual ou valor.*³ Utilizar estes campos para entrar com uma unidade de medida diferente da padrão – não informar QtdPed, PreUni.

Retorno:<SeqIpd> Seqüência do item

8/2/2019 SapiensSID



2.2.4 GRAVAR ITEM DE PRODUTO PREVISÃO (INCLUIR/ALTERAR)

Ação:SID.Ped.GravarProdutoPrevisao (RVPE)

Parâmetros obrigatórios:NumPed Número do pedido

SeqIpd Seqüência – informar somente para alteraçãoCodPro Código do produtoCodDer Código da derivaçãoQtdPed Quantidade do produto

Parâmetros opcionais:TnsPro Transação para produtosUniVen* Unidade de medida de vendaQtdVen* Quantidade de medida de vendaPedCli Número do pedido no clienteSeqPcl Seqüência do pedido no clienteCplIpd Complemento da descrição do produtoCodDep Código do depósitoQtdCan Quantidade canceladaDatEnt*² Data da entrega

CodPvp*³ Código do período de produção e vendaSitIpd Situação do item* Utilizar estes campos para entrar com uma unidade de medida diferente da padrão – não informar QtdPed.*² Informando valor para esse campo, será sobreposta qualquer sugestão feita com base nos dados gerais do pedido ou a partir do código do

período de produção e venda.*³ Ao informar o campo CodPvp o sitema faz automaticamente a busca da data final do período e atribui esta ao item de produto.

Retorno:<SeqIpd> Seqüência do item


2.2.5 GRAVAR ITEM DE SERVIÇO (INCLUIR/ALTERAR)

Ação:SID.Ped.GravarServico (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqIsp Seqüência – informar somente para alteraçãoCodSer Código do serviçoQtdPed Quantidade do serviçoCodTpr* Código da tabela de preçoPreUni* Preço unitário* Utilizar CodTpr ou PreUni

Parâmetros opcionais:TnsSer Transação para serviçosPedCli Número do pedido no clienteSeqPcl Seqüência do pedido no cliente

CplIsp Complemento da descrição do serviçoQtdCan Quantidade canceladaDatEnt Data da entregaPerDsc Percentual de descontoPerCom Percentual de comissãoSitIsp Situação do itemCodCcu Código do centro de custoCtaRed Código da conta contábil reduzidaPerIpi Percentual de IPIPerIcm Percentual de ICMSPerIss Percentual de ISSPerIns Percentual de INSSPerIrf Percentual de IRRFPerCff Percentual de COFINSPerPif Percentual de PIS

PerCrt Percentual de COFINS RetidoPerPit Percentual de PIS RetidoPerCsl Percentual de CSLL RetidoCtaFin(n)* Conta financeira**CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custo

8/2/2019 SapiensSID


PerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***PerRat(n)* Percentual do rateio***VlrRat(n)* Valor do rateio***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projetoObsRat(n)* Observação do rateio* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Depende da parametrização.*** Informar apenas o percentual ou valor.

Retorno:<SeqIsp> Seqüência do item


2.2.6 FECHAR PEDIDO

Ação:SID.Ped.Fechar (RVPE)


Parâmetros opcionais:RecPed Recalcular o pedido (0=Não*, 1=Sim-buscando valores, 2=Sim-sem buscar valores)* Valor padrão

Retorno:"OK"

2.2.7 FECHAR PEDIDO PREVISÃO

Ação:SID.Ped.FecharPrevisao (RVPE)


Retorno:"OK"

2.2.8 EXCLUIR PEDIDO

Ação:SID.Ped.Excluir (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoPedCli Número do pedido do Cliente

Retorno:"OK"

Observações:Se o parâmetro NumPed for informado, não é necessário informar o PedCli, e vice-versa.

2.2.9 EXCLUIR PEDIDO PREVISÃO

Ação:SID.Ped.ExcluirPrevisao (RVPE)


Retorno:"OK"

2.2.10 EXCLUIR ITEM DE PRODUTO

Ação:SID.Ped.ExcluirProduto (RVPE)


8/2/2019 SapiensSID


SeqIpd Seqüência do item de produto do pedidoPedCli Número do Pedido do cliente

Retorno:"OK"


2.2.11 EXCLUIR ITEM DE PRODUTO PREVISÃO

Ação:SID.Ped.ExcluirProdutoPrevisao (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqIpd Seqüência do item de produto do pedido

Retorno:"OK"

2.2.12 EXCLUIR ITEM DE SERVIÇO

Ação:SID.Ped.ExcluirServico (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqIsp Seqüência do item de serviço do pedidoPedCli Número do Pedido do cliente

Retorno:"OK"


2.2.13 GRAVAR OBSERVAÇÃO (INCLUIR/ALTERAR)

Ação:SID.Ped.GravarObservacao (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoObsPed Texto da observação do pedidoSitObs Situação da observação

Parâmetros opcionais:SeqObs Seqüência da observação do pedidoSeqIpd Seqüência do item de produto do pedido que gerou a observaçãoSeqIsp Seqüência do item de serviço do pedido que gerou a observaçãoCodMot Código do motivo da observaçãoSolObs Solução dada a observação

Retorno:

<SeqObs> Seqüência da observação do pedido


2.2.14 EXCLUIR OBSERVAÇÃO

Ação:SID.Ped.ExcluirObservacao (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqObs Seqüência da observação do pedido

Retorno:

"OK"

2.2.15 LISTAR EMBALAGENS DO PEDIDO

Ação:

8/2/2019 SapiensSID


SID.Ped.ListarEmbalagens (RVPE)


Parâmetros opcionais:CodEmp Código da empresaCodFil Código da filial

Retorno:

Xml contendo as embalagens do pedido, conforme exemplo:<?xml version="1.0"?><pedido>

<codemp>1</codemp><codfil>1</codfil><numped>25</numped><embalagens>

<embalagem><seqemb>1</seqemb><numemb>23</numemb>

</embalagem><embalagem>

<seqemb>2</seqemb><numemb>25</numemb>

</embalagem></embalagens>

</pedido>

2.2.16 CONFIRMAR CONFERÊNCIA DA EMBALAGEM

Ação:SID.Ped.ConfirmarConferEmb (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoSeqEmb* Seqüência de embalagemNumEmb* Número da embalagem

* Pelo menos um desses campos deve ser informado, sendo os demais ignorados.


Retorno:"OK"

2.2.17 SUBSTITUIR EMBALAGEM

Ação:SID.Ped.SubstituirEmb (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoEmbOri Número da embalagem original

EmbSub Número da embalagem substitutaParâmetros opcionais:CodEmp Código da empresaCodFil Código da filial

Retorno:"OK"

2.2.18 ANALISAR ESTOQUE DE EMBALAGENS

Ação:SID.Ped.AnalisarEstoqueEmb (RVPE)

Parâmetros opcionais:

AbrPed Abrangência de número de pedidosCodEmp Código da empresaCodFil Código da filialDatEmi Data de emissão inicialDatEmf Data de emissão finalDatEni Data de entrega inicial

8/2/2019 SapiensSID


DatEnf Data de entrega finalAceBlo Aceita Pedido Bloqueado (“S” ou “N” (padrão da rotina))

Retorno:"OK"

2.2.19 ANALISAR OBSERVAÇÃO DE BLOQUEIO POR ÁREA

Ação:SID.Ped.AnalisarObsBloArea (RVPE)

Parâmetros obrigatórios:NumPed Número do pedido bloqueadoSeqObs Seqüência da observação de bloqueio a ser analisadaAreEmp Área da empresa da observação de bloqueioAprRpr Se aprova ("S") ou desaprova ("N") a observação de bloqueioObsSol Observação da solução da observação de bloqueio analisada


Retorno:"OK"

2.2.20 GRAVAR PEDIDO VIA CONTRATO DE LICITAÇÃOAçãoSID.Ped. GravarPedidoContrato (RVPE)

Parâmetros obrigatórios:XML Texto em formato SID XML, cuja definição da estrutura está a seguir

<pedidos><pedido><codcli></codcli><pedcli></pedcli><ctrcli></ctrcli><numemp></numemp><datent></datent>

<seqent></seqent>

<itens> <item><procli></procli>

<codpro></codpro>

<datent></datent><qtdped></qtdped><univen></univen><qtdven></qtdven><preven></preven></item>.. (demais itens)

.</itens></pedido>.. (demais pedidos).

</pedidos>

A descrição de cada delimitador e sua funcionalidade ou obrigatoriedade está a seguir

<pedidos></pedidos>Delimitadores da seqüência de pedidos a serem importados. Indicam que dentro dos mesmos existe uma seqüência de

pedidos a serem importados. Esses delimitadores são obrigatórios na estrutura.

<pedido></pedido>

Delimitadores de um pedido. Devem existir um para cada pedido, e dentro desses delimitadores devem estar os campos evalores de um pedido. Esses delimitadores são obrigatórios na estrutura. <codcli></codcli>Dentro desses delimitadores deve estar o código do cliente do pedido, que é obrigatório. Deve ser um cliente que esteja nos

cadastros de clientes de um contrato e ativo no contrato e no sistema.

8/2/2019 SapiensSID


<pedcli></pedcli>Delimitadores do código do número do pedido de cliente. É opcional, porém se no contrato ou nas definições do cliente for

exigido que deve ser informado o número do pedido do cliente, a importação desse pedido exigirá como consistência esse campo. Se omesmo não vier informado, a importação do pedido será cancelada, passando ao próximo pedido

<ctrcli></ctrcli>Delimitadores onde deve estar o número do contrato do cliente para o pedido. Este campo é opcional desde que nas definições

do cliente exista o código do contrato padrão para o cliente do pedido. Pode ser informado independentemente disto, inclusive umnúmero de contrato diferente do padrão. Se informado, o sistema irá consistir se o contrato existe, está ativo, e possui o cliente do

pedido informado nos seus clientes. Se não for informado e não houver um contrato padrão nas definições do cliente, ou ocorrer algumerro de consistência, a importação do pedido é cancelada e será passado ao próximo pedido.

<numemp></numemp>Delimitadores do número de empenho do contrato. Este campo é opcional, e não deve ser informado se o contrato não é

controlado por empenho. Se o contrato controlar por empenho e este campo não for informado, será gerado um erro de consistênciainformando que o contrato controla por empenho e o mesmo deve ser informado. Se o empenho informado for válido, o sistemaconsiste se o mesmo existe no contrato informado.

<datent></datent>Delimitadores onde entre eles deve estar a data de entrega do pedido. Este campo é opcional. Se não for informada, é

sugerida a data corrente para o pedido. O valor atribuído a este campo (seja informado ou a data corrente), será sugerido aos itens senão for informada data de entrega nos mesmos. A data de entrega é consistida com o período de inatividade do cliente do pedidoinformado no contrato e se for controlado por empenho, irá consistir contra a validade do empenho.

<seqent></seqent>Delimitador onde entre eles deve estar código do endereço de entrega do pedido. Este campo é opcional, mas se no cadastro

de filial vendas estiver definido que o pedido deve conter o endereço de entrega esse campo é obrigado a ser informado. <itens></itens>Delimitadores que indicam que dentro dos mesmos existe uma seqüência de itens do pedido a serem importados. Esses

delimitadores são obrigatórios na estrutura e devem estar dentro dos delimitadores <pedido></pedidos>. <item></item>Delimitador que indica a existência de um item de pedido a ser importado. Dentro desses delimitadores deve estar a

seqüência de campos e valores do item do pedido a importar. Esses delimitadores são obrigatórios na estrutura e devem ser internosaos delimitadores <itens></itens>.

Os delimitadores abaixo devem estar dentro dos delimitadores <item></item> e se referem aos campos dos itens do pedido.

<procli></procli>

Delimitadores onde deve estar o código do produto do cliente para o contrato atual. A funcionalidade dessse campo é emconjunto com a funcionalidade do campo código do produto, e documentada logo a seguir à documentação deste campo, logo abaixo.

<codpro></codpro>Delimitadores onde deve estar o código do produto do Sapiens para o contrato atual

Ao menos um dos códigos de produto acima deve ser informado. Também ambos podem ser informados ao mesmo tempo,mas a precedência ou o que ocorre em caso de erro é descrita a seguir:

• a) Se ambos forem informados, o sistema busca primeiramente o código do produto do cliente e o código associadoao produto Sapiens. Se este existir, o código do produto do Sapiens é ignorado. Se não existir o código do produtodo cliente, o sistema utiliza o código do produto do Sapiens. Se estiver correto é assumido o código do produtoSapiens e caso contrário o sistema gera um erro e interrompe a importação do pedido atual, passando ao próximopedido.

• b) Se apenas o código do produto do cliente for informado, e se este existir, é utilizado, sendo que o sistema busca ocódigo do produto do Sapiens associado. Caso contrário é gerado um erro e interrompida a importação do pedidoatual, passando ao próximo pedido.

• c) Se apenas o código do produto do Sapiens for informado, e se este existir, é utilizado. Caso contrário é gerado umerro e interrompida a importação do pedido atual, passando ao próximo.

<datent></datent>Delimitadores onde deve estar a data de entrega do item do pedido. O valor do campo é opcional, pois é sugerido por padrão

a data de entrega dos dados gerais do pedido. Porém está disponível para o caso em que seja necessário possuir itens com datas deentrega diferentes em um mesmo pedido, sobrescrevendo a sugestão dos dados gerais do pedido.

<qtdped></qtdped>Delimitadores da quantidade pedida do item. O valor nesse campo é obrigatório (deve ser igual a zero quando informa-se

valores para a unidade de medida de venda) e se não for informado é gerado um erro e interrompida a importação do pedido atual,

passando ao próximo pedido. O valor informado é consistido contra a quantidade mínima e máxima do item do contrato, e com o saldode quantidade desse item no contrato.

<univen></univen>Delimitadores da unidade de medida de venda do item. O valor nesse campo é opcional, no entanto, caso for informado, a

quantidade de venda e o preço de venda devem obrigatoriamente ser informados também.

8/2/2019 SapiensSID


<qtdven></qtdven>Delimitadores da quantidade de venda do item. O valor nesse campo é opcional, no entanto, deve ser informado caso uma

unidade de medida de venda seja informada para o item. O valor informado é consistido e a conversão para a unidade de estoque(quantidade pedida) é feita automaticamente pelo sistema. A quantidade pedida é então consistida contra a quantidade mínima emáxima do item do contrato, e com o saldo de quantidade desse item no contrato.

<preven></preven>Delimitadores do preço de venda do item. O valor nesse campo é opcional, no entanto, deve ser informado caso a unidade de

medida de venda seja informada para o item.

Retorno da ação

O retorno da ação é um texto também em formato XML, dentro dos delimitadores <retorno></retonro>. Dentro dessesdelimitadores é indicado o erro ou o sucesso na importação para cada pedido dentro da seqüência de pedidos, ordenadosnumericamente pela seqüência de entrada e iniciando em 1 (um) e envolvidos nos delimitadores <pedido ></pedido>. O número deordenação exibido no retorno não é o número de pedido no Sapiens.

O formato geral do retorno para um pedido é:

<retorno><pedido pedido= 'seqüência_do_pedido' [item='seqüência_do_item'] resultado='erro ou sucesso'>texto do

erroou número do pedido</pedido>

.

.

.(demais pedidos)

</retorno>

O formato do retorno para um determinado pedido com erro durante a importação é:

<pedido pedido= 'seqüência_do_pedido' [item='seqüência_do_item'] resultado='erro'>texto_do_erro</pedido>

onde

'seqüência_do_pedido' é o número de seqüência em que foi processado o pedido delimitado pelos delimitadores<pedido></pedido>

'seqüência_do_item' é o número de seqüência do item que está sendo processado dentro do pedido, caso o erro

tenha ocorrido em um item delimitado pelos delimitadores <itens></itens>. A seqüência do item é reiniciada para cadapedido. Se o erro for gerado pelos dados gerais ou outra consistência no fechamento do pedido e validação dos valorescontra o contrato, esse texto não é exibido.

'texto_do_erro' é a informação textual do erro ocorrido pela consistência ou pela verificação da estrutura docomando XML para um pedido.

O formato do retorno para um determinado pedido processado com sucesso é:

<pedido pedido= 'seqüência_do_pedido' resultado='sucesso'>numero pedido gerado = 'número_pedido_sapiens'</pedido>

onde

'seqüência_do_pedido' também é o número de seqüência em que foi processado o pedido delimitado pelos

delimitadores <pedido></pedido>

'número_pedido_sapiens' é o número do pedido gerado pelo Sapiens

O texto de retorno é plano e sem quebras de linha.

Documentações adicionais:

Dentro dos delimitadores <pedidos></pedidos> poderão ser informados vários pedidos e dentro de cada delimitador<itens></itens> devem ser informados os vários itens do pedido. A ação pode ser chamada individualmente para um pedido apenas,porém recomenda-se a utilização de vários pedidos dentro de uma única ação, que confere um desempenho melhor à importação.

A função irá processar pedido a pedido que estiver dentro dos delimitadores <pedidos></pedidos>. Caso ocorra um erro emum pedido, este pedido todo é descartado e a função segue processando o próximo pedido na seqüência. Ao final, será gerado o

retorno da função indicando, para cada pedido com sucesso gerado, o seu número e para cada pedido não processado, o errocorrespondente, na mesma seqüência que foi informada no documento XML.

A rotina possui o mesmo funcionamento da rotina da tela do Comercial\Vendas\Pedidos\Via Contrato de Licitação, gerandopedidos com procedência do tipo 8 e abatendo dos saldos de valor e quantidade dos itens do contrato padrão ou do informado, bemcomo do empenho em relação a valores ou quantidades, conforme os parâmetros do contrato. Os pedidos são gerados já fechados, ou

8/2/2019 SapiensSID


seja, não necessitam de conferência. A filial e empresa em que são gerados os pedidos são o da filial ativa no Sapiens Server e não épermitido indicar filial ou empresa na ação.

Em relação ao documento XML a ser enviado à ação, este deve ser plano, ou seja, sem quebras de linha e sem espaços entreos delimitadores. Os valores dentro dos delimitadores podem ter espaços entre os mesmos, desde que o valor não seja numérico.

Segue um exemplo de uma ação com um pedido e dois itens.

<pedidos><pedido>

<codcli>18</codcli><pedcli></pedcli><numemp>2222222222222222222</numemp><datent>07/12/2004</datent><ctrcli>16</ctrcli><itens>

<item><procli>GENE1</procli><codpro></codpro><datent></datent><qtdped>1</qtdped>

</item><item>

<procli>GENE2</procli><codpro></codpro><datent></datent><qtdped>2</qtdped>

</item><item>

<procli>GENE3</procli><codpro></codpro><datent></datent><qtdped>1</qtdped>

</item></itens>

</pedido></pedidos>

Exemplo de um retorno com erro e um com sucesso:

Com erro:

<retorno><pedido pedido='1' resultado='erro'>O valor disponível no item do contrato (500,00) é insuficientepara atender ao valor líquido do item 1 do pedido (14.701,50)</pedido></retorno>

Com sucesso:

<retorno><pedido pedido='2' resultado='sucesso'>numero pedido gerado = 12</pedido></retorno>

2.2.21 GRAVAR PEDIDO EM GRADE

Ação

SID.Ped. GravarPedidoGrade (RVPE)Parâmetros obrigatórios:SIDXML Texto em formato SID XML, cuja definição da estrutura está a seguir

<pedidos><pedido>

<TipPed></TipPed><CodRep></CodRep><CodCdi></CodCdi><CodMar></CodMar><CodCli></CodCli><TnsPro></TnsPro><CatCli></CatCli><CodCpg></CodCpg><CodLip></CodLip>

<CodTpr></CodTpr><DatPrv></DatPrv><PedCli></PedCli><SeqEnt></SeqEnt><SeqCob></SeqCob><SeqCto></SeqCto><CodVen></CodVen>

8/2/2019 SapiensSID


<CodTra></CodTra><CodRed></CodRed><CepFre></CepFre><CodFpg></CodFpg><itens>

<item><CodPro></CodPro><CodFam></CodFam><CodMod></CodMod><CodFxa></CodFxa><CodPgr></CodPgr>

<QtdGrd></QtdGrd><CodClc></CodClc><derivacoes>

<derivacao></derivacao><quantidade</quantidade><derivacao></derivacao><quantidade></quantidade>...

</derivacoes></item>

<item>...</item></itens><observacoes>

<observacao><obsped></obsped><codmot></codmot>

</observacao><observacao>

<obsped></obsped><codmot></codmot>

</observacao>....

</observacoes><campos_usuario>

<campo_usuario><nomcmp></nomcmp><vlrcmp></vlrcmp>

</campo_usuario><campo_usuario>

<nomcmp></nomcmp><vlrcmp></vlrcmp>

</campo_usuario>....

</campos_usuario ></pedido><pedido></pedido>

..

.

.<pedido>

<pedidos>

A descrição de cada delimitador e sua funcionalidade ou obrigatoriedade está a seguir

<pedidos></pedidos>

Delimitadores da seqüência de pedidos a serem importados. Indicam que dentro dos mesmos existe uma seqüência depedidos a serem importados. Esses delimitadores são obrigatórios na estrutura.

<pedido></pedido>

Delimitadores de um pedido. Devem existir um para cada pedido, e dentro desses delimitadores devem estar os campos evalores de um pedido. Esses delimitadores são obrigatórios na estrutura.

<tipped></tipped>

Dentro desses delimitadores deve estar o tipo do pedido. Opcional, sendo considerado o tipo 1 se não for informado o tipo.

8/2/2019 SapiensSID


<codrep></codrep>

Dentro desses delimitadores deve estar o código do representante do pedido, que é obrigatório.

<codcdi></codcdi>

Dentro desses delimitadores deve estar o código do canal de distribuição do pedido, que é opcional, sendo sugerido o canal dedistribuição padrão do representante se não for informado.

<codmar></codmar>

Dentro desses delimitadores deve estar o código da marca do pedido. O mesmo é opcional, sendo sugerido o do cliente se nãofor informado. Porém, se não existir no cliente a marca padrão, será exigido ao consistir o pedido.

<codcli></codcli>

Dentro desses delimitadores deve estar o código do cliente do pedido, que é obrigatório. Deve ser um cliente que esteja noscadastros de clientes, ligado a marca e ativo no contrato e no sistema.

<TnsPro></TnsPro>Esse campo tem como objetivo permitir informar uma transação para o pedido e seus itens diferente da transação padrão

existente nas configurações do sistema.

<catcli></catcli>

Delimitadores do código da categoria do cliente do pedido. É opcional, sendo sugerida a categoria do cliente se não forinformado.

<codcpg></codcpg>

Delimitadores onde deve estar o código da condição de pagamento do pedido. Este campo é opcional, desde que exista asugestão do campo no sistema, nas marcas, representantes ou no próprio cliente. Se não existir sugestão ou não for informado, o

mesmo é exigido na consistência do pedido.

<codlip></codlip>

Delimitadores onde deve estar o código da lista de preço do pedido. Este campo é opcional, desde que exista a sugestão docampo no sistema. Se não for informado ou não possuir sugestão, é exigido na consistência do pedido. Se informado, a regra deconsistência é a mesma da rotina de pedidos em grade do cliente servidor.

<codtpr></codtpr>

Delimitadores onde deve estar o código da tabela de preço do pedido. Este campo é opcional, desde que exista a sugestão docampo no sistema. Se não for informado ou não possuir sugestão, é exigido na consistência do pedido. Se informado valor nestecampo, a regra de consistência é a mesma da rotina de pedidos em grade do cliente servidor.

<datprv></datprv>

Delimitadores da data de entrega do pedido. Este campo é opcional. Se não for informada, é sugerida a data corrente para opedido. O valor atribuído a este campo (seja informado ou a data corrente) será sugerido aos itens se não for informada data de

entrega nos mesmos.<pedcli></pedcli>

Dentro desses delimitadores deve estar o código do pedido do cliente, que é opcional.

<seqent></seqent>

Dentro desses delimitadores deve estar o código da seqüência do endereço de entrega do cliente, que é opcional, a não serque seja exigido se o cliente possuir mais de um endereço de entrega.

<seqcob></seqcob>

Dentro desses delimitadores deve estar o código da seqüência do endereço de cobrança do cliente, que é opcional, a não serque seja exigido se o cliente possuir mais de um endereço de cobrança.

<seqcto></seqcto>

Dentro desses delimitadores deve estar o código da seqüência do código do contato do cliente, que é opcional.

<codven></codven>Dentro desses delimitadores deve estar o código do vendedor do pedido, que é opcional. Se não for informado, será utilizado o

código do vendedor nas definições do cliente.

<codtra></codtra>

Dentro desses delimitadores deve estar o código da transportadora do pedido, que é opcional. Se não for informado, seráutilizado o código da transportadora nas definições do cliente. Pode ser informado com vazio, sobrescrevendo a sugestão padrão.

<codred></codred>

Dentro desses delimitadores deve estar o código da transportadora de redespacho do pedido, que é opcional. Se não forinformado, será utilizada a sugestão do sistema para o redespacho. Pode ser informado com vazio, sobrescrevendo a sugestão padrão.

<cepfre></cepfre>

Dentro desses delimitadores deve estar o código do CEP de frete para o pedido, que é opcional. Se não for informado, seráutilizado a sugestão do sistema. Pode ser informado com vazio, sobrescrevendo a sugestão padrão.

<codfpg></codfpg>

Dentro desses delimitadores deve estar o código da forma de pagamento para o pedido, que é opcional. Se não for informado,pode ser exigido se no cadastro do usuário existir um parâmetro que obriga a informação desse campo.

<itens></itens>

8/2/2019 SapiensSID


Delimitadores que indicam que dentro dos mesmos existe uma seqüência de itens grade do pedido a serem importados. Essesdelimitadores são obrigatórios na estrutura e devem estar dentro dos delimitadores <pedido></pedidos>.

<item></item>

Delimitador que indica a existência de um item grade de pedido a ser importado. Dentro desses delimitadores deve estar aseqüência de campos e valores do item grade do pedido a importar. Esses delimitadores são obrigatórios na estrutura e devem serinternos aos delimitadores <itens></itens>.

Os delimitadores abaixo devem estar dentro dos delimitadores <item></item> e se referem aos campos dos itens do pedido.

<codpro></codpro>

Delimitadores onde deve estar o código do produto. Este campo é obrigatório, e pode ser um código de produto que nãoexiste. Se não existir, são exigidos o código da família e código do modelo no documento XML, pois sem os quais não é possível gerar ocódigo do novo produto. O novo produto será gerado dentro das condições do sistema, avaliando se a montagem e estrutura domesmo estão corretas.

<codfam></codfam>

Delimitadores onde deve estar o código da família do produto. Este campo é obrigatório apenas se o produto for um novoproduto (não existente no sistema). Pode ser informado mesmo que o produto seja já existente, pois não será considerado se oproduto já existir.

<codmod></codmod>

Delimitadores onde deve estar o código do modelo de produção ligado ao produto. Este campo é obrigatório apenas se oproduto for um novo produto (não existente no sistema). Pode ser informado mesmo que o produto seja já existente, pois não seráconsiderado se o produto já existir.

<codfxa></codfxa>Delimitadores onde deve estar o código da faixa do produto. Este campo é obrigatório.

<codpgr></codpgr>

Delimitadores onde deve estar o código da proporcionalidade da faixa do produto. Este campo não é obrigatório. Se forinformado, o sistema irá desconsiderar caso estejam sendo passadas derivações e quantidades logo abaixo dos delimitares<derivacoes></derivacoes> no item atual, e irá gerar o item com as derivações da proporcionalidade. Se não for passado, éobrigatória a passagem de valores dentro dos delimitadores <derivacoes></derivacoes>. Nesse caso o sistema irá avaliar asderivações corretamente e buscar ou gerar uma nova proporcionalidade conforme as derivações passadas.

<qtdgrd></qtdgrd>

Delimitadores onde deve estar a quantidade de grades do item do pedido. É opcional, sendo assumido o valor 1 se não forinformado. Se ocorrer a explosão de grades, o mesmo é desconsiderado.

<codclc></codclc>

Delimitadores onde deve estar o valor do campo coleção do item. Se a coleção não for informada, é sugerida a coleção padrãodo produto.

<derivacoes></derivacoes>

Delimitadores onde devem estar internamente a eles as derivações e respectivas quantidades de cada derivação. Os valoresinternos a esses delimitadores são considerados sempre que não for informada uma proporcionalidade para o item grade do pedido.Dentro dos delimitadores, para cada par “derivação/quantidade”, devem existir so seguintes delimitadores:

<derivacao></derivacao>

Dentro desses delimitadores deve estar informado um código de derivação do produto.

<quantidade></quantidade>

Dentro desses delimitadores deve estar informada a quantidade da derivação imediatamente anterior

Os dois delimitadores acima devem ser sempre em pares, com a derivação em primeiro e em seguida a sua respectivaquantidade. Se não existirem em forma de pares o sistema irá gerar erro e a importação do pedido atual não será feita.

<observacoes></observacoes>

Delimitadores da seqüência de observações a serem importadas para o pedido. Devem estar dentro dos delimitadores<pedido></pedido>. Indicam que dentro dos mesmos existe uma seqüência de observações a serem importados. Esses delimitadoresnão são obrigatórios na estrutura. É ignorada se não existirem as seqüências de observações.

<observacao></observacao>

Delimitadores de uma observação do pedido. Para cada observação deve existir um delimitador destes. Dentro dessesdelimitadores estarão os campos de observação permitidos para importação, que estão descritos a seguir. Cada item observação égravado como uma observação manual na tabela de observações do pedido atual. A situação da observação é “G” (gravada). Se nãoexistirem delimitadores internos a esse delimitador, não é gravada observação. Observação: se for utilizado o controle de bloqueio porárea na filial e o parâmetro –E:AGRINGS no aplicativo, as observações são geradas com a área da empresa VEN (vendas) e nãoaprovadas.

<obsped></obsped>

Texto de uma observação do pedido. É opcional, sendo ignorado se não existir valor ou o valor for vazio e não existir o códigodo motivo da observação. Se existir apenas o código do motivo, a observação é gravada em branco.

<codmot></codmot>

Código do motivo de uma observação do pedido. É opcional, sendo ignorado se não existir valor ou o valor for vazio.

8/2/2019 SapiensSID


<campos_usuario></campos_usuario>

Delimitadores de campos de usuário a serem importadas para o pedido. Devem estar dentro dos delimitadores<pedido></pedido>. Indicam que dentro dos mesmos existe campos de usuário a serem importados. Esses delimitadores não sãoobrigatórios na estrutura. É ignorada se não existirem os campos de usuários.

<campo_usuário></campo_usuário>

Delimitadores de um campo de usuário do pedido. Para cada campo de usuário deve existir um delimitador destes. Dentrodesses delimitadores estarão os valores dos campos de usuário permitidos para importação, que estão descritos a seguir.

<nomcmp></nomcmp>

Nome do campo de usuário do pedido na base de dados. É obrigatório, uma vez que seu valor é usado para encontrar ocampo de usuário onde o valor deve ser inserido.

<vlrcmp></vlrcmp>

Valor do campo de usuário do pedido na base de dados. É obrigatório e representa o valor do campo de usuário a serimportado para a base de dados. Para campos numéricos ou hora deve ser informado apenas o valor inteiro. Para campos de valor realdeve ser informado o valor com vírgula. Para campos texto ou data, deve ser informado por extenso, sem aspas simples ou dupla.

Parâmetros não obrigatórios:ManErrFec Indica que, se ocorrer erro no fechamento, o pedido não deva ser descartado, apenas gerado sem fechar. O

número de pedido gerado, a situação (não fechado) e o erro ocorrido no fechamento serão evidenciados no retorno.

ManErrIte Indica que, se ocorrer erro na geração de um item de pedido, o pedido não deva ser descartado, e osdemais itens devam ser processados normalmente, sem interromper todo o processo do pedido a ser importado. O pedido será apenasgerado sem fechar. O número de pedido gerado, a situação (não fechado) e os erros ocorridos nos itens serão evidenciados no retorno.

Retorno da ação

O retorno da ação é um texto também em formato XML, dentro dos delimitadores <retorno></retonro>. Dentro dessesdelimitadores é indicado o erro ou o sucesso na importação para cada pedido dentro da seqüência de pedidos, ordenadosnumericamente pela seqüência de entrada e iniciando em 1 (um) e envolvidos nos delimitadores <pedido ></pedido>. O número deordenação exibido no retorno não é o número de pedido no Sapiens.

O formato geral do retorno para um pedido é:

O

O formato do retorno para um determinado pedido com erro durante a importação é:

<pedido pedido= 'seqüência_do_pedido' [item='seqüência_do_item'] resultado='erro'>texto_do_erro</pedido>

onde'seqüência_do_pedido'

• é o número de seqüência em que foi processado o pedido delimitado pelos delimitadores<pedido></pedido>

'seqüência_do_item'

• é o número de seqüência do item grade que está sendo processado dentro do pedido, caso o erro tenhaocorrido em um item delimitado pelos delimitadores <itens></itens>. A seqüência do item é reiniciadapara cada pedido. Se o erro for gerado pelos dados gerais ou outra consistência no fechamento dopedido e validação dos valores contra o contrato, esse texto não é exibido.

'texto_do_erro'

• é a informação textual do erro ocorrido pela consistência ou pela verificação da estrutura do comandoXML para um pedido.

O formato do retorno para um determinado pedido processado com sucesso é:

<retorno><pedido pedido= 'seqüência_do_pedido' [item='seqüência_do_item'] resultado='erro ou sucesso'>texto do

erroou número do pedido</pedido>

.

.

..(demais pedidos)

</retorno>

8/2/2019 SapiensSID


<pedido pedido= 'seqüência_do_pedido' resultado='sucesso'>situação = 'fechado ou não fechado' [motivo ='motivo do erro no fechamento'] número pedido gerado = 'número_pedido_sapiens' </pedido>

onde

'seqüência_do_pedido'

• é o número de seqüência em que foi processado o pedido delimitado pelos delimitadores<pedido></pedido>

'número_pedido_sapiens'• é o número do pedido gerado pelo Sapiens

'fechado ou não fechado'

• irá exibir o valor 'fechado' quando o pedido for fechado com sucesso ou 'não fechado' caso oparâmetro ManErrFec for igual a 'S' e ocorrer erro no fechamento do pedido, sendo este apenasgravado

[motivo = 'motivo do erro no fechamento']

• (sem os colchetes) irá ser exibido somente caso o parâmetro ManErrFec for igual a 'S' e ocorre errono fechamento do pedido, evidenciando o motivo do não fechamento do pedido, caso em que seráapenas gravado e não descartado o pedido

O texto de retorno é plano e sem quebras de linha.

O retorno da ação com o uso do parâmetro não obrigatório ManErrIte é diferenciado. O formato geral do retorno para umpedido quando do uso do parâmetro não obrigatório ManErrIte é:

O

O formato do retorno quando do uso do parâmetro não obrigatório ManErrIte para um determinado pedido com sucessodurante a importação do pedido (dados gerais, itens do pedido e fechamento) é:

<pedido pedido = 'seqüência_do_pedido' resultado='sucesso'> <mensagem> informações sobre o pedidogerado pelo Sapiens </mensagem> </pedido>

O formato do retorno quando do uso do parâmetro não obrigatório ManErrIte para um determinado pedido com erro nofechamento ou na geração do pedido, durante a importação é:

<pedido pedido = 'seqüência_do_pedido' resultado = 'erro'> <mensagem> texto_do_erro </mensagem></pedido>

O formato do retorno quando do uso do parâmetro não obrigatório ManErrIte para um determinado pedido com erro nositens, durante a importação é:

<pedido pedido = 'seqüência_do_pedido' resultado = 'sucesso no pedido, com erros na gravação dos itens'><mensagem> <itens> <item item= 'seqüência_do_item_do_pedido'> texto_do_erro_do_item </item> </itens></mensagem> </pedido>

O formato do retorno quando do uso do parâmetro não obrigatório ManErrIte para um determinado pedido com erro nofechamento do pedido e erros nos itens, durante a importação é:

<pedido pedido = 'seqüência_do_pedido' resultado = 'erro no pedido, com erros na gravação dos itens'><mensagem> texto_do_erro_do_pedido </mensagem> <itens> <item item= 'seqüência_do_item_do_pedido'>texto_do_erro_do_item </item> </itens> </pedido>

<retorno><pedido pedido = 'seqüência_do_pedido' resultado='erro ou sucesso [, no pedido, com erros na gravação dos

itens]'> <mensagem> texto do erro ou número do pedido </mensagem> [<itens><itemitem='seqüência_do_item_do_pedido'> texto_do_erro_do_item </itens>] </pedido>

.

.

.

.(demais pedidos)

</retorno>

8/2/2019 SapiensSID



Dentro dos delimitadores <pedidos></pedidos> poderão ser informados vários pedidos e dentro de cada delimitador<itens></itens> devem ser informados os vários itens do pedido. A ação pode ser chamada individualmente para um pedido apenas,porém recomenda-se a utilização de vários pedidos dentro de uma única ação, que confere um desempenho melhor à importação.

A função irá processar pedido a pedido que estiver dentro dos delimitadores <pedidos></pedidos>. Caso ocorra um erro emum pedido, este pedido todo é descartado e a função segue processando o próximo pedido na seqüência. O pedido gerado éautomaticamente fechado. Se ocorrer erro no fechamento, o pedido é descartado, a não ser que exista o parâmetro ManFecErr igual a'S', que no caso irá apenas gravar o pedido se houver erro no fechamento. Ao final, será gerado o retorno da função indicando, para

cada pedido com sucesso gerado, o seu número e para cada pedido não processado, o erro correspondente, na mesma seqüência quefoi informada no documento XML.

A rotina possui o mesmo funcionamento da rotina da tela do Comercial\Vendas\Pedidos\Via Grade de Produto, gerandopedidos fechados. A filial e empresa em que são gerados os pedidos são o da filial logada no Sapiens Server e não é permitido indicarfilial ou empresa na ação.

Em relação ao documento XML a ser enviado à ação, este deve ser plano, ou seja, sem quebras de linha e sem espaços entreos delimitadores. Os valores dentro dos delimitadores podem ter espaços entre os mesmos, desde que o valor não seja numérico.

Segue um exemplo de uma ação com um pedido e dois itens:

acao=sid.ped.gravarpedidogradesidxml=<pedidos>

<pedido>

<codmar>SUPERMARCA</codmar><codcli>3</codcli><codrep>3</codrep><itens>

<item><codpro>FCAL00010017</codpro><codfxa>FAIXA DE CAL 01</codfxa><derivacoes>

<derivacao>33</derivacao><quantidade>1</quantidade><derivacao>34</derivacao><quantidade>2</quantidade><derivacao>35</derivacao><quantidade>2</quantidade><derivacao>36</derivacao><quantidade>5</quantidade>

</derivacoes></item><item>

<codpro>FCAL00010011</codpro><codfxa>FAIXA DE CAL 01</codfxa><codpgr>F100</codpgr>

</item></itens><observacoes>

<observacao>Pedido gerado via importação</observacao><observacao>Entrega normal</observacao>

</observacoes><campos_usuario>

<campo_usuario><nomcmp>usu_numerico</nomcmp><vlrcmp>10</vlrcmp>

</campo_usuario>

<campo_usuario><nomcmp>usu_real</nomcmp><vlrcmp>15,7</vlrcmp>


<nomcmp>usu_texto</nomcmp><vlrcmp>Texto do pedido</vlrcmp>


<nomcmp>usu_data</nomcmp><vlrcmp>01/01/2008</vlrcmp>


<nomcmp>usu_hora</nomcmp><vlrcmp>658</vlrcmp>

</campo_usuario>

</campos_usuario></pedido><pedido>

<tipped>6</tipped><codmar>SUPERMARCA</codmar><codcli>3</codcli>

8/2/2019 SapiensSID


<codrep>3</codrep><itens>

<item><codpro>FCAL00010017</codpro><codfxa>FAIXA DE CAL 01</codfxa><derivacoes>

<derivacao>33</derivacao><quantidade>1</quantidade><derivacao>34</derivacao><quantidade>2</quantidade><derivacao>35</derivacao>

<quantidade>2</quantidade><derivacao>36</derivacao><quantidade>5</quantidade>

</derivacoes></item>

</itens></pedido>

</pedidos>

Exemplo de um retorno com erro e um com sucesso:

Com erro:

<retorno><pedido pedido='1' resultado='erro'>É necessário informar o cliente</pedido></retorno>

Com sucesso:

<retorno><pedido pedido='2' resultado='sucesso'>numero pedido gerado = 1050</pedido></retorno>

2.2.22 CANCELAR PEDIDO

Ação:SID.Ped.Cancelar (RVPE)

Parâmetros obrigatórios:NumPed Número do pedidoNumDav Número do DAV

Retorno:"OK"

Observações:É necessário informar apenas um parâmetro, porém é possível informar os dois.

2.3 SUPRIMENTOS – COTAÇÕES

2.3.1 GRAVAR COTAÇÃO

Ação:SID.Cot.Gravar (SCCP)

Parâmetros obrigatórios:NumSol Número da solicitaçãoSeqSol Seqüência da solicitaçãoCodFor Código do fornecedorQtdCot Quantidade cotadaPreCot Preço da cotaçãoPrzEnt Prazo de entrega

Parâmetros opcionais:TipRet Tipo de retorno da ação, quando bem sucedida (ver Retorno para mais detalhes)DscCot Percentual de DescontoIpiCot Percentual de IPIIcmCot Percentual de ICMSCodCpg Condição de pagamentoDatPrv Data de previsão de entrega

ObsCot Observação da cotação de preço de compraCifFob Indicativo se o frete é CIF ou FOB

Retorno:Se o parâmetro TipRet (tipo de retorno da ação) for:- 0 (padrão): "OK"

8/2/2019 SapiensSID


- 1: <NumCot>/<SeqCot> (Número e seqüência da cotação gerada)

2.4 MERCADO – NOTA FISCAL VENDA

2.4.1 GRAVAR CABEÇALHO DA NOTA FISCAL VENDA (INCLUIR)

Ação:SID.Nfv.Gravar (RFNF)

Parâmetros obrigatórios:CodSnf Série da nota fiscalCodCli Código do clienteTnsPro Transação da nota para produtosTnsSer Transação da nota para serviços

Parâmetros opcionais:NumNfv Número da nota fiscalTipNfs Tipo da nota fiscal de saídaCodCpg Código da condição de pagamentoCodEdc Espécie de documentoDatEmi Data de emissãoDatSai Data de saídaCodFpg Código da forma de pagamentoCodRep Código do representanteCodTra Código da transportadoraCodEmb Código da embalagemQtdEmb Quantidade de embalagensPesBru Peso brutoPesLiq Peso líquidoPerDs1 Percentual de desconto-1PerDs2 Percentual de desconto-2PerDs3 Percentual de desconto-3PerDs4 Percentual de desconto-4PerEnc Percentual de encargosPerFre Percentual do freteObsNfv Observação da notaVlrDar Valor de arredondamento (- desconto, + acréscimo)PrcNfv Procedência da notaPreImp Número pré-impresso do formulário da nota fiscalPlaVei Placa do veículo da nota fiscalTraMtr Transportadora do motoristaCodMtr Código do motoristaVlrPar(n)* Valor da parcela a ser gerada**VctPar(n)* Data de vencimento da parcela**GerBai(n)* Indica se liquida o título imediatamente após sua geração (S=sim, N=não)TnsBai(n)* Transação utilizada para baixar o título* (n) = Seqüência da parcela, variando de 1 até o total de parcelas – Não utilizar os parênteses.

Se a sequência da parcela não for informada para qualquer uma dessas variáveis (exemplo: VlrPar=100 ou VctPar=01/01/2000 ouGerBai=S ou TnsBai=90355), ficará valendo apenas para a primeira parcela.

** Se não informados estes valores, a nota será sempre gerada com uma única parcela fixa.Utilizar ação "Sid.Nfv.RecalcularParcelas" para gerar parcelas da NF automaticamente conforme a condição de pagamento.

Retorno:<NumNfv> Número da nota fiscal

Observações:Somente inclusão de notas fiscais tipo 1. Outros tipos podem ser incluídos, mas tipos de notas que possuem composição ou

ligações com outras tabelas não serão contemplados de forma automática.Esta ação aceita campos de usuário.

2.4.2 FECHAR NOTA FISCAL VENDA

Ação:SID.Nfv.Fechar (RFNF)

Parâmetros obrigatórios:NumNfv Número da nota fiscal (não utilizar para fechamento agrupado)CodSnf Série da nota fiscal

Parâmetros opcionais:NumIni Número da nota fiscal inicial (fechamento agrupado)NumFim Número da nota fiscal final (fechamento agrupado)DatIni Data inicial para fechamento (fechamento agrupado)DatFim Data final para fechamento (fechamento agrupado)RecNot Indicativo para recalcular nota (0=não, 1=sim*)

8/2/2019 SapiensSID


BusVal Indicativo para buscar valores (0=não, 1=sim*)GerNfe Indicativo para gerar arquivo de notas fiscais eletrônicas (0=não*, 1=sim)MsgBlo Indicativo se deve exibir o motivo do bloqueio no retorno (0=não*, 1=sim)* Valor padrão

Retorno:"OK"

2.4.3 CANCELAR NOTA FISCAL VENDA

Ação:SID.Nfv.Cancelar (RFNF)

Parâmetros obrigatórios:NumNfv Número da nota fiscalCodSnf Série da nota fiscal

Parâmetros opcionais:ExcUlt Excluir fisicamente a nota fiscal, caso seja a última gerada (0=não*, 1=sim)GerNfe Indicativo para gerar arquivo eletrônico de cancelamento de nota fiscal de saída (0 =não, 1=sim*)* Valor padrão

Retorno:"OK"

Observação:O parâmetro ExcUlt somente irá excluir a nota fiscal de saída se ela estiver com situação de digitação (E140Nfv.SitNfv = 1),além de ser a última nota da série fiscal.

2.4.4 RECALCULAR PARCELAS (BASEADO NA COND. PGTO.)

Ação:SID.Nfv.RecalcularParcelas (RFNF)

Parâmetros obrigatórios:NumNfv Número da nota fiscalCodSnf Série da nota fiscal

Retorno:"OK"

2.4.5 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL VENDA (INCLUIR)

Ação:SID.Nfv.GravarProduto (RFNF)

Parâmetros obrigatórios:NumNfv Número da nota fiscalCodSnf Série da nota fiscalSeqIpv Seqüência do itemCodPro Código do produtoCodDer Código da derivação (quando existir)QtdFat Quantidade faturadaPreUni Preço unitário

Parâmetros opcionais:TnsPro Transação dos itensNopPro Natureza da operaçãoCplIpv Complemento da descriçãoCodTpr Código da tabela de preçoPesBru Peso brutoPesLiq Peso líquidoFilPed Filial do pedidoNumPed Número do pedidoSeqIpd Seqüência do pedidoPreBas Preço basePerDsc Percentual de descontoPerIpi Percentual de IPIPerIcm Percentual de ICMSPerFun Percentual de Funrural

VlrFre Valor do freteVlrSeq Valor do seguroVlrLiq Valor líquidoCodLot Número do loteVlrDar Valor de arredondamento (- desconto, +acréscimo)CodDep Código do depósito

8/2/2019 SapiensSID


UniVen Unidade de medida de vendaFilNfc Filial da nota fiscal de entradaCodFor Código do fornecedorNumNfc Número da nota fiscal de entradaSnfNfc Código da série da nota fiscal de entradaSeqIsc Seqüência do item de serviço da NF de entrada

Retorno:"OK"


O parâmetro “PreUni” torna-se opcional quando “CodTpr” é informado. Ao informar “CodTpr” não é necessário informar “PreUni”, pois o preço unitário passado(PreUni) será substituído pelo valor unitário da tabela de preço.

Caso o cliente da nota possua uma tabela de preço associada nas suas definições, “PreUni” e “CodTpr” não precisam serinformados, pois o sistema busca a tabela de preço das definições do cliente e atribui para o item. Com isso o sistema busca o preçounitário do item conforme tabela de preço.

Quando for enviada a alíquota de ICMS como parâmetro, o código de ICMS Especial da transação ou do produto seráignorado e a alíquota de ICMS enviada será mantida.

2.4.6 GRAVAR ITEM DE SERVIÇO NA NOTA FISCAL VENDA (INCLUIR)

Ação:

SID.Nfv.GravarServico (RFNF)

Parâmetros obrigatórios:NumNfv Número da nota fiscalCodSnf Série da nota fiscalSeqIsv Seqüência do itemCodSer Código do serviçoQtdFat Quantidade faturadaPreUni Preço unitário

Parâmetros opcionais:TnsSer Transação dos itensNopSer Natureza da operaçãoCplIsv Complemento da descrição do serviçoCodTpr Código da tabela de preço

FilPed Filial do pedidoNumPed Número do pedidoSeqIsp Seqüência do pedidoPerDsc Percentual de descontoPerIpi Percentual de IPIPerIcm Percentual de ICMSVlrLiq Valor líquidoFilCtr Código da filial do contrato de vendaNumCtr Número do contrato que gerou a notaDatCpt Mês e ano de competência do item do contratoSeqCvs Seqüência do item do contrato na competênciaUniMed Unidade de medida do serviçoPerIss Percentual do ISSPerIrf Percentual do IRRFPerIns Percentual do INSSPerCom Percentual de comissão do serviçoNumPrj Número do projetoCodFpj Código da fase do projetoCtaFin Conta financeiraCtaRed Conta contábilCodCcu Centro de custosFilNfc Filial da nota fiscal de entradaCodFor Código do fornecedorNumNfc Número da nota fiscal de entradaSnfNfc Código da série da nota fiscal de entradaSeqIsc Seqüência do item de serviço da NF de entradaQtdDev Soma das quantidades devolvidas da NF de entradaVlrDar Valor de arredondamento (- desconto, +acréscimo)

Retorno:"OK"


O parâmetro “PreUni” torna-se opcional quando “CodTpr” é informado. Ao informar “CodTpr” não é necessário informar “PreUni”, pois o preço unitário passado(PreUni) será substituído pelo valor unitário da tabela de preço.

8/2/2019 SapiensSID


Caso o cliente da nota possua uma tabela de preço associada nas suas definições, “PreUni” e “CodTpr” não precisam serinformados, pois o sistema busca a tabela de preço das definições do cliente e atribui para o item. Com isso o sistema busca o preçounitário do item conforme tabela de preço.

Quando for enviada a alíquota de ICMS como parâmetro, o código de ICMS Especial da transação ou do serviço será ignoradoe a alíquota de ICMS enviada será mantida.

2.4.7 CANCELAR FATURA

Ação:

SID.Nfv.CancelarFatura (RFNF)

Parâmetros obrigatórios:NumNff Número da fatura a ser cancelada

Retorno:"OK"

2.4.8 LISTAR EMBALAGENS DA NFV PARA CONTROLE DE EMBARQUE

Ação:SID.Nfv.ListarEmbCtrlEbq (RFNF)

Parâmetros obrigatórios:CodEmp Código da empresa

CodFil Código da filialCodSnf Código da série da nota fiscalNumNfv Número da nota fiscal

Parâmetros opcionais:NumEbq Número do embarqueCodTra Código da transportadora

Retorno:Xml contendo o número do embarque e as embalagens da nota, conforme exemplo:<?xml version="1.0"?><controleebq>

<codemp>1</codemp><codfil>1</codfil><numebq>3</numebq>

<codtra>123</codtra><nomtra>Transportadora 123</nomtra><embalagens>

<embalagem><seqemb>1</seqemb><numemb>23</numemb>

</embalagem><embalagem>

<seqemb>2</seqemb><numemb>25</numemb>

</embalagem></embalagens>

</controleebq>

Observações:

Além de listar as embalagens de uma nota, essa ação verifica o controle de embarque. Passando-se “0” no parâmetroNumEbq um novo número de controle de embarque é gerado e retornado, senão é consistida a existência de um controle de embarquecom tal número.

2.4.9 COMPOR O DOCUMENTO DE EMBARQUE COM A NFV

Ação:SID.Nfv.ComporCtrlEbq (RFNF)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialCodSnf Código da série da nota fiscalNumNfv Número da nota fiscalNumEbq Número do embarque

Retorno:"OK"

Observações:

8/2/2019 SapiensSID


Antes dessa ação deve ser executada a SID.Nfv.ListarEmbCtrlEbq, que se encarregará de gerar um número de controle deembarque, devendo este ser passado para esta ação pelo parâmetro NumEbq.

2.4.10 2.4.10 ATUALIZAÇÃO DA SITUAÇÃO DA NFV ELETRÔNICA

Ação:SID.Nfv.AtualizarNFE (RFNF)

Parâmetros obrigatórios NF-e:

ChvNel ¹ ² Número da chave de acesso nota fiscal eletrônica.SitNel ¹ ² Situação (1=Não Enviada, 2=Enviada, 3=Autorizada, 4=Rejeitada, 5=Denegada, 6=Solicitado

Inutilização, 7=Solicitado Cancelamento, 8=Inutilizada, 9=Cancelada, 10=Erro Geração, 11-ErroSolicitação Cancelamento, 12-Erro Solicitação Inutilização, 13-Impressão em Modo Contingência).

NumPrt ¹ Número do protocolo da nota fiscal eletrônica.DatHor ¹ Data e Hora de Autorização da NF-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28).

Parâmetros obrigatórios para CC-e:SeqEve Sequência do evento da carta de correção eletrônica.

Parâmetros opcionais:ChvNov Nova chave de acesso da nota fiscal eletrônica.DesMot[x] – onde “x” é a seqüência da observação. Exemplo: DesMot1, DesMot2, Desmot3...

Retorno:

"OK"

Observação:¹ Campos obrigatórios de um retorno de NF-e autorizada, cancelada ou inutilizada.² Campos obrigatórios de um retorno de problema na solicitação de autorização/cancelamento/inutilização.* DesMot[x] só é válido para retorno de problema na solicitação de autorização ou problema na solicitação decancelamento/inutilização.O uso desta ação SID é exclusivo para clientes que possuem a integração “IENF” (Nota Fiscal Eletrônica) ativada em suaproprietária.

No retorno da CC-e só poderão ser informadas 3 situações: 3- Autorizada, 4 – Rejeitada , 5 – Denegada e 10=Erro Geração.Ao informar SeqEve assumi-se que a solicitação se trata de uma CC-e.


Retornos esperados na nota fiscal eletrônica.

Situação dodocumento noSapiens

Retorno esperado Mensagem de retorno quando não está nas situações esperadas

2 = Enviada 3 = Autorizada

Documento aguardando autorização. Somente são válidos os retornos dedocumento eletrônico autorizado(3), rejeitado(4), denegado(5) ou erro degeração (10). Foi informado a situação do documento eletrônico como = X.

2 = Enviada 4 = Rejeitada

2 = Enviada 5 = Denegada

2 = Enviada 10 = Erro Geração

6 = SolicitadoInutilização

8 = Inutilizada Documento aguardando inutilização. Somente são válidos os retornos dedocumento eletrônico inutilizado(8) ou erro na solicitação deinutilização(12). Foi informado a situação do documento eletrônico como =X.


12 = Erro SolicitaçãoInutilização

7 = SolicitadoCancelamento

9 = Cancelada Documento aguardando cancelamento. Somente são válidos os retornos dedocumento eletrônico cancelado(9), erro na solicitação de cancelamento(11).Foi informado a situação do documento eletrônico como = X.7 = Solicitado

Cancelamento11 = Erro SolicitaçãoCancelamento

Retornos esperados na Carta de Correção eletrônica.




Carta de correção aguardando autorização. Somente são válidos os retornosde autorizado(3), rejeitado(4), denegado(5) ou erro geração(10). Foi

informada a situação da carta de correção eletrônica como = X.




Caso ocorra uma situação totalmente incomum, como por exemplo a situação do documento no Sapiens ser 3 = Autorizada, ereceber um retorno 3 = Autorizada será retornada a mensagem "Não foi solicitado um retorno para esse documentoeletrônico. ".

8/2/2019 SapiensSID


2.4.11 ATUALIZAÇÃO DA SITUAÇÃO DO CT ELETRÔNICO

Ação:SID.Nfv.AtualizarCTE (RFNF)

Parâmetros obrigatórios:ChvNel ¹ ² Número da chave de acesso do conhecimento de transporte eletrônico.

SitNel ¹ ² Situação (1=Não Enviada, 2=Enviada, 3=Autorizada, 4=Rejeitada, 5=Denegada, 6=SolicitadoInutilização, 7=Solicitado Cancelamento, 8=Inutilizada, 9=Cancelada, 10=Erro Geração, 11-ErroSolicitação Cancelamento, 12-Erro Solicitação Inutilização, 13-Impressão em Modo Contingência).

NumPrt ¹ Número do protocolo do conhecimento de transporte eletrônico.DatHor ¹ Data e Hora de Autorização do CT-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28).

Novo número para chae de acesso da nota fiscal eletrônica.

Parâmetros opcionais:ChvNovDesMot[x] – onde “x” é a sequência da observação. Exemplo: DesMot1, DesMot2, Desmot3...

Data e Hora de Autorização do CT-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28).Retorno:"OK"

Observação:¹ Campos obrigatórios de um retorno de CT-e autorizado, cancelada ou inutilizada..² Campos obrigatórios de um retorno de problema na solicitação de autorização/cancelamento/inutilização.* DesMot[x] só é válido para retorno de problema na solicitação de autorização ou problema na solicitação decancelamento/inutilização.O uso desta ação SID é exclusivo para clientes que possuem a integração “ICTE” (Conhecimento de Transporte Eletrônico)ativada em sua proprietária.


Retornos esperados no Conhecimento de Transporte Eletrônico.




Documento aguardando autorização. Somente são válidos os retornos dedocumento eletrônico autorizado(3), rejeitado(4), denegado(5) ou erro degeração (10). Foi informado a situação do documento eletrônico como = X.





8 = Inutilizada Documento aguardando inutilização. Somente são válidos os retornos dedocumento eletrônico inutilizado(8) ou erro na solicitação deinutilização(12). Foi informado a situação do documento eletrônico como =X.


12 = Erro SolicitaçãoInutilização




Caso ocorra uma situação totalmente incomum, como por exemplo a situação do documento no Sapiens ser 3 = Autorizada, ereceber um retorno 3 = Autorizada será retornada a mensagem "Não foi solicitado um retorno para esse documentoeletrônico. ".

2.4.12 ATUALIZAÇÃO DA SITUAÇÃO DA NFS ELETRÔNICA

Ação:SID.Nfv.AtualizarNFSE (RFNF)

Parâmetros obrigatórios:NumCgc ¹ ² ³ * Número do CNPJ da FilialNumRps ¹ ³ Número do RPSCodSnf ¹ ³ Código da Série RPS

NumNfs ¹ ² * Número da Nota Fiscal de Serviço EletrônicaCodVrf ¹ Código de verificação da Nota fiscal eletrônica de ServiçoDatHor ¹ ² Data e Hora de Autorização da NF-e (ex: AAAA-MM-DDTHH:MM; ex2: 2009-06-30T09:28).IndSuc ¹ ² ³ * Indica se a solicitação ocorreu com sucesso (1=Sim, 2=Não, 3=Erro**)


8/2/2019 SapiensSID


DesMot[x] – onde “x” é a sequência da observação. Exemplo: DesMot1, DesMot2, Desmot3...Retorno:"OK"

Observação:¹ Campos obrigatórios de um retorno de NFS-e autorizada.² Campos obrigatórios de um retorno de cancelamento.³ Campos obrigatórios de um retorno de problema na solicitação de autorização.* Campos obrigatórios de um retorno de problema na solicitação de cancelamento.** Tipo de Retorno somente permitido quando a solicitação for de autorização.

*** DesMot[x] só é válido para retorno de problema na solicitação de autorização ou problema na solicitação decancelamento.O uso desta ação SID é exclusivo para clientes que possuem a integração “IENS” (Nota Fiscal de Serviço Eletrônica) ativadaem sua proprietária.


Retornos esperados na nota fiscal eletrônica de serviço.


Retorno esperadoMensagem de retorno quando não está nas situações

esperadas

2 = Enviada 3 = AutorizadaDocumento aguardando autorização. Somente são válidos os retornos dedocumento eletrônico autorizado(3), rejeitado(4), denegado(5) ou erro degeração (10). Foi informado a situação do documento eletrônico como = X.






2.4.13 FECHAR CONTROLE DE EMBARQUE

Ação:SID.Nfv.FecharCtrlEbq (RFNF)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialNumEbq Número do embarque

Retorno: “Embarque fechado com sucesso.”

Observações:Quando definido NumEbq e executada a ação o controle de embarque é fechado. Não permitindo mais que o controle de

embarque sejá alterado.

2.4 SUPRIMENTOS – NOTA FISCAL COMPRA

2.4.14 GRAVAR CABEÇALHO DA NOTA FISCAL COMPRA (INCLUIR)

Ação:

SID.Nfc.Gravar (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaTnsPro* Transação da NF entrada para produtosTnsSer* Transação da NF entrada para serviços

Parâmetros opcionais:CodCpg Código da condição de pagamento da nota fiscal de entradaTipNfe Tipo de nota fiscal de entradaUfsCic Sigla do estado base para o cálculo do ICMSCodEdc Espécie de documento para fins fiscaisCodTri Código de tributação para emissão da DARF

DatEnt Data da Entrada da NotaNopPro Natureza de operação para produtosNopSer Natureza de operação para serviçosDatEmi Data de emissão da nota fiscal de entradaCodFpg Código da forma de pagamentoCodTra Código da transportadora da nota fiscal de entrada

8/2/2019 SapiensSID


CodRed Código da transportadora de redespacho da nota fiscal de entradaQtdEmb Quantidade de embalagens da nota fiscalCodEmb Código da embalagemNumEmb Numeração das embalagens da nota fiscalObsNfc Texto da observaçãoPesBru Peso bruto da nota fiscal de entradaPesLiq Peso líquido da nota fiscal de entradaPerDs1 Percentual de desconto - 1 do fornecedorPerDs2 Percentual de desconto - 2 do fornecedorPerFin Percentual de Acréscimo Financeiro

VlrDzf Valor do desconto referente zona francaVlrFre Valor do frete da nota fiscal de entradaVlrDs1 Valor do desconto - 1 do fornecedorVlrDs2 Valor do desconto - 2 do fornecedorVlrDar Valor dos descontos para arredondamento do total da nota fiscal de entradaVlrFin Valor líquido da nota fiscal para o financeiroNumLot Número do lote contábilVlrInf Valor informado para fechamentoIntImp Indicativo se a nota foi integrada com módulo de impostosTipNdi Tipo do documento de importaçãoNumDoi Número do documento de importação (Comércio Exterior)DatDoi Data do documento de importação (Comércio Exterior)LocDes Local de desembaraçoDatDes Data do desembaraço aduaneiroUfsDes Sigla da UF onde ocorreu o desembaraço aduaneiroCodExp Código do exportador (Fornecedor emitente da Nf-e)VlrFei Valor de Frete de importaçãoVlrSei Valor de Seguro de importaçãoVlrOui Valor de Outras Despesas de importaçãoCifFob Indicativo se o frete para o cliente é CIF (C) ou FOB (F)SomFre Somar o valor do frete no valor da nota fiscalDatParSid Indica se deve gerar as parcelas pela data de emissão (0=não, 1=sim*). *Padrão

Retorno:<NumNfc> Número da nota

Observações:* Somente inclusão de notas fiscais tipo 1.

* Outros tipos podem ser incluídos, mas tipos de notas que possuem composição ou ligações com outras tabelas não serãocontemplados de forma automática. É de responsabilidade do desenvolvedor que irá utilizar as ações SID de nota fiscal de entrada cujo

tipo for diferente de 1 (não contemplado) definir todos os campos de ligação, tabelas relacionadas, valores, enfim tudo que o sistemafaz de forma automática quando utilizado a tela em si.

* Aceita campos de usuário.

2.4.15 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL COMPRA (INCLUIR)

Ação:SID.Nfc.GravarProduto (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaTnsPro Transação de produto do item da notaCodPro Código do produto da nota fiscal de entradaCodDer Código da derivação do produto da nota fiscal de entradaQtdRec Quantidade recebida do item da nota fiscal de entradaPreUni Preço unitário do item da nota fiscal de entrada

Parâmetros opcionais:SeqIpc Seqüência do item na nota fiscal de entradaNopPro Código da natureza de operaçãoFilOcp Código da filial da ordem de compraNumOcp Número da ordem de compra da nota fiscal de entradaSeqIpo Sequência do item na ordem de compra da nota fiscal de entradaCodClf Código da classificação fiscal do item da nota fiscal de entradaCodStr Situação tributária do item da nota fiscal de entradaCodTic Código do ICMS especialCodTrd Código de redução de impostos

CodTst Código do ICMS substituídoCodStp Código de substituição do PISCodStc Código de substituição do COFINSCodDep Código do depósito para entrada de estoque do produtoCodLot Código do lote de estocagemDatVlt Data de validade do lote

8/2/2019 SapiensSID


UniNfc Código da unidade de medida da nota fiscal de entradaQtdAjb Quantidade de Ajuste de Balança para Efeito de EstoqueQtdDev Quantidade devolvida do item da nota fiscal de entradaUniMed Unidade de medida de estoque do item da nota fiscal de entradaQtdEst Quantidade de entrada conforme unidade de medida de estoqueVlrFum Valor do frete por unidade de medida quando CIFQtdFre Quantidade base na unidade do produto valida para o valor do freteForFre Código do fornecedor para geração título de fretePesBru Peso bruto do item da nota fiscal de entradaPesLiq Peso líquido do item da nota fiscal de entrada

PreEst Preço do item conforme unidade de medida de estoquePreBas Preço unitário base para o movimento de estoquePerDsc Percentual de desconto do item da nota fiscal de entradaPerDs3 Percentual de desconto 3PerDs4 Percentual de desconto 4PerDs5 Percentual de desconto 5PerIpi Percentual de IPI do item da nota fiscal de entradaPerIcm Percentual do ICM do item da nota fiscal de entradaPerFun Percentual do Funrural ou INSSNumPrj Número do projetoCodFpj Código da fase do projetoCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoVlrFre Valor freteVlrSeg Valor do seguroVlrEmb Valor embalagemVlrEnc Valor encargos financeirosVlrOut Valor outras despesasVlrDar Valor para arredondamentoVlrFrd Valor frete destacadoVlrOud Valor outras despesas destacadoVlrBru Valor bruto do item da nota fiscal de entradaVlrDsc Valor do desconto do item da nota fiscal de entradaVlrDs1 Valor do desconto 1VlrDs2 Valor do desconto 2VlrDs3 Valor de desconto 3VlrDs4 Valor de desconto 4VlrDs5 Valor de desconto 5VlrDzf Valor do desconto referente zona francaVlrBfu Valor base do Funrural ou INSS

VlrFun Valor do Funrural ou INSSVlrBip Valor base IPIVlrIpi Valor do IPI do item da nota fiscal de entradaVlrBid Valor base IPI presumido (50% compra no comércio)VlrIpd Valor do IPI presumido (50% compra no comércio)VlrBic Valor base do ICMSVlrIcm Valor do ICMS do item da nota fiscal de entradaVlrDfa Valor da diferença de alíquota inter-estadualVlrBsi Valor base ICMS substituídoVlrIcs Valor do ICMS substituído do item da nota fiscal de entradaVlrBsd Valor base ICMS substituído destacadoVlrIsd Valor ICMS substituído destacadoVlrBsp Valor base da substituição tributário do PISVlrStp Valor da substituição tributária do PISVlrBsc Valor base da substituição tributário da COFINS

VlrStc Valor da substituição tributária do COFINSVlrIip Valor isentas IPIVlrIic Valor isentas ICMSVlrOip Valor outras IPIVlrOic Valor outros ICMSVlrLpr Valor do produtoVlrLou Valor dos outros valoresVlrLiq Valor líquido do item da nota fiscal de entradaVlrFin Valor do item válido para o financeiroAcrFin Valor de Acréscimo FinanceiroEmpNfv Código da empresa da nota fiscal de saídaFilNfv Código da filial da nota fiscal de saídaSnfNfv Série da nota fiscal de saídaNumNfv Número da nota fiscal de saídaSeqIpv Sequência do item da nota fiscal de saída

CodFab Código do FabricanteNumEpi Identificador da inspeção aberta para a liberação do itemVlrBpi Valor base do PIS a recuperarVlrPis Valor do PIS a recuperar do item da nota fiscal de entradaFilCtr Código da filial do contrato de compraNumCtr Número do contrato que gerou a nota fiscal de entrada

8/2/2019 SapiensSID


SeqCcp Sequência do item do contrato na competênciaVlrBcr Valor base do Cofins a recuperarVlrCor Valor do Cofins a recuperarPerIim Percentual de imposto de importação do item da nota fiscal de entradaVlrBii Valor base imposto de importaçãoVlrIim Valor do imposto de importação do item da nota fiscal de entradaVlrRis Valor de retenção de ICMS SubstitutoPerPit Percentual de PIS RetidoVlrBpt Valor base do PIS RetidoVlrPit Soma dos valores do PIS retido

PerCrt Percentual de Cofins RetidoVlrBct Valor base do Cofins RetidoVlrCrt Valor do Cofins RetidoPerCsl Percentual de CSLL RetidoVlrBcl Valor base do CSLL RetidoVlrCsl Valor do CSLL RetidoPerOur Percentual de Outras RetençõesVlrBor Valor base de Outras RetençõesVlrOur Valor de Outras RetençõesPerIrf Percentual do IRRFVlrBir Valor base IRRFVlrIrf Valor do IRRFPerDs1 Percentual de desconto 1PerDs2 Percentual de desconto 2BecIpi Valor base de IPI creditado efetivamenteVecIpi Valor de IPI creditado efetivamenteBecIcm Valor base de ICMS creditado efetivamenteVecIcm Valor ICMS Cred. EfetivamenteVlrFei Valor de frete de importaçãoVlrSei Valor de seguro de importaçãoVlrOui Valor de outras despesas de importaçãoBcoImp Valor base do cofins a recuperar na importaçãoCofImp Valor do cofins a recuperar na importaçãoBpiImp Valor base do pis a recuperar na importaçãoPisImp Valor do pis a recuperar na importaçãoVlrBpf Valor Base do PIS FaturamentoPerPif Percentual do PIS FaturamentoVlrPif Valor do PIS FaturamentoVlrBcf Valor Base do COFINS FaturamentoPerCff Percentual do COFINS FaturamentoVlrCff Valor do COFINS Faturamento

IgnOcp Ignora a carga de dados da OCP, se informada (0=não*, 1=sim). *PadrãoRecNot Indica se deve executar o recálculo de valores dos itens (0=não, 1=sim*). *PadrãoNumAdi Número da adiçãoSeqAdi Número sequencial do item dentro da adiçãoDscAdi Valor do desconto do item da DI – adiçãoFabEst Código do fabricante estrangeiroDatParSid Indica se deve gerar as parcelas pela data de emissão (0=não, 1=sim*). *Padrão

Retorno:<SeqIpc> Seqüência do item gerado


2.4.16 GRAVAR ITEM DE SERVIÇO NA NOTA FISCAL COMPRA (INCLUIR)

Ação:SID.Nfc.GravarServico (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaTnsSer Transação de serviço do item da notaCodSer Código do serviço da nota fiscal de entradaPreUni Preço unitário do serviço da nota fiscal de saída

Parâmetros opcionais:SeqIsc Sequência do item na nota fiscal de entradaFilOcp Código da filial da ordem de compra

NumOcp Número da ordem de compra da nota fiscal de entradaSeqIso Sequência da ordem de compra da nota fiscal de entradaNopSer Código da natureza de operaçãoCodTri Código de tributação para emissão da DARFQtdRec Quantidade recebida do serviço da nota fiscal de entradaQtdDev Soma das quantidades devolvidas pelas NF de saída

8/2/2019 SapiensSID


UniMed Unidade de medida do serviço da nota fiscal de entradaPerDsc Percentual de desconto do serviço da nota fiscal de entradaPerIss Percentual do ISS do serviço da nota fiscal de entradaPerIrf Percentual do IRRF do serviço da nota fiscal de entradaPerIns Percentual do INSSNumPrj Número do projetoCodFpj Código da fase do projetoCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custo

VlrEnc Valor encargos financeirosVlrOut Valor outras despesasVlrDar Valor para arredondamentoVlrOud Valor outras despesas destacadoVlrBru Valor bruto do serviço da nota fiscal de entradaVlrDsc Valor do desconto do serviço da nota fiscal de entradaVlrDs1 Valor do desconto - 1 do fornecedorVlrDs2 Valor do desconto - 2 do fornecedorVlrBis Valor base ISSVlrIss Valor do ISS sobre o serviço da nota fiscal de entradaVlrBir Valor base IRRFVlrIrf Valor do IRRF sobre o serviço da nota fiscal de entradaVlrBin Valor base do INSSVlrIns Valor do INSSVlrLse Valor do serviçoVlrLou Valor dos outros valoresVlrLiq Valor líquido do item de serviço da nota fiscal de entradaVlrFin Valor do item válido para o financeiroAcrFin Valor de Acréscimo FinanceiroEmpNfv Código da empresa da nota fiscal de saídaFilNfv Código da filial da nota fiscal de saídaSnfNfv Série da nota fiscal de saídaNumNfv Número da nota fiscal de saídaNumEpi Identificador da inspeção aberta para o itemCodClf Código da classificação fiscal do item da nota fiscal de entradaCodStr Situação tributária do item da nota fiscal de entradaCodTic Código do ICMS especialCodTrd Código de redução de impostosCodTst Código do ICMS substituídoPerIpi Percentual de IPI do item da nota fiscal de entradaPerIcm Percentual do ICM do item da nota fiscal de entrada

VlrDzf Valor do desconto referente zona francaVlrBip Valor base IPIVlrIpi Valor do IPI do item da nota fiscal de entradaVlrBid Valor base IPI presumido (50% compra no comércio)VlrIpd Valor do IPI presumido (50% compra no comércio)VlrBic Valor base do ICMSVlrIcm Valor do ICMS do item da nota fiscal de entradaVlrDfa Valor da diferença de alíquota inter-estadualVlrBsi Valor base ICMS substituídoVlrIcs Valor do ICMS substituído do item da nota fiscal de entradaVlrBsd Valor base ICMS substituído destacadoVlrIsd Valor ICMS substituído destacadoVlrIip Valor isentas IPIVlrIic Valor isentas ICMSVlrOip Valor outras IPI

VlrOic Valor outros ICMSVlrBpi Valor base do PIS a recuperarVlrPis Valor do PIS a recuperar do item da nota fiscal de entradaFilCtr Código da filial do contrato de compraNumCtr Número do contrato que gerou a nota fiscal de entradaVlrBcr Valor base do Cofins a recuperarVlrCor Valor do Cofins a recuperarVlrBct Valor base do Cofins RetidoVlrCrt Valor do Cofins RetidoPerCrt Percentual de Cofins RetidoVlrBpt Valor base do PIS RetidoVlrPit Soma dos valores do PIS retidoPerPit Percentual de PIS RetidoVlrBcl Valor base do CSLL RetidoVlrCsl Valor do CSLL Retido

PerCsl Percentual de CSLL RetidoVlrBor Valor base de Outras RetençõesVlrOur Valor de Outras RetençõesPerOur Percentual de Outras RetençõesVlrRis Valor de retenção de ICMS SubstitutoPerDs1 Percentual de desconto 1

8/2/2019 SapiensSID


PerDs2 Percentual de desconto 2PerDs3 Percentual de desconto 3PerDs4 Percentual de desconto 4PerDs5 Percentual de desconto 5VlrDs3 Valor do desconto 3VlrDs4 Valor de desconto 4VlrDs5 Valor de desconto 5BecIpi Valor base de IPI creditado efetivamenteVecIpi Valor de IPI creditado efetivamenteBecIcm Valor base de ICMS creditado efetivamente

VecIcm Valor ICMS Cred. EfetivamenteVlrBie Valor base do INSS parte empresaVlrIem Valor do INSS parte empresaVlrOui Valor de outras despesas de importaçãoBcoImp Valor base do cofins a recuperar na importaçãoCofImp Valor do cofins a recuperar na importaçãoBpiImp Valor base do pis a recuperar na importaçãoPisImp Valor do pis a recuperar na importaçãoSeqIsp Sequência do item de serviço no pedido de vendaVlrBpf Valor Base do PIS FaturamentoPerPif Percentual do PIS FaturamentoVlrPif Valor do PIS FaturamentoVlrBcf Valor Base do COFINS FaturamentoPerCff Percentual do COFINS FaturamentoVlrCff Valor do COFINS FaturamentoIgnOcp Ignora a carga de dados da OCP, se informada (0=não*, 1=sim). *PadrãoRecNot Indica se deve executar o recálculo de valores dos itens (0=não, 1=sim*). *PadrãoDatParSid Indica se deve gerar as parcelas pela data de emissão (0=não, 1=sim*). *Padrão

Retorno:<SeqIsc> Seqüência do item gerado


2.4.17 GRAVAR PARCELAS MANUAIS NA NOTA FISCAL DE COMPRA

Ação:SID.Nfc.GravarParcelasManuais (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaVlrPar(n)1 Valor da parcela da nota fiscal de entradaVctPar(n)1 Data de vencimento da parcela da nota fiscal de entradaNumTit(n)1 Número do título a ser gerado no conta a pagar

Parâmetros opcionais:CodTpt(n)1 Código do tipo do título a ser gerado no conta a pagarDatParSid Indica se deve gerar as parcelas pela data de emissão (0=não, 1=sim*). *Padrão

Retorno:"OK"

Observações:1 O índice (n) indica o número da parcela ao qual o parâmetro se referencia. Este índice deve

iniciar em 1 e, para cada nova parcela, ser incrementado em 1.

Na execução desta ação são eliminadas todas as parcelas já definidas, manualmente ou não, para a nota fiscal de entradasendo referenciada.

A soma do valor financeiro das parcelas deve ser igual ao valor financeiro da nota fiscal de entrada, caso contrário as parcelasnão serão gravadas.

Esta ação deve ser executada após a inclusão de todos os itens de produto e serviço da nota fiscal de entrada, se após achamada desta ação for incluído mais algum item de produto ou serviço as parcelas serão recalculadas conforme parametrização dosistema.

2.4.18 FECHAR NOTA FISCAL COMPRA

Ação:SID.Nfc.Fechar (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entrada

8/2/2019 SapiensSID


GerNfe Indicativo para gerar arquivo de notas fiscais eletrônicas (0=não*, 1=sim)

Parâmetros opcionais:RecNot Indicativo para recalcular nota (0=não*, 1=sim)

Observações:* Valor Padrão

Retorno:"OK"

2.4.19 CANCELAR NOTA FISCAL COMPRA

Ação:SID.Nfc.Cancelar (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaGerNfe Indicativo para gerar arquivo de notas fiscais eletrônicas (0=não*, 1=sim)

Observações:* Valor Padrão

Retorno:"OK"

2.4.20 GERAR NOTA FISCAL VIA ORDEM DE COMPRA

Ação:SID.Nfc.GerarNFCOrdemCompra (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumOcp Número da(s) ordem(ns) de compra (separado por vírgula, ex: 101,102,103,...)DatEnt Data de entrada da NFDatEmi Data de emissão da NF

Retorno:"OK"

2.4.21 GRAVAR RATEIO PARA ITEM DE PRODUTO

Ação:SID.Nfc.GravarRateioProduto (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaSeqIpc Seqüência do item de produto da nota fiscal de entradaCtaFin(n)* Conta financeira reduzida**

CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custosPerCta(n)* Percentual do rateio para a conta***VlrCta(n)* Valor do rateio para a conta***PerRat(n)* Percentual do rateio para o centro de custos***VlrRat(n)* Valor do rateio para o centro de custos ***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto

Parâmetros opcionais:ObsRat(n)* Observação do rateio

Retorno:"OK"

Observações:* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Depende da parametrização.*** Informar apenas o percentual ou valor.

8/2/2019 SapiensSID


2.4.22 GRAVAR RATEIO PARA ITEM DE SERVIÇO

Ação:SID.Nfc.GravarRateioServico (SRNF)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaSeqIsc Seqüência do item de serviço da nota fiscal de entrada

CtaFin(n)* Conta financeira reduzida**CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custosPerCta(n)* Percentual do rateio para a conta***VlrCta(n)* Valor do rateio para a conta***PerRat(n)* Percentual do rateio para o centro de custos***VlrRat(n)* Valor do rateio para o centro de custos ***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto


Retorno:"OK"


2.5 SUPRIMENTOS – ORDEM DE COMPRA

2.4.23 GRAVAR CABEÇALHO ORDEM DE COMPRA

Ação:SID.Ocp.Gravar (SCOC)

Parâmetros obrigatórios:

CodFor Código do fornecedor da ordem de compraCodCpg Código da condição de pagamento

Parâmetros opcionais:NumOcp Número da ordem de compraTnsPro Código da transação para produtosTnsSer Código da transação para serviçosCodTra Código da transportadora para a ordem de compraVlrFre Valor do frete para a ordem de compraVlrSeg Valor do seguro para a ordem de compraVlrEmb Valor das embalagens para a ordem de compraVlrEnc Valor dos encargos para a ordem de compraVlrOut Valor das outras despesas para a ordem de compraVlrDar Valor dos descontos para arredondamento do total da ordem de compraVlrFrd Valor frete destacado

VlrOud Valor outras despesas destacadoVlrDs1 Valor de desconto 1VlrDs2 Valor do desconto 2VlrDs3 Valor de desconto 3VlrDs4 Valor de desconto 4VlrDzf Valor do desconto referente zona francaVlrBfu Valor base do funruralVlrFun Valor do funruralVlrBsp Valor base da substituição tributário do PISVlrStp Valor da substituição tributário do PISVlrBsc Valor base da substituição tributário da COFINSVlrStc Valor da substituição tributário da COFINSVlrBin Valor base do INSSVlrIns Valor do INSSVlrLpr Valor líquido dos itens de produtos da ordem de compra

VlrLse Valor líquido dos itens de serviços da ordem de compraVlrLou Valor líquido dos valores diversos da ordem de compraVlrLiq Valor líquido da ordem de compraVlrFin Valor líquido da ordem de compra para o financeiroObsOcp Observação da ordem de compraTemPar Indicativo se a OC tem parcelas especiais na tabela E420PAR

8/2/2019 SapiensSID


SalCan Indicativo se o saldo da ordem de compra deverá ser cancelado

Retorno:<NumOcp> Número da ordem de compra

Observação:Esta ação aceita campos de usuário

2.4.24 EXCLUIR ORDEM DE COMPRA

Ação:SID.Ocp.Excluir (SCOC)

Parâmetros obrigatórios:NumOcp Número da ordem de compra

Retorno:"OK"

2.4.25 GRAVAR ITEM DE PRODUTO NA ORDEM DE COMPRA

Ação:SID.Ocp.GravarProduto (SCOC)


NumOcp Número da ordem de compraCodPro Código do produto da ordem de compraCodDer Código da derivação do produto da ordem de compraQtdPed Quantidade do produto da ordem de compra

Parâmetros opcionais:SeqIpo Seqüência do item de produto na ordem de compraTnsPro Transação do item de produto da OCCplIpo Complemento da descrição do produtoUniFor Unidade de medida do produto no fornecedorCodDep Código do depósito para estoque do produto da ordem de compraQtdPed Quantidade do produto da ordem de compraUniMed Unidade de medida do produto compradoCodTpr Código da tabela de preço do produtoPreUni Preço unitário do produto da ordem de compra

PreFix Indicativo se o preço é fixo ou nãoPerDsc Percentual de desconto para o produto da ordem de compraPerIpi Percentual de IPI do produto da ordem de compraPerIcm Percentual de ICM do produto da ordem de compraPerFun Percentual do funruralCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoCodMoe Código da moeda que o item da ordem de compra está representadoDatMoe Data da cotação da moeda ou índice do item da ordem de compraCotMoe Valor da cotação da moeda ou índice do item da ordem de compraFecMoe Indicativo de o valor da cotação é fechado

Retorno:<SeqIpo> Seqüência do item de produto na ordem de compra


2.4.26 GRAVAR ITEM DE SERVIÇO NA ORDEM DE COMPRA

Ação:SID.Ocp.GravarServico (SCOC)

Parâmetros obrigatórios:NumOcp Número da ordem de compraCodSer Código do serviço na ordem de compraQtdPed Quantidade pedida do serviço na ordem de compra


SeqIso Seqüência do item de serviço na ordem de compraTnsSer Transação de serviço do item da OCCplIso Complemento da descrição do serviçoCodTri Código de tributação para emissão da DARFQtdPed Quantidade pedida do serviço da ordem de compraUniMed Unidade de medida do serviço da ordem de compra

8/2/2019 SapiensSID


PreUni Preço unitário do serviço da ordem de compraPerDsc Percentual de desconto do serviço da ordem de compraPerIss Percentual do ISS do serviço da ordem de compraPerIrf Percentual do IRRF do serviço da ordem de compraPerIns Percentual do INSSCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoCodMoe Código da moeda que o item da ordem de compra está representadoDatMoe Data da cotação da moeda ou índice do item da ordem de compra

CotMoe Valor da cotação da moeda ou índice do item da ordem de compraFecMoe Indicativo de o valor da cotação é fechado

Retorno:<SeqIso> Seqüência do item de serviço na ordem de compra


2.4.27 FECHAR ORDEM DE COMPRA

Ação:SID.Ocp.Fechar (SCOC)


NumOcp Número da ordem de compra

Retorno:"OK"

Observações:Para que seja possível fechar uma ordem de compra é necessário que a mesma esteja aprovada em todos os níveis, ou não

tenha controle de aprovação multi-nível.

2.4.28 GERAR ORDEM DE COMPRA VIA COTAÇÃO

Ação:SID.Ocp.GerarOCPCotacao (SCOC)


NumCot(n)* Número da cotação

Parâmetros opcionais:SeqCot(n)* Seqüência(s) da cotação (separadas por vírgula, ex.: "101,102,103")TnsPro Transação de produtoTnsSer Transação de serviço

Observações:* (n) = Índice incremental, iniciado em 1. Não utilizar os parênteses.

Retorno:"OK"

2.5 SUPRIMENTOS – ESTOQUES

2.5.1 GERAR REQUISIÇÃO

Ação:SID.Est.Requisitar (SERE)

Parâmetros obrigatórios:CodPro Código do produto movimentadoCodDer Código da derivação do produto movimentadoQtdEme Quantidade do documento de movimento de estoque

Parâmetros opcionais:NumEme Número do documento de entrada do movimento de estoqueSeqEme Seqüência do produto ou serviço no documentoCodTns Código da transação de movimentação de estoqueCplPro Complemento da descrição do produto ou serviçoUniMed Unidade de medidaCodAge Código de agrupamento para o estoqueCodAgc Código de agrupamento para comprasDatPrv Data de previsão de entrega do produto ou serviçoCtaFin Conta financeira reduzida

8/2/2019 SapiensSID


CtaRed Conta contábil reduzidaQtdApr Quantidade aprovado do movimento de estoqueUsuAtd Usuário atendente do movimento de estoqueUsuSol Usuário responsável pela solicitação do movimentoUsuRes Usuário responsável pela aplicação do produto ou serviço movimentadoCcuRes Centro de custo responsável pela aplicação do produto ou serviçoUsuRec Usuário recebedor do produto ou serviço solicitadoObsEme Observação da solicitação de movimento de estoqueResEst1 Indicativo se o estoque do produto da requisição deve ser reservado(S=sim, N=não)CodDep Código do depósito para reserva

SitEme Situação da movimentação de estoqueProSer2 Indicativo se a requisição é de serviço (S=Serviço)NumDoc Número de documento da requisição

Observação:1Quando for solicitada a Reserva de Estoque, é obrigatório que seja informado o Código do Depósito.2O parâmetro é obrigatório no caso de ser uma requisição de serviço, caso seja uma requisição de produto este não precisa

ser informado.

Retorno:<NumEme/SeqEme> Número e seqüência da requisição gerada

2.5.2 ATENDER REQUISIÇÃO

Ação:

SID.Est.AtenderRequisicao (SERE)

Parâmetros obrigatórios:NumEme Número do documento de entrada do movimento de estoqueSeqEme Seqüência do produto ou serviço no documentoQtdAtd Quantidade atendida do movimento de estoque

Parâmetros opcionais:CodDep Código do depósito movimentadoCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCcuRes Centro de custo responsável pela aplicação do produto ou serviçoDatMov Data da movimentação do estoqueCodLot Código do lote de fabricação para estocagemNumSep Código da série do produto

Observação:1. No processo de atendimento de requisição via Sid, não existe a possibilidade de gerar solicitação de compras

automática.2. Caso não seja informada quantidade atendida (QtdAtd=0), a requisição será cancelada com a quantidade

aprovada.

Retorno:"OK"

2.5.3 EXCLUIR REQUISIÇÃO

Ação:SID.Est.ExcluirRequisicao (SERE)

Parâmetros obrigatórios:NumEme Número do documento de entrada do movimento de estoqueSeqEme Seqüência do produto ou serviço no documento

Retorno:"OK"

2.5.4 GRAVAR RATEIO REQUISIÇÃO

Ação:SID.Est.GravarRateioRequisicao (SERE)

Parâmetros obrigatórios:NumEme Número do documento de entrada do movimento de estoqueSeqEme Seqüência do produto ou serviço no documento

Ctafin(n)* Conta financeira*CtaRed(n)* Conta contábil reduzida**PerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***CodCcu(n)* Código do centro de custoVlrRat(n)* Valor do rateio***

8/2/2019 SapiensSID


PerRat(n)* Percentual do rateio***NumPrj(n)* Número do projeto

CodFpj(n)* Código da fase do projeto


Observações:* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Depende da parametrização.

*** Informar apenas o percentual ou valor.

Retorno:"OK"

2.5.5 MOVIMENTAR ESTOQUE

Ação:SID.Est.Movimentar (SECE)

Parâmetros obrigatórios:CodPro Código do produto movimentadoCodDer Código da derivação do produto movimentadoCodTns Código da transação de movimento do estoque

CodDep Código do depósito movimentadoQtdMov Quantidade do movimentoVlrMov* Valor do movimento *(obrigatório quando a transação exigir)

Parâmetros opcionais:DatMov Data da movimentação do estoqueProTrf Código do produto transferido (para movimentos de transferência)DerTrf Código da derivação do produto transferido (p/ movimentos de transferência)DepTrf Código do depósito transferido (para movimentos de transferência)CodCli Código do cliente para os movimentos consignadosCodFor Código do forencedor para os movimentos consignadosNumDoc Número de documento base da movimentaçãoCodLot Código do lote de fabricação para estocagemCodCcu Código do centro de custo do usuário responsávelDatVlt Data de validade do produto no depósito

CtaRed Código da conta contábil reduzidaNumSep Código da série do produto

Retorno:<SeqMov> Seqüência do movimento


2.5.6 EXCLUIR MOVIMENTO DE ESTOQUE

Ação:SID.Est.ExcluirMovimento (SECE)


CodPro Código do produto movimentadoCodDer Código da derivação do produto movimentadoCodDep Código do depósito movimentadoDatMov Data da movimentação do estoqueSeqMov Seqüência do movimento

Retorno:"OK"

2.5.7 LISTAR ITENS DA EMBALAGEM

Ação:SID.Est.ListarItensEmbalagem (SECE)


CodEmp Código da empresaNumEmb Número da embalagem

Retorno:Xml contendo os itens da embalagem, conforme exemplo:<?xml version="1.0"?>

8/2/2019 SapiensSID


<embalagem><codemp>1</codemp><numemb>5</numemb><itens>

<item><codpro>1101</codpro><codder>A</codder><codbar>78912340000111</codbar><qtdpro>3</qtdpro>

</item>

<item> <codpro>1102</codpro><codder>B</codder><codbar>78912340000222</codbar><qtdpro>10</qtdpro>

</item></itens>

</embalagem>

2.5.8 CONFIRMAR CONFERÊNCIA DA EMBALAGEM

Ação:SID.Est.ConfirmarConferEmb (SECE)


CodEmp Código da empresaNumEmb Número da embalagem

Retorno:"OK"

2.5.9 GRAVAR SOLICITAÇÃO DE COMPRA (INCLUIR/ALTERAR)

Ação:SID.Est.GravarSolCompra (SCSC)

Parâmetros obrigatórios:CodPro1 Código do produto movimentadoCodDer1 Código da derivação do produto movimentadoCodSer2 Código do ServiçoQtdSol Quantidade para solicitação de comprasDatPrv2 Data previsão para entrega do serviço

1 Pode-se não informar o campo CodPro, e conseqüentemente o campoCodDer . Neste caso os campos CplPro, UniMed ePreSol tornam-se obrigatórios.

2 Os campos CodSer e DatPrv são obrigatórios no caso de ser uma solicitação de serviço, caso seja uma solicitação de produtoestes não devem ser informados.

Parâmetros opcionais:NumSol Número do documento da solicitaçãoSeqSol Seqüência do item na solicitação de compraCplPro Complemento da descrição do produtoCodTns Código da transação da solicitação de comprasUniMed3 Unidade de medidaPreSol3 Preço da solicitação

CodDep4 Código do depósito movimentadoDatPrv Data prevista de entrega do produtoCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaUsuSol Usuário responsável pela solicitação do produtoUsuRes Usuário responsável pela aplicação do produto solicitadoCcuRes Centro de custo responsável pela aplicação do produtoCodBem Código do bemSolInt Código da solicitação no sistema integradoObsSol Observação da solicitação de compraCtaFin(n)5 6 Conta financeiraCtaRed(n) 5 6 Conta contábil reduzidaCodCcu(n) 5 Código do centro de custoPerCta(n) 5 7 Percentual do rateio da contaVlrCta(n) 5 7 Valor do rateio da conta

PerRat(n)5 7

Percentual do rateioVlrRat(n) 5 7 Valor do rateioNumPrj(n) 5 Número interno do projetoCodFpj(n) 5 Código da fase do projetoObsRat(n) 5 Observação do rateio

8/2/2019 SapiensSID


3 Os campos UniMed e PreSol somente serão considerados se não for informado o campo CodPro.4 O campo CodDep só será considerado se for informado o campo CodPro.5 Campos para informação do rateio, onde:* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.

6 Depende da parametrização.7 Informar apenas o percentual ou apenas o valor.

Retorno:"OK"

2.5.10 EXCLUIR SOLICITAÇÃO DE COMPRAAção:SID.Est.ExcluirSolCompra (SCSC)

Parâmetros obrigatórios:NumSol Número do documento da solicitaçãoSeqSol Seqüência do item na solicitação de compra

Retorno:"OK"

2.5.11 BUSCAR ESTOQUE DISPONÍVEL

Ação:

SID.Est.BuscarEstoqueDisp (SECE)

Parâmetros obrigatórios:CodPro Código do produtoCodDer Código da derivação do produto (quando existir)CodDep Código do depósito

Parâmetros opcionais:ConPed1 Consulta estoque disponível em rotinas de pedido ("S"-Sim ou "N"-Não)CriFed Critério para formação do estoque (atendimento faturamento/baixas estoque em geral)

Observação:1 O cálculo do estoque disponível com o identificador de regra (VEN-120DISPO01) somente será acessado quando o campo

"ConPed" for igual a "S" e o identificador estiver ativo. Caso contrário, será calculado conforme o critério para formação do estoqueinformado no cadastro da filial. Maiores detalhes sobre a funcionalidade do identificador VEN-120DISPO01 podem ser acessados na

documentação do Sapiens.

Retorno:<QtdDis> Quantidade disponível em estoque

2.5.12 BUSCAR PREÇO MÉDIO

Ação:SID.Est.BuscarPrecoMedio (SECE)

Parâmetros obrigatórios:CodPro(n)* Código do produtoCodDer(n)* Código da derivação do produto (quando existir)* (n) = Seqüência incremental dos produtos, iniciando sempre em 1 (um) – Não utilizar os parênteses.

Retorno:Xml contendo o código do produto, derivação e preço médio, conforme exemplo:<?xml version="1.0"?><produto>

<codpro>5207</codpro><codder>A</codder><premed>7.5845</premed>

</produto><produto>

<codpro>5210</codpro><codder> </codder><premed>8.668</premed>

</produto>

2.5.13 BUSCAR ESTOQUE GRADE

AçãoSID.EST. BUSCARESTOQUEGRADE (SECE)

Permite buscar a consulta de estoque em grade, por embalagem avulso ou ambos. O resultado é o mesmo da tela doComercial\Estoques\Consultas\Posição dos Estoques\Embalagem/Grade

8/2/2019 SapiensSID


Parâmetros obrigatórios:CodFxa Código da faixa de grades

Parâmetros opcionais:CodClc Filtro de coleções do produto (abrangência)CodMod Filtro de modelo de produção do produto (abrangência)CodFam Filtro de família do produto (abrangência)CodPro Filtro de produto (abrangência)CodDep Filtro por depósito (abrangência)

CodPgr Proporcionalidade (sem abrangência)CodMar Filtro da marca de produto (abrangência)CodAge Filtro por código de agrupamento de estoque (abrangência)CodEmb Filtro por tipo de embalagem (sem abrangência)ModCon Modo de consulta: 0 – Ambos; 1 – Embalagens; 2 – AvulsosTipAgp Agrupa ou não depósitos: 0 – não agrupa; 1 – agrupa depósitos

Retorno:Documento em formato xml contendo os seguintes campos e estruturas:

<retorno><produtos>

<linha><NumLin></NumLin><CodMod></CodMod>

<CodPro></CodPro><DesPro></DesPro><QtdEmb></QtdEmb><derivacoes>

<CodDer></CodDer><QtdDer></QtdDer>...

</derivacoes><QtdTot></QtdTot><CodEmb></CodEmb><CodDep></CodDep><CodClc></CodClc><CodAge></CodAge><CodPgr></CodPgr>

<CodFxa></CodFxa><CodMar></CodMar><CodFam></CodFam>

</linha>...

<produtos><retorno>

A descrição de cada delimitador e sua funcionalidade está a seguir

<produtos></produto>Delimitadores onde estão internamente todos os produtos lidos da consulta

<linha></linha>

Delimitadores onde existe um para cada conjunto produto/embalagem/depósito/faixa/proporcionalidade retornado daconsulta. O que está delimitado dentro de uma linha são todos os campos e valores a seguir:

<numlin></numlim>Dentro desses delimitadores está apenas como informativo o número de cada linha da consulta

<codmod></codmod>Dentro desses delimitadores está o código do modelo do produto

<codpro></codpro>Dentro desses delimitadores está o código do produto

<despro></despro>Dentro desses delimitadores está a descrição do produto, formada pela descrição e complemento do cadastro do produto

<qtdemb></qtdemb>Dentro desses delimitadores está a quantidade de embalagens, se não estiver exibindo o estoque avulso do produto (semembalagens)

<derivacoes></derivacoes>

8/2/2019 SapiensSID


Dentro desses delimitadores estão aninhadas as derivações do produto, com sua quantidade em estoque, estando essescampos sempre em pares, conforme abaixo e tantos pares quanto possuir a faixa de grade informada no filtro para cada produto:

<codder></codder>Dentro desses delimitadores está o código da derivação do produto

<qtdder></qtddder>Dentro desses delimitadores está a quantidade da derivação imediatamente acima. Quando o produto está embalado, o

mesmo exibe a proporcionalidade apenas. Se for um produto avulso, é a quantidade em avulso.

<qtdtod></qtdtot>Dentro desses delimitadores está a quantidade total de todas as derivações da linha de produto.

<codemb></codemb>Dentro desses delimitadores está o código da embalagem do produto. Se for uma linha de estoque avulso, não há valor nesse

delimitador.

<coddep></coddep>Dentro desses delimitadores está o código da depósito consultado do produto. Se a consulta agrupar depósitos, com o

parâmetro TIPAGP = 1, o mesmo não apresenta valor.

<codclc></codclc>Dentro desses delimitadores está o código da coleção do produto.

<codage></codage>Dentro desses delimitadores está o código de agrupamento de estoque do produto

<codpgr></codpgr>Dentro desses delimitadores está o código da proporcionalidade da embalagem do produto. Se a linha estiver exibindo

estoque avulso, não há valor neste delimitador.

<codfxa></codfxa>Dentro desses delimitadores está o código da faixa consultada do produto.

<codmar></codmar>Dentro desses delimitadores está o código da marca do produto.

<codfam></codfam>Dentro desses delimitadores está o código da família do produto.

2.5.14 ESTOQUE PAF/ECF (VAREJO)AçãoSID.EST.PAFECFESTOQUEVAREJO (IVME)

Gera o arquivo eletrônico de estoque conforme especificado no ATO COTEPE ICMS 14/11 - ANEXO IV.

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialTipEst Tipo do saldo de estoque (0 - Total; 1 - Parcial)ArqLoc Caminho e nome do arquivo onde será gerado o arquivo eletrônico do estoque. Ex.: C:\Estoque.txt

Parâmetros opcionais:DatEst Data do saldo do estoque. Se a data não for informada ou for maior ou igual a data atual, será

processada a data do saldo do dia anterior ao atual (ontem).CodPdv[x] Código do produto no PDV. Utilizado apenas para saldo de estoque parcial.Ex.: CodPdv1=1101

CodPdv2=2202CodPdv3=3303

Retorno:"OK"

Observação:Caso o campo TipEst for informado como 1, será obrigatório que pelo menos um CodPdv seja informado.

2.6 MERCADO – NOTA FISCAL TRANSFERÊNCIA

2.6.1 MARCAR EMBALAGEM/PRODUTO PARA TRANSFERÊNCIA

Ação:SID.Nft.MarcarEPT (RFNF)

8/2/2019 SapiensSID


Parâmetros obrigatórios:FilOri Código da filial de origemFilDes Código da filial de destinoPlaVei Placa do veículoNumEmb 1 Número da embalagemCodPro 1 Código do produtoCodDer 1 Código da derivação do produtoCodBar 1 Código de barras do produtoQtdPro 2 Quantidade do produto

Observação:1 Deve ser informado o campo NumEmb, ou o campo CodBar , ou os campos CodPro e CodDer , sendo usado o primeiro, naordem em que estão listados, que contenha um valor.

2 O campo QtdPro é desconsiderado caso seja informado NumEmb, assumindo automaticamente valor 1.

Parâmetros opcionais:EmpOri Código da empresa de origemEmpDes Código da empresa de destino

Retorno:"OK"

2.6.2 BUSCAR ITENS DA NOTA FISCAL DE TRANSFERÊNCIA

Ação:

SID.Nft.BuscarItensNFT (RFNF)

Parâmetros obrigatórios:FilOri Código da filial de origemFilDes Código da filial de destinoCodSnf Série da nota fiscalNumNfv Número da nota fiscal

Parâmetros opcionais:EmpOri Código da empresa de origemEmpDes Código da empresa de destino

Retorno:XML contendo os itens da nota fiscal de transferência, conforme exemplo:<?xml version="1.0"?>

<nfv> <codemp>1</codemp><codfil>1</codfil><codsnf>1A</codsnf><numnfv>79</numnfv><itens>

<item><seqemb>1</seqemb><codemb>1</codemb><numemb>35</numemb><codpro>0</codpro><codder>0</codder><qtdfat>0</qtdfat><codbar>0</codbar>

</item><item>

<seqemb>0</seqemb><codemb>0</codemb><numemb>0</numemb><codpro>4101</codpro><codder>5</codder><qtdfat>5</qtdfat><codbar>78912340000125</codbar>

</item></itens>

</nfv>

2.6.3 CONFIRMAR CONFERÊNCIA DOS ITENS DA NFT

Ação:SID.Nft.ConfirmarConferencia (RFNF)

Parâmetros obrigatórios:FilOri Código da filial de origemFilDes Código da filial de destinoCodSnf Série da nota fiscal

8/2/2019 SapiensSID


NumNfv Número da nota fiscalCodDep Código do depósito

Parâmetros opcionais:EmpOri Código da empresa de origemEmpDes Código da empresa de destinoSnfNfc Série da nota fiscal de entrada (gerada no processo)

Retorno:"OK"

2.7 MERCADO – PRÉ-FATURAS

2.7.1 CRIAR EMBALAGEM PARA PRÉ-FATURA

Ação:SID.Pfa.CriarEmbalagem (RFEX)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialNumAne Número da análise de embarqueNumPfa Número da pré-faturaCodEmb Código da embalagemNumEmb Números das embalagens

Parâmetros opcionais:QtdEmb Quantidade de embalagensNumNiv Nível da EmbalagemVolOcu Volume já ocupado da embalagemPesBru Peso bruto das embalagens e produtosPesLiq Peso líquido dos produtosObsEmb Texto da observação das embalagens

Retorno:<SeqEmb> Seqüência da Embalagem Criada

2.7.2 INCLUIR OS CONTEÚDOS DAS EMBALAGEM DA PRÉ-FATURA

Ação:SID.Pfa.IncluirConteudoEmb (RFEX)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialNumAne Número da análise de embarqueNumPfa Número da pré-faturaSeqEmb Seqüência de embalagemNumSep1 Número de SérieCodBar1 Código de BarrasCodPro1 Código do ProdutoCodDer1 Código de Derivação

Parâmetros opcionais:QtdPro2 Quantidade do produto na embalagemVolIpd Volume calculado do produtoPesBru Peso bruto do produtoPesLiq Peso líquido do produtoObsPro Texto da observação do produto na embalagem

Observação:1. Estes campos definem o que será incluído no conteúdo, ser for informado um número de série o sistema irá procurar

por este número, se for informado o código de barras o sistema irá procurar o código EAN e se não achar pelo códigode barras livre do produto e se for informado produto/derivação será procurado este produto específico.

2. Sempre que não for informado o campo QTDPRO o default será 1(um) no caso da série este campo é ignorado esempre assumido 1(um)

Retorno:"OK"

2.7.3 EXCLUIR EMBALAGEM DA PRÉ-FATURA

Ação:SID.Pfa.ExcluirEmbalagem (RFEX)

8/2/2019 SapiensSID


Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialNumAne Número da análise de embarqueNumPfa Número da pré-faturaSeqEmb1 Seqüência de embalagemNumEmb1 Números das embalagens

Observação:

1. Se for informado SeqEmb não e necessário informar NumEmb e vice-versa.Retorno:"OK"

2.8 CADASTROS – CLIENTES

2.8.1 GRAVAR CLIENTE (INCLUIR/ALTERAR)

Ação:SID.Cli.Gravar

Parâmetros obrigatórios:NomCli Nome do clienteApeCli Nome fantasia do clienteSigUfs Sigla do estado do clienteCodCli Código do cliente (obrig. p/alteração)CgcCpf Número do CNPJ ou CPF do clienteEndCli Endereço do cliente (rua, nº., etc.)

Parâmetros opcionais:CodCli Código do clienteMarCli Marca do clienteSenCli Senha do clienteNenCli Número do endereço do clienteTipCli Tipo do cliente (Padrão=’F’)TipMer Tipo de mercado do cliente (Padrão=’I’)TipEmc Tipo Empresa do cliente para geração de título de COFINSCliCon Indicativo se o cliente é contribuinte de ICMS (Padrão=’N’)CodRam Código do ramo de atividade do clienteInsEst Inscrição estadual do clienteInsMun Inscrição municipal do clienteCodGre Código do grupo de empresasZonFra Indicativo de qual é o benefício fiscal do clienteCodSuf Número do cliente junto à SuframaDatSuf Data de validade do registro do SUFRAMACplEnd Complemento do endereço do cliente (sala, andar, etc.)CliPrx Ponto de referência ou proximidade do clienteZipCod Código da cidade do cliente externo - ZIP CODEEenCli Código do endereço do clienteCepCli CEP do clienteCepIni Faixa inicial do CEP da cidade do clienteBaiCli Bairro do cliente

CidCli Cidade do clienteCodPai Código do país do clienteTemEnt Indicativo se o cliente tem endereços de entrega diferentes (Padrão=’N’)EndEnt Endereço de entrega do clienteNenEnt Número do endereço de entregaCplEnt Complemento do endereço de entrega do clienteEenEnt Código do endereço de entrega do clienteCepEnt CEP do endereço de entrega do clienteIniEnt Faixa inicial do CEP do endereço de entrega do clienteCidEnt Cidade do endereço de entrega do clienteEstEnt Estado do endereço de entrega do clienteInsEnt Inscrição estadual do endereço de entregaCgcEnt Número do CNPJ de EntregaBaiEnt Bairro de Entrega do clienteTemCob Indicativo se o cliente tem endereços de cobrança diferentes (Padrão=’N’)

EndCob Endereço de cobrança do clienteNenCob Número do endereço de cobrançaCplCob Complemento do endereço de cobrança do clienteEenCob Código do endereço de cobrança do clienteCepCob CEP do endereço de cobrança do clienteIniCob Faixa inicial do CEP do endereço de cobrança do cliente

8/2/2019 SapiensSID


CidCob Cidade do endereço de cobrança do clienteEstCob Estado do endereço de cobrança do clienteCgcCob Número do CNPJ de cobrançaEntCor Indicativo do endereço de entrega de correspondênciasBaiCob Bairro de Cobrança do clienteFonCli Número do telefone - 1FonCl2 Número do telefone - 2FonCl3 Número do telefone - 3FaxCli Número do FAX do clienteCxaPst Número da caixa postal do cliente

IntNet Endereço eletrônico (E-Mail)CodFor Código do cliente como fornecedorCliRep Código do cliente como representanteCliTra Código do cliente como transportadoraSitCli Situação do cliente (Padrão=’A’)CodMot Código do motivo da situação do clienteBloCre Indicativo se o motivo bloqueia crédito para o cliente (Faturamento) (Padrão=’N’)ObsMot Observação do motivo da situação do clienteTriIcm Tributa ICMS (S/N) (Padrão=’S’)TriIpi Tributa IPI (S/N) (Padrão=’S’)TriPis Tributa PIS (S/N) (Padrão=’S’)TriCof Tributa COFINS (S/N) (Padrão=’S’)CodPdv Código do cliente no PDVIdeCli Código de identificação do cliente

Retorno:<CodCli> Código do cliente gerado


2.8.2 GRAVAR DEFINIÇÕES DO CLIENTE (INCLUIR/ALTERAR)

Ação:SID.Cli.GravarDefinicoes

Parâmetros obrigatórios:CodCli Código do clienteCodRep Código do representante padrão para o clienteCodCpg Código da condição de pagamento padrão para o cliente

Parâmetros opcionais:SalDup Saldo devedor de duplicatas dos clientesSalOut Saldo devedor de outros títulos dos clientesSalCre Saldo dos adiantamentos dos clientesDatLim Data da última atualização do limite de crédito do clienteVlrLim Valor do limite de crédito do clienteLimApr Indicativo se o limite de crédito do cliente está ou não aprovado (Padrão=’N’)VlrPfa Soma das pré-faturasDatMac Data da ocorrência do maior acúmulo de saldo devedor do clienteVlrMac Valor do maior acúmulo de saldo devedor do clienteDatUpe Data do último pedido do clienteVlrUpe Valor do último pedido do clienteDatUfa Data do último faturamento do clienteVlrUfa Valor do último faturamento do clienteDatUpg Data do último pagamento do clienteVlrUpg Valor do último pagamento do clienteQtdPgt Quantidade total de pagamentos efetuados pelo clienteDatUpc Data do último pagamento em cartório do clienteVlrUpc Valor do último pagamento em cartório do clienteQtdTpc Quantidade total de pagamentos em cartório do clienteDatMfa Data da ocorrência da maior fatura do clienteVlrMfa Valor da maior fatura do clienteDatAtr Data da ocorrência do maior atraso do clienteVlrAtr Valor de pagamento do maior atraso do clienteMaiAtr Quantidade de dias do maior atraso do clienteMedAtr Quantidade de dias de média de atraso do clienteAcePar Indicativo se o cliente aceita faturamento parcial de pedidos (Padrão=’S’)QtdMfp Quantidade máxima de faturas por pedido aceito pelo clientePerDs1 Percentual de desconto - 1 para o clientePerDs2 Percentual de desconto - 2 para o cliente

PerCom Percentual de comissão nas vendas para o cliente (+ ou -)CodCrp Código de grupo do contas a receberCodRve Código da região de venda do clienteCodTpr Código da tabela de preço padrão para o clienteCodFpg Código da forma de pagamentoCodTra Código da transportadora padrão para o cliente

8/2/2019 SapiensSID


CodRed Código da transportadora de redespacho padrão para o clienteRecJmm Percentual de juros de mora mês para o contas a receberRecTjr Tipo de juros para contas a receber (Padrão=’S’)RecDtj Dias de tolerância para cálculo de juros de moraRecMul Percentual de multa para atraso contas a receberRecDtm Dias de tolerância para multa do contas a receberPerDsc Percentual padrão de desconto para os títulos geradosTolDsc Quantidade padrão de dias de tolerância para descontoPorSi1 Código do primeiro portador aceito pelo clientePorSi2 Código do segundo portador aceito pelo cliente

CodCrt Código da carteira padrão para o clientePorNa1 Código do primeiro portador não aceito pelo clientePorNa2 Código do segundo portador não aceito pelo clienteCodIn1 Código da primeira instrução bancáriaCodIn2 Código da segunda instrução bancáriaCodBan Código do banco onde o cliente mantém conta correnteCodAge Código da agência bancária onde o cliente mantém conta correnteCcbCli Número da conta corrente bancária do clienteCtaRed Conta contábil reduzida - 1CtaRcr Conta contábil reduzida - 2CtaFdv Conta contábil reduzida - 3CtaFcr Conta contábil reduzida – 4CriEdv Critério para escolha do dia de vencimento (A, S, N, U)FveTns Hierarquia de forma de venda – transaçãoFveFpg Hierarquia de forma de venda – forma de pagamentoFveCpg Hierarquia de forma de venda – condição de pagamentoCifFob Indicativo se o frete para o cliente é CIF (C) ou FOB (F)

Retorno:"OK"


2.8.3 EXCLUIR CLIENTE

Ação:SID.Cli.Excluir


CodCli Código do clienteCodEmp Código da empresa

Retorno:"OK"

2.8.4 EXCLUIR DEFINIÇÕES DO CLIENTE

Ação:SID.Cli.ExcluirDefinicoes


Retorno:

"OK"

2.8.5 GRAVAR DADOS PESSOA JURÍDICA (INCLUIR/ALTERAR)

Ação:SID.Cli.GravarPesJuridica


Parâmetros opcionais:DatFdc Data de fundação da empresaNomSo1 Nome do sócio 1CpfSo1 CNPJ/CPF do sócio 1FunSo1 Função do sócio 1

NomSo2 Nome do sócio 2CpfSo2 CNPJ/CPF do sócio 2FunSo2 Função do sócio 2NomSo3 Nome do sócio 3CpfSo3 CNPJ/CPF do sócio 3FunSo3 Função do sócio 3

8/2/2019 SapiensSID


QtdFun Quantidade de funcionáriosVlrFat Valor do faturamento anual em dólares (US$)AnoFat Ano base do faturamento anual

Retorno:"OK"


2.8.6 EXCLUIR DADOS PESSOA JURÍDICA

Ação:SID.Cli.ExcluirPesJuridica


Retorno:"OK"

2.8.7 GRAVAR DADOS PESSOA FÍSICA (INCLUIR/ALTERAR)

Ação:

SID.Cli.GravarPesFisica


Parâmetros opcionais:EstCiv Estado civil do clienteRegCas Regime de casamentoCodSex Código do sexoDatNas Data do nascimento do clienteCidNat Nome da cidade de naturalidadeCodPai Nome do país de nacionalidade do clienteNroDep Quantidade de dependentesNumRge Número do RG (Identidade)OrgRge Órgão emissor do RG

DatRge Data de emissão do RGNumPte Número do passaporteDatEpt Data de emissão do passaporteDatVpt Data de vencimento do passaporteNomPai Nome do pai do clienteNomMae Nome da mãe do clienteEmpTra Nome da empresa onde trabalhaTipOcu Tipo de ocupaçãoTipTra Tipo da empresa onde trabalha o clienteAdmTra Data de admissão do cliente/sócioEndTra Endereço da empresa onde trabalha o clienteBaiTra Bairro da empresa onde trabalha o clienteEenTra Código do endereço da empresa onde trabalha o clienteCepTra CEP da empresa onde trabalha o clienteCidTra Cidade da empresa onde trabalha o cliente

EstTra Estado da empresa onde trabalha o clienteFonTra Número do telefone da empresa onde trabalha o clienteRamTra Ramal do telefone onde trabalha o clienteCrtTra Dados da carteira profissional do clienteCarTra Cargo exercido na empresa pelo clienteSalTra Salário do cliente na empresa onde trabalhaOriOut Origem de outros rendimentos do clienteVlrOut Valor de outros rendimentos do clienteNomCng Nome do cônjugeNasCng Data de nascimento do cônjugeCpfCng Número do CPF do cônjugeRgeCng Número do RG do cônjugeOrgCng Órgão emissor do RG do cônjugeDatCng Data de emissão do RG do cônjugeEmpCng Empresa onde trabalha o cônjugeAdmCng Data de admissão do cônjugeEndCng Endereço da empresa onde trabalha o cônjuge do clienteBaiCng Bairro onde trabalha o cônjuge do clienteEenCng Código do endereço onde trabalha o cônjuge do clienteCepCng CEP onde trabalha o cônjuge do clienteCidCng Cidade onde trabalha o cônjuge do cliente

8/2/2019 SapiensSID


EstCng Estado onde trabalha o cônjuge do clienteFonCng Número do telefone da empresa onde trabalha o cônjugeRamCng Ramal do fone onde trabalha o cônjuge do clienteCrtCng Dados da carteira profissional do cônjugeCarCng Cargo exercido na empresa pelo cônjugeSalCng Salário do cônjuge na empresa onde trabalhaTipMor Tipo de moradia do clienteTpoMor Mês e ano da mudança para a moradia atual (reside desde)VlrAlu Valor das despesas com moradiaRefCm1 Referência comercial - 1

RefCm2 Referência comercial - 2RefPe1 Referência pessoal - 1RefPe2 Referência pessoal - 2RefBc1 Referência bancária - 1RefBc2 Referência bancária - 2UltCpr Nome da loja onde efetuou a última compra a créditoUltFin Nome do banco ou financeira onde já fez empréstimoDatSpc Data da última consulta do SPCCidSpc Cidades de pesquisa e de Intercâmbio do SPCInfSpc Informação levantada junto ao SPCNomInv Nome invertido do clienteCarCre Nome do cartão de crédito que possuiNumCre Número do cartão de créditoValCre Data de validade do cartão de créditoVctCre Dia do vencimento do cartão de créditoNomCre Nome do cliente no cartão de créditoDepCre Nome do dependente no cartão de créditoNasCre Data de Nascimento do dependente do cartão de créditoGraCre Grau de parentesco do dependente do cartão de créditoEmpAnt Nome da empresa anterior onde o cliente trabalhouTemAnt Tempo de trabalho na empresa anterior (em anos)FonAnt Número do telefone da empresa anteriorRamAnt Número do ramal do telefone da empresa anteriorResAnt Residência anterior do clienteNomAva Nome do avalista do clienteCpfAva Número do CPF do avalista do clienteEndAva Endereço do avalista do clienteEenAva Código do endereço do avalista do clienteCepAva CEP do avalista do clienteCidAva Nome da cidade do avalista do clienteEstAva Estado do avalista do cliente

FonAva Número do telefone do avalista do cliente

Retorno:"OK"


2.8.8 EXCLUIR DADOS PESSOA FÍSICA

Ação:SID.Cli.ExcluirPesFisica


Retorno:"OK"

2.8.9 GRAVAR CONTATO DO CLIENTE (INCLUIR/ALTERAR)

Ação:SID.Cli.GravarContato


Parâmetros opcionais:SeqCto Seqüência do contatoNomCto Nome do contatoDatNas Data de nascimentoCodNiv Código Nível do contatoSetCto Setor do contatoCarCto Cargo do contatoFonCto Telefone do contato - 1

8/2/2019 SapiensSID


RamCto Ramal do contato - 1FonCt2 Telefone do contato - 2RamCt2 Ramal do contato - 2FonCt3 Telefone do contato - 3RamCt3 Ramal do contato - 3FaxCto Fax do contatoIntNet Endereço eletrônico (e-mail)HobCon Hobby do contatoTimCon Time do contatoSitCto Situação do registro de contato

Retorno:<SeqCto>


2.8.10 EXCLUIR CONTATO DO CLIENTE

Ação:SID.Cli.ExcluirContato

Parâmetros obrigatórios:CodCli Código do clienteSeqCto Seqüência do contato

Retorno:"OK"

2.8.11 GRAVAR ENDEREÇO DE ENTREGA

Ação:SID.Cli.GravarEndEntrega

Parâmetros obrigatórios:CodCli Código do clienteCepEnt CEP do endereço de entregaEndEnt Endereço de entrega


SeqEnt Seqüência do endereço de entregaNomCli Nome do cliente de entregaEenEnt Código do endereço de entrega do clienteNenEnt Número do endereço de entregaCplEnt Complemento do endereço de entregaBaiEnt Bairro do endereço de entregaCidEnt Cidade do endereço de entregaEstEnt Estado do endereço de entregaInsEnt Inscrição estadual do endereçoCgcEnt Número do CNPJ/CPF de entregaPrxEnt Ponto de referência ou proximidade do endereço de entregaCodRoe Código da rotaSeqRoe Seqüência da rotaCodSro Código da sub-rotaSitReg Situação do endereço de entrega

Retorno:<SeqEnt>


2.8.12 EXCLUIR ENDEREÇO DE ENTREGA

Ação:SID.Cli.ExcluirEndEntrega


SeqEnt Seqüência do endereço de entrega

Retorno:"OK"

8/2/2019 SapiensSID


2.8.13 GRAVAR ENDEREÇO DE COBRANÇA

Ação:SID.Cli.GravarEndCobranca


Parâmetros opcionais:SeqCob Seqüência do endereço de cobrança

EenCob Código do endereço de cobrança do clienteCepCob CEP do endereço de cobrançaEndCob Endereço de cobrançaNenCob Número do endereço de cobrançaCplCob Complemento do endereço de cobrançaBaiCob Bairro do endereço de cobrançaCidCob Cidade do endereço de cobrançaEstCob Estado do endereço de cobrançaCgcCob Número do CNPJ/CPF de cobrançaSitReg Situação do endereço de cobrança

Retorno:<SeqCob>

2.8.14 EXCLUIR ENDEREÇO DE COBRANÇA

Ação:SID.Cli.ExcluirEndCobranca

Parâmetros obrigatórios:CodCli Código do clienteSeqCob Seqüência do endereço de cobrança

Retorno:"OK"

2.9 CADASTROS – REPRESENTANTES

2.9.1 GRAVAR REPRESENTANTE (INCLUIR/ALTERAR)

Ação:SID.Rep.Gravar

Parâmetros obrigatórios:CodRep Código do representanteNomRep Nome do representanteApeRep Nome fantasia do representanteTipRep Tipo do representanteEndRep Endereço do representante (rua, nº, etc.)SitRep Situação do representanteSigUfs Estado do representante

GerTit Gera título pag. comissão do representante (T - Título, C - Cheque, O - Ordem Compra)EenRep Código do endereço do representanteInsEst Inscrição estadual do representante

Parâmetros opcionais:SenRep Senha do RepresentanteInsMun Número da Inscrição MunicipalCgcCpf Número do CNPJ ou CPF do representanteCplEnd Complemento do endereço (sala, andar, etc.)ZipCod Código da cidade do representante externo - ZIP CODECepRep CEP do endereço do representanteBaiRep Bairro do representanteCidRep Cidade do representanteFonRep Número do telefone - 1FonRe2 Número do telefone - 2

FonRe3 Número do telefone - 3FaxRep Número do FAX do representanteCxaPst Número da caixa postal do representanteIntNet Endereço eletrônico (E-Mail)DatCad Data do cadastramento do representanteDatAtu Data da última alteração do representante

8/2/2019 SapiensSID


QtdDep Quantidade de dependentes para imposto de rendaCalIrf Indicativo se o cálculo de IRRF é por empresaCalIss Indicativo se o cálculo de ISS é por empresaCalIns Indicativo se o cálculo de INSS é por empresaCodMot Código do motivo da situação do representanteObsMot Observação do motivo da situação do representanteUsuMot Usuário responsável pelo motivo da situação do representanteDatMot Data do motivo da situação do representanteHorMot Hora do motivo da situação do representanteDatNas Data do nascimento

NumRge Número do RGOrgRge Órgão emissor do RGDatRge Data de emissão do RGRepCli Código do representante como clienteRepFor Código do representante como fornecedorCodCdi Código do canal de distribuição padrão do representanteNenRep Número do Endereço do Representante

Retorno:<CodRep> Código do cliente gerado


2.9.2 GRAVAR DEFINIÇÕES DO REPRESENTANTE (INCLUIR/ALTERAR)

Ação:SID.Rep.GravarDefinicoes

Parâmetros obrigatórios:CodRep Código do representanteCodEmp Código da empresa

CodRve Código da região de venda do representanteIpiCom Indicativo se o IPI está ou não na base de comissãoIcmCom Indicativo se o ICMS está ou não na base de comissãoSubCom Indicativo se o ICMS substituído está ou não na base de comissãoFreCom Indicativo se o frete está ou não na base de comissãoSegCom Indicativo se o seguro está ou não na base de comissãoEmbCom Indicativo se o valor das embalagens está ou não na base de comissãoEncCom Indicativo se o valor dos encargos está ou não na base de comissão

OutCom Indicativo se o valor das outras despesas está ou não na base de comissãoDarCom Indicativo se o valor do arredondamento está ou não na base de comissãoComPri Indicativo se a comissão é paga totalmente na primeira parcelaCriRat Critério utilizado para rateioConEst Indicativo se o representante deve contar estoque do clienteCatRep Categoria do RepresentanteCslCom Indicativo se a CSLL Retido está na base de comissão dos pedidos, pré-faturas e notas fiscaisInsCom Indicativo se o INSS está na base de comissão dos pedidos, pré-faturas e notas fiscaisIssCom Indicativo se o ISS está na base de comissão dos pedidos, pré-faturas e notas fiscaisCofCom Indicativo se o COFINS Retido está na base de comissão dos pedidos, pré-faturas e notas fiscaisPisCom Indicativo se o PIS Retido está na base de comissão dos pedidos, pré-faturas e notas fiscaisIrfCom Indicativo se o IRRF está na base de comissão dos pedidos, pré-faturas e notas fiscais

OurCom Indicativo se as outras retenções estão na base de comissão dos pedidos, pré-faturas e notas

fiscaisPifCom Indicativo se o PIS Faturamento está na base de comissão dos pedidos, pré-faturas e notas fiscaisCffCom Indicativo se o COFINS Faturamento está na base de comissão dos pedidos, pré-faturas e notas

fiscaisRecAdc Indicativo se abate os descontos concedidos da comissãoRecAoc Indicativo se abate os outros descontos da comissãoRecPcj Indicativo se recebe comissão sobre juros cobradosRecPcm Indicativo se recebe comissão sobre multas cobradasRecPcc Indicativo se recebe comissão sobre a correção monetáriaRecPce Indicativo se recebe comissão sobre os encargos financeirosRecPco Indicativo se recebe comissão sobre outros acréscimos

Parâmetros opcionais:PerCom Percentual de comissão padrão para produtos do representantePerCos Percentual de comissão padrão para serviços do representanteComFat Percentual da comissão pago ao representante no faturamentoComRec Percentual da comissão pago ao representante no recebimento dos títulos

PerIrf Percentual do IRRF para o cálculo das comissõesPerIss Percentual do ISS para o cálculo das comissõesPerIns Percentual do INSS para o cálculo das comissõesRepSup Código do representante superior do representanteComSup Percentual da comissão pago ao representante superiorCodBan Código do banco da conta corrente do representante

8/2/2019 SapiensSID


CodAge Código da agência do banco da conta corrente do representanteCcbRep Número da conta corrente do representanteTipCol Tipo de ColaboradorNumCad Número do Cadastro do Representante como ColaboradorVenVmp Valor mínimo aceito para pedidosRecVmt Valor mínimo aceito para títulos do contas a receberPerCqt Percentual das cotas sobre as quantidades de vendaPerCvl Percentual das cotas sobre os valores de vendaCtaRed Conta contábil reduzida - 1CtaRcr Conta contábil reduzida - 2

CtaFdv Conta contábil reduzida - 3CtaFcr Conta contábil reduzida - 4 Retorno:"OK"


2.9.3 EXCLUIR REPRESENTANTE

Ação:SID.Rep.Excluir


CodRep Código do representante

Retorno:"OK"

2.9.4 EXCLUIR DEFINIÇÕES DO REPRESENTANTE

Ação:SID.Rep.ExcluirDefinicoes

Parâmetros obrigatórios:CodRep Código do representante

Retorno:"OK"

2.10 CADASTROS – FORNECEDORES

2.10.1 GRAVAR FORNECEDOR (INCLUIR/ALTERAR)

Ação:SID.For.Gravar

Parâmetros obrigatórios:NomFor Nome do fornecedorApeFor Nome fantasia do fornecedorSigUfs Estado do fornecedor

CodFor Código do fornecedor (obrig. p/ alteração)CgcCpf Número do CNPJ ou CPF do fornecedorEndFor Endereço do fornecedor (rua, nº., etc.)

Parâmetros opcionais:CodFor Código do fornecedorMarFor Marca do fornecedorSenFor Senha do FornecedorTipFor Tipo de Fornecedor (Padrão=’F’)TipMer Tipo de Mercado do fornecedor (Padrão=’I’)CodRam Código do ramo de atividadeInsEst Inscrição estadual ou RG do fornecedorInsMun Inscrição municipal do fornecedorCodGre Código do grupo de empresasCodSuf Código na suframa

CplEnd Complemento do endereço do fornecedor (sala, andar, etc.)BaiFor Bairro do fornecedorZipCod Código da cidade do fornecedor externo - ZIP CODEEenFor Código do endereço do fornecedorCepFor CEP do fornecedorCidFor Cidade do fornecedor

8/2/2019 SapiensSID


CodPai Código do paísFonFor Número do telefone - 1FaxFor Número do FAX do fornecedorCxaPst Caixa postal do fornecedorIntNet Endereço eletrônico (E-Mail)ForRep Código do fornecedor como representanteForTra Código do fornecedor como transportadoraSitFor Situação do fornecedor (Padrão=’A’)CodMot Código do motivo da situação do fornecedorCliFor Indicativo se o registro representa um cliente ou um fornecedor ou ambos (Padrão=’A’)

CodCli Código do fornecedor como cliente (cria o cliente se não existir, e liga ambos)RecPis Indicativo se as notas fiscais do fornecedor poderão ter recuperação de PIS (Padrão=’N’)RecIpi Indicativo se as notas fiscais poderão ter recuperação de IPI (Padrão=’S’)RecIcm Indicativo se as notas fiscais poderão ter recuperação de ICMS (Padrão=’S’)CodTri Código de tributação para emissão de DARF/DIRFIdeFor Identificação do fornecedor

Retorno:<CodFor> Código do fornecedor gerado


2.10.2 GRAVAR DEFINIÇÕES DO FORNECEDOR (INCLUIR/ALTERAR)

Ação:SID.For.GravarDefinicoes

Parâmetros obrigatórios:CodFor Código do fornecedorCodCpg Código da condição de pagamento padrão

Parâmetros opcionais:SalDup Saldo devedor de duplicatas aos fornecedoresSalOut Saldo devedor de outros títulos aos fornecedoresSalCre Saldo adiantamentos a fornecedoresDatAtr Data do maior atrasoVlrAtr Valor do maior atrasoMaiAtr Quantidade de dias do maior atrasoMedAtr Quantidade de dias de atraso médio

PrzEnt Quantidade de dias de prazo de entrega do fornecedorCodTpr Código da tabela de preço padrãoCodFpg Código da forma de pagamentoCodTra Código da transportadora padrãoCodPor Código do portador padrãoCodCrt Código da carteira padrãoCodBan Código do banco da conta corrente do fornecedorCodAge Código da agência do banco da conta corrente do fornecedorCcbFor Número da conta corrente do fornecedor no bancoCodCrp Código do grupo de contas a pagarPagJmm Percentual de juros de mora mês para o contas a pagarPagTir Tipo de juros para o contas a pagar (Padrão=’S’)PagDtj Dias de tolerância para cálculo de juros de mora do contas a pagarPagMul Percentual de multa para atraso do contas a pagarPagDtm Dias de tolerância para multa do conta a pagarPerDsc Percentual padrão de desconto para os títulos geradosTolDsc Quantidade padrão de dias de tolerância para descontoPerDs1 Percentual de desconto - 1 para fornecedorPerDs2 Percentual de desconto - 2 para fornecedorPerFun Percentual do Funrural ou INSS para ProdutoPerIns Percentual do INSS para o ServiçoPerIss Percentual do ISS para serviços do fornecedorIndInd Indicativo se o fornecedor é indústria para IPI presumido (Padrão=’N’)CtaRed Conta contábil reduzida - 1CtaRcr Conta contábil reduzida - 2CtaFdv Conta contábil reduzida - 3CtaFcr Conta contábil reduzida - 4CriEdv Critério para escolha do dia de vencimento (A, S, N, U)

Retorno:"OK"


8/2/2019 SapiensSID


2.10.3 EXCLUIR FORNECEDOR

Ação:SID.For.Excluir

Parâmetros obrigatórios:CodFor Código do fornecedor

Retorno:"OK"


2.10.4 EXCLUIR DEFINIÇÕES DO FORNECEDOR

Ação:SID.For.ExcluirDefinicoes

Parâmetros obrigatórios:CodFor Código do fornecedor

Retorno:"OK"

2.11 CADASTROS – PRODUTOS

2.11.1 GRAVAR PRODUTO (INCLUIR/ALTERAR)

Ação:SID.Pro.Gravar

Parâmetros obrigatórios:CodPro Código do produtoDesPro Descrição usual do produtoCodFam Código da família do produto


UniMed Código da unidade de medida do produtoTipPro Tipo do produtoCodOri Código de origem do produtoRecIpi Indicativo se o produto recupera ou não IPITemIcm Indicativo se o produto tem ou não ICMSRecIcm Indicativo se o produto recupera ou não ICMSBxaOrp Se for componente de alguma OP, indica se o mesmo é baixadoSitPro Situação do produtoIndMis Indicativo que o produto é produzido mas também pode ser comprado (misto)IndVen Indicativo se o produto pode ser vendido/faturadoIndCpr Indicativo se o produto pode ser compradoIndReq Indicativo se o produto pode ser requisitadoIndKit Indicativo que o produto produzido é um "Kit" com vários produtos agregados para vendaMatDir Indicativo se o material é diretoClaPro Classe do produto

IndFpr Indicativo se a ligação de produto X fornecedor é usada para obter parâmetros fiscaisCtrVld Indicativo da forma de controle da data de validade nos estoquesCodClf Código interno da classificação fiscalCodStr Código da situação tributária do produtoDepPad Depósito padrão para o produtoRecPis Indicativo se o produto recolhe ou não PISRecCof Indicativo se as notas fiscais poderão ter recuperação de CofinsCplPro Descrição complementar do produtoProImp Indicativo do Tipo de Produto para ImpostosDesNfv Descrição Nota FiscalCodAgf Código de agrupamento de materiais/produtos para Impostos.

Retorno:"OK"


2.11.2 EXCLUIR PRODUTO

Ação:

8/2/2019 SapiensSID


SID.Pro.Excluir

Parâmetros obrigatórios:CodPro Código do produto

Retorno:"OK"

2.11.3 GRAVAR DERIVAÇÃO (INCLUIR/ALTERAR)

Ação:SID.Pro.GravarDerivacao

Parâmetros obrigatórios:CodPro Código do produtoCodDer Código da derivação do produto

Parâmetros opcionais:DesDer Descrição da derivação no componente da máscaraCodBar Código de barras EAN13CodAgr Código de agrupamento para derivaçãoPesBru Peso bruto do produtoPesLiq Peso líquido do produtoVolDer Volume do produtoBxaOrp Se for componente de alguma OP, indica se o mesmo é baixado

SitDer Situação da derivaçãoCtrVld Indicativo da forma de controle da data de validade nos estoquesIndKan Indicativo se usa controle de critério Kanban na geração de OPsCodBa2 Código de barras livreDiaVlt Quantidade de dias para cálculo da validade do lote de fabricaçãoDepPad Depósito padrão para a derivaçãoPreCus * Preço de custoDatCus* Data base do preço de custoHorCus* Hora de atualização do Custo

* Campos disponíveis na versão 5.5.2.2

Retorno:"OK"


2.11.4 EXCLUIR DERIVAÇÃO

Ação:SID.Pro.ExcluirDerivacao

Parâmetros obrigatórios:CodPro Código do produtoCodDer Código da derivação do produto

Retorno:"OK"

2.12 FINANÇAS – CONTAS A RECEBER

2.12.1 GRAVAR TÍTULO CR

Ação:SID.Tcr.Gravar (FRCR)

Parâmetros obrigatórios:NumTit Número do título a receberCodTpt Código do tipo de título a receberCodTns Código da transação que gerou o título a receberSitTit Situação do títuloDatEnt Data de entrada do título a receber

DatEmi Data de emissão do título a receberCodCli Código do cliente do título a receberCodRep Código do representante do título a receberVctOri Data do vencimento/Valor original do título a receberVlrOri Valor original do título a receberCodPor Código do portador do título

8/2/2019 SapiensSID


CodCrt Código da carteira do título a receberProJrs Indicativo se o vencimento prorrogado é com ou sem jurosCodFpg* Código da forma de pagamento*Depende da parametrização.

Parâmetros opcionais:CodMoe Código da moeda do título a receberCodNtg Código da natureza de gastoCodSac Código do sacadoCodCrp Código do grupo de contas a receberObsTcr Observação para o títuloCodMpt Código do motivo de prorrogação do tituloDatPpt Data do provável pagamento do títuloVlrBco Valor base/Valor da comissão do título**VlrCom Valor comissão**PerCom Percentual comissão**ComRec Percentual de comissão pago no recebimento**DatDsc Data/Tolerância válidas para desconto do títuloTolDsc Dias de tolerância para descontoPerDsc Percentual/Valor do desconto do títuloVlrDsc Valor do desconto a ser concedido ao título a receberPerJrs Percentual de juros de mora ao mes do título a receberTipJrs Indicativo se os juros de mora é simples ou compostoJrsDia Valor de juros de mora ao dia do título a receberTolJrs Dias de tolerância para os juros de mora do título a receberPerMul Percentual de multa prevista para o título a receberTolMul Dias de tolerância para a multa prevista para o título a receberCheBan Número do banco na FEBRABAN do chequeCheAge Número da agência do banco do chequeCheCta Numero da conta no banco do chequeCheNum Número do cheque no bancoDatNeg Data base dos juros negociados data atéTitBan Número do título no banco nosso númeroNumArb Número de arquivo de remessa para bancoCodOcr Código da ocorrência de remessa para bancoCodIn1 Código da primeira instrução bancáriaCodIn2 Código da segunda instrução bancáriaJrsNeg Valor dos juros negociadosMulNeg Valor da multa negociadaDscNeg Valor dos descontos negociadosOutNeg Valor de outros valores negociados

CpgNeg Código da condição de pagamento negociadaTaxNeg Taxa negociadaCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoNumPrj Número interno do projetoCodFpj Código da fase do projetoCodBar Código de barras do TítuloCtaFinCap(n)* Conta financeira do rateio da comissãoCtaRedCap(n)* Conta contábil reduzida do rateio da comissãoPerCtaCap(n)* Percentual do rateio da conta da comissãoCodCcuCap(n)* Código do centro de custo do rateio da comissãoPerRatCap(n)* Percentual do rateio da comissão* (n) = Seqüência incremental da linha do rateio, iniciando em 1 (um) – Não utilizar os parênteses.** Os campos podem ser recalculados conforme a combinação utilizada

Retorno:"OK"


2.12.2 BAIXAR TÍTULO CR

Ação:SID.Tcr.Baixar (FRCR)

Parâmetros obrigatórios:NumTit Número do título a receberCodTpt Código do tipo de título a receber

CodTns Código da transação de movimentoDatMov Data de movimento do título a receberDatPgt Data de pagamentoNumCco* Número da conta interna financeiraVlrMov Valor do movimento*Depende da parametrização

8/2/2019 SapiensSID


Parâmetros opcionais:TipRet Tipo de retorno da ação, quando bem sucedida (ver Retorno para mais detalhes)DatLib Data de liberaçãoDiaAtr Dia de atrasosDiaJrs Dia de jurosVlrDsc Valor de descontosVlrJrs Valor de jurosVlrMul Valor de multaVlrCom Valor da comissão

VlrBco Valor base da comissãoVlrEnc Valor de encargosVlrCor Valor das correçõesVlrOac Valor de outros acréscimosVlrOde Valor de outros descontosCotMcr Cotação da movimentação do contas a receberFilRlc Código da filial do título relacionado gerado ou aproveitadoNumRlc Número do título relacionado gerado ou aproveitadoTptRlc Tipo do título relacionado gerado ou aproveitadoSeqRlc Seqüência do movimento relacionado gerado ou aproveitadoCodFpg Código da forma de pagamentoNumDoc Número do documento para movimento da tesourariaTnsBxa Transação de movimentação na tesourariaSemJrs Ignora cálculo de juros, multa e desconto (0=não*, 1=sim) *Valor padrãoCtaFinCap(n)* Conta financeira do rateio da comissãoCtaRedCap(n)* Conta contábil reduzida do rateio da comissãoPerCtaCap(n)* Percentual do rateio da conta da comissãoCodCcuCap(n)* Código do centro de custo do rateio da comissãoPerRatCap(n)* Percentual do rateio da comissão* (n) = Seqüência incremental da linha do rateio, iniciando sem 1 (um) – Não utilizar os parênteses.

Retorno:Se o parâmetro TipRet (tipo de retorno da ação) for:- 0 (padrão): "OK"- 1: <SeqMov> (Seqüência do movimento gerado)

2.12.3 GRAVAR RATEIO TÍTULO CR

Ação:SID.Tcr.GravarRateio (FRCR)

Parâmetros obrigatórios:NumTit Número do títuloCodTpt Tipo do títuloCtaFin(n)* Conta financeira**CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custoPerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***PerRat(n)* Percentual do rateio***VlrRat(n)* Valor do rateio***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto


Retorno:"OK"


2.12.4 EXCLUIR TÍTULO CR

Ação:SID.Tcr.ExcluirTitulo (FRCR)


NumTit Número do títuloCodTpt Tipo do título

Parâmetros opcionais:TroPor Indicativo para trocar o portador (c/ o anterior) antes de excluir o título (0=não*, 1=sim)* Valor padrão

8/2/2019 SapiensSID


Retorno:"OK"

2.12.5 EXCLUIR BAIXA CR

Ação:SID.Tcr.ExcluirBaixa (FRCR)


NumTit Número do títuloCodTpt Tipo do títuloSeqMov Seqüência do movimento Retorno:"OK"

2.12.6 ALTERAR TÍTULO CR (SOMENTE DATA DE VENCIMENTO)

Ação:SID.Tcr.Alterar (FRCR)

Parâmetros obrigatórios:NumTit Número do títuloCodTpt Tipo do título

VctPro Vencimento prorrogado Parâmetros opcionais:ProJrs Indicativo se o vencimento da prorrogação possui juros (S/N)CodMpt Código do motivo de prorrogação do título

Retorno:"OK"

2.12.7 SELECIONAR TÍTULO CR

Esta ação SID é exclusiva da integração Sapiens Varejo e requer que a solução esteja corretamente implantadapara utilização.

Ação:SID.Tcr. SelecionarTitulosEmAbertoCliente (FRCR)


Parâmetros opcionais:NumTit Número do título a receberCodTpt Código do tipo de título a receberCodTns Código da transação do títuloDatPgt Data de previsão de pagamentoConJrs* Considerar juros (S=sim*/N=não)ConMul* Considerar multa (S=sim*/N=não)ConDsc* Considerar desconto (S=sim*/N=não)* Valor padrão

Retorno:<NomeColuna1>;<NomeColuna2>;<NomeColuna3>;... + LF<ValorColuna1>;<ValorColuna2>;<ValorColuna3>;... + LF

Campos de retorno:CodEmp Código da empresaCodFil Código da filialNumTit Número do títuloCodTpt Código do tipo do títuloCodCli Código do clienteNomCli Nome do clienteTitBan Número do título no bancoCodTns Código da transaçãoDatEmi Data da emissão do títuloNumCco Número da conta interna

VlrOri Valor original do títuloVlrAbe Valor em aberto do títuloVlrDsc Valor do descontoVlrJrs Valor dos jurosVlrMul Valor da multaVlrEnc Valor dos encargos

8/2/2019 SapiensSID


VlrCor Valor da correção monetária do títuloVlrOac Valor de outros acréscimos do títuloVlrOde Valor de outros descontos do títuloVlrMov Valor do movimento já calculado com juros, multa, desconto, etc.CodFpg Código da forma de pagamentoDiaAtr Número de dias de atrasoDiaJrs Número de dias de juros calculadosVctOri Vencimento original / prorrogado

2.12.8 PROCESSAR BAIXAS AUTOMÁTICAS

Ação:SID.Tcr.ProcessarBaixasAutomaticas (FRCR)

Parâmetros obrigatórios:DatMov Data da baixaCodTns Código da transação (recebimento)DatCxb Data de movimento (tesouraria)NumCco Código da conta internaTnsCxb Código da transação (tesouraria)LiqCre Total líquidoCodTpt Tipo de título a processarNumTit(n)* Títulos a processar* (n) = Seqüência incremental do título, iniciando sempre em 1 (um) – Não utilizar os parênteses.

Parâmetros opcionais:NroDoc Número do documentoTipVct Tipo de vencimento (1=provável pagamento*, 2=vencimento normal) *PadrãoCodFpg Código da forma de pagamentoVlrPgt(n)* Valor da baixa (informar somente quando for parcial) – o valor deOpcao Proceder baixa portador diferente de portador empresa(N=Bloqueia, S=Procede)* (n) = Seqüência incremental do título, deve coincidir com a seqüência do respectivo título

Retorno:"OK"

Observação:Todos os rateios deste processo devem ser pré-definidos sem confirmação (ou sem rateio). Os lançamentos na tesouraria

serão processados sempre com o valor da baixa (não há possibilidades de “dividir” os movimentos).

2.13 FINANÇAS – CONTAS A PAGAR

2.13.1 GRAVAR TÍTULO CP

Ação:SID.Tcp.Gravar (FPCP)

Parâmetros obrigatórios:NumTit Número do título a pagarCodTpt Código do tipo do título a pagarCodFor Código do fornecedor do título a pagarCodTns Código da transação origem do título a pagarDatEnt Data da entrada do título a pagarDatEmi Data de emissão do título a pagar

VctOri Data do vencimento original do título a pagarVlrOri Valor original do título a pagarVctPro Data do vencimento atual do título a pagarCodMoe Código da moeda base do título a pagarCodPor Código do portador do título a pagarCodCrt Código da carteira do título a pagar

Parâmetros opcionais:CodCrp Código do grupo de contas a pagarCodNtg Código da natureza de gastoCodTri Código de tributação para emissão da DARFObsTcp Observação para o títuloCodMpt Código do motivo de prorrogação do tituloCotEmi Valor da cotação da moeda na data de emissão do títuloDatDsc Data/Tolerância válidas para desconto do título

TolDsc Dias de tolerância para descontoPerDsc Percentual de desconto a ser concedido ao título a pagarVlrDsc Valor do desconto a ser concedido ao título a pagarPerJrs Percentual de juros de mora previsto para o título a pagarTipJrs Indicativo se o juros de mora é simples ou compostoJrsDia Valor dos juros de mora ao dia a serem pagos no título a pagar

8/2/2019 SapiensSID


TolJrs Quantidade de dias de tolerância para os juros de moraPerMul Percentual de multa prevista para o título a pagarTolMul Quantidade de dias de tolerância para a multa do título a pagarDatNeg Data base dos juros negociados data atéJrsNeg Valor dos juros negociadosMulNeg Valor da multa negociadaOutNeg Valor de outros valores negociadosTitBan Número do título a pagar no bancoCodFpg Código da forma de pagamentoCodUsu Código do Usuário Responsável pela Aprovação do Pagamento

DatApr Data da aprovação para o pagamentoVlrApr Valor base do título aprovado para o pagamentoPgtApr Data de aprovação para o pagamentoCotApr Valor da cotação da moeda na data de aprovação para pagamentoDscApr Valor dos descontos aprovadoOdeApr Valor de outros descontos aprovadoJrsApr Valor dos juros de mora aprovadoMulApr Valor da multa aprovadoEncApr Valor dos encargos aprovadoCorApr Valor da correção monetária aprovadaOacApr Valor de outros acréscimos aprovadoEmpApr Código da empresa da conta aprovadaCtaApr Número da conta interna aprovada para pagamento do tituloSeqApr Seqüência de junção de títulos pagos com mesmo chequeLibApr Data da liberação do cheque aprovado para pagamentoCodBan Código do banco da conta corrente do fornecedorCodAge Código da agência do banco da conta corrente do fornecedorCcbFor Número da conta corrente do fornecedor no bancoPorAnt Código do portador anteriorCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoFpgApr Código da forma de pagamento aprovadaCodBar Código de barra para pagamento eletrônicoUsuSit Usuário responsável pela alteração da situação do títuloNumArb Número de arquivo de remessa para bancoNumPrj Número interno do projetoCodFpj Código da fase do projetoDatPpt Data do provável pagamento do títuloCodFav Número do CNPJ ou CPF do favorecido

Retorno:"OK"


2.13.2 BAIXAR TÍTULO CP

Ação:SID.Tcp.Baixar (FPCP)

Parâmetros obrigatórios:NumTit Número do título a pagarCodTpt Código do tipo de título a pagarCodFor Código do fornecedorCodTns Código da transação de movimentoTnsCxb* Transação gerada no caixa e bancosNumCco* Número da conta interna financeiraSeqChe* Seq. controle junção de pagtos mesmo cheque. (identificador TES- 600SEQCH01)VlrMov Valor do movimento*Depende da parametrização

Parâmetros opcionais:TipRet Tipo de retorno da ação, quando bem sucedida (ver Retorno para mais detalhes)DatMov Data do movimento do título a pagar (Se estiver zerada recebe data atual)DatPgt Data do pagamento do título a pagar (Se estiver zerada recebe data atual)NumDoc Número do documento do movimento do título a pagarObsMcp Observação do movimento do contas a pagarCodFpg Código da forma de pagamentoCotMcp Valor da cotação da moeda na data base do movimento

DatLib Data de liberação do cheque (Se estiver zerada recebe data atual)VlrDsc Valor do desconto concedido ao pagamento do títuloVlrOde Valor de outros descontos do títuloVlrJrs Valor dos juros de mora pagoVlrMul Valor da multa pagoVlrEnc Valor dos encargos do título

8/2/2019 SapiensSID


VlrCor Valor da correção monetária do títuloVlrOac Valor de outros acréscimos do títuloNumPrj Número do projetoCodFpj Código da fase do projetoCtaFin Conta financeira reduzidaCtaRed Conta contábil reduzidaCodCcu Código do centro de custoTipPgt Tipo de pagamento do títuloCodBan Código do banco da conta corrente do fornecedorCodAge Código da agência do banco da conta corrente do fornecedor

CcbFor Número da conta corrente do fornecedor no bancoAgrPre Indicativo para agrupar sequência preparação de cheque (0=não*, 1=sim)* Valor padrão

Retorno:Se o parâmetro TipRet (tipo de retorno da ação) for:- 0 (padrão): "OK"- 1: <SeqMov> (Seqüência do movimento gerado)

2.13.3 GRAVAR RATEIO TÍTULO CP

Ação:SID.Tcp.GravarRateio (FPCP)


NumTit Número do títuloCodTpt Tipo do títuloCodFor Código do fornecedorCtaFin(n)* Conta financeira**CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custoPerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***PerRat(n)* Percentual do rateio***VlrRat(n)* Valor do rateio***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto


Retorno:"OK"


2.13.4 EXCLUIR TÍTULO CP

Ação:SID.Tcp.ExcluirTitulo (FPCP)

Parâmetros obrigatórios:NumTit Número do título

CodTpt Tipo do títuloCodFor Código do fornecedor

Retorno:"OK"

2.13.5 EXCLUIR BAIXA CP

Ação:SID.Tcp.ExcluirBaixa (FPCP)

Parâmetros obrigatórios:NumTit Número do títuloCodTpt Tipo do títuloCodFor Código do fornecedorSeqMov Sequência do movimento

Retorno:"OK"

8/2/2019 SapiensSID


2.14 FINANÇAS – TESOURARIA

2.14.1 GRAVAR MOVIMENTO (INCLUIR/ALTERAR)

Ação:SID.Tes.Gravar (FTCB)

Parâmetros obrigatórios:NumCco Conta interna

CodTns Código da transaçãoVlrMov* Valor do movimento

Parâmetros opcionais:DatMov Data do movimentoSeqMov Seqüência do movimentoDatCtb* Data contábil do movimentoDatLib* Data de liberação do movimentoCodNtg Código da natureza de gastosCodCcu Código do centro de custosCodDoc Código do tipo de documento para tesourariaDocMov* Número do documento do movimentoCtaRed Conta contábil reduzidaCtaFin Conta financeira reduzidaHisMov Histórico do movimento

NomRec* Nome do recebedor do chequeCplMov Complemento do histórico do movimentoSitMcc Situação do movimentoObsMcc Observação do movimentoNumPrj Código do projetoCodFpj Código da fase do projeto

Retorno:<SeqMov> Seqüência do movimento

Observações:* Campos disponíveis somente na inclusão

2.14.2 GRAVAR RATEIO DO MOVIMENTO

Ação:SID.Tes.GravarRateio (FTCB)

Parâmetros obrigatórios:NumCco Conta internaCodTns Código da transaçãoDatMov Data do movimentoSeqMov Seqüência do movimentoCtaFin(n)* Conta financeira**CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custoPerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***PerRat(n)* Percentual do rateio***VlrRat(n)* Valor do rateio***

NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Depende da parametrização.*** Informar apenas o percentual ou valor.

Parâmetros opcionais:ObsRat Observação do rateio

Retorno:"OK"

2.14.3 PROCESSAR MOVIMENTO (CHEQUE)

Ação:SID.Tes.ProcessarMvto (FTCB)

Parâmetros obrigatórios:NumCco Conta internaDatIni Data de emissão inicial da abrangência de movimentos a serem processadosDatFim Data de emissão final da abrangência de movimentos a serem processados

8/2/2019 SapiensSID


OriChe Origem (valores válidos: CP, CM, CA, FP, DR, DV)

Parâmetros opcionais:PrxNro Próximo númeroTipSel Tipo de sáida (0=Cheque, 1=Aviso débito, 3=Outros)

Retorno: “OK”

Observação:

Esta ação é baseada na tela F600ECH (Tesouraria – Geração de movimentos e emissão de cheques e avisos)

2.15 FINANÇAS – PROJETOS

2.15.1 GRAVAR LANÇAMENTO

Ação:SID.Prj.Gravar (FJCF)

Parâmetros obrigatórios:CodTns Código da transação do lançamento manualVlrMan Valor do movimento do lançamento manualNumPrj Número do projeto do lançamento manualCodFpj Código da fase do projeto do lançamento manualTipRec Tipo do recurso (1=Mater., 2=Serv., 3=Hum., 4=Patr., 5=Terc., 6=0utros, 7=Plano Fin.)

Parâmetros opcionais:DatGer Data da geração do registroTipMan Indicativo do tipo de lançamento (P=Previsto, R=Realizado, A=Ambos)DebCre Movimento é de Débito ou CréditoSomSub Somar ou subtrair o valor no plano financeiro/centro de custosDatMan Data base do lançamento manualDesMan Descrição do lançamento manualObsMan Observação do lançamento manualDocMan Número do documento do lançamentoCodNtg Código da natureza de gastoCodAgo Código de agrupamento do lançamentoQtdMan Quantidade do lançamento manualUniMan Código da unidade de medida do lançamento manualPreUni Preço unitário da movimentaçãoSeqRcp Seqüência dos recursos previstosCtaFin Conta financeira reduzida do lançamento manualCtaRed Conta contábil reduzida do lançamento manualCodCcu Código do centro de custos do lançamento manualUsuEnv Código do usuário envolvido no projeto/faseCodDep Código do depósito utilizado como recurso previstoCodPro Código do produto utilizadoCodDer Código da derivação do produto utilizadaCodSer Código do serviço utilizadoCodFor Código do fornecedor do produto/material ou serviçoCodBem Código do bem utilizadoSitMan Situação do lançamento manualNumLot Número do lote contábilCtaFin(n)* Conta financeira**

CtaRed(n)* Conta contábil reduzida**CodCcu(n)* Código do centro de custoPerCta(n)* Percentual do rateio da conta***VlrCta(n)* Valor do rateio da conta***PerRat(n)* Percentual do rateio***VlrRat(n)* Valor do rateio***NumPrj(n)* Número interno do projetoCodFpj(n)* Código da fase do projeto* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Depende da parametrização.*** Informar apenas o percentual ou valor.

Retorno:<SeqGer> Seqüência de geração do lançamento manual na data

2.15.2 EXCLUIR LANÇAMENTOAção:SID.Prj.Excluir (FJCF)


8/2/2019 SapiensSID


DatGer Data da geração do registroSeqGer Seqüência de geração do lançamento manual na data

Retorno:"OK"

2.16 CONTROLADORIA – TRIBUTOS - REDUÇÃO Z

2.16.1 GRAVAR TOTALIZADORES DA REDUÇÃO ZAção:SID.Rez.GravarTotalizador (CIEC)

Parâmetros obrigatórios:CodEqu Código do equipamento fiscal da redução ZDatRef Data de referência da redução ZNumMar Número do mapa resumoNumRez Número da redução Z

Parâmetros obrigatórios:VlrGtf Gran total do final do dia da redução ZVlrBru Valor bruto da redução ZVlrDsc Valor dos descontos da redução ZVlrCan Valor dos cancelamentos da redução ZVlrSer Valor dos serviços da redução ZVlrGti Gran total do início do dia da redução ZVlrAcr Valor dos acréscimos da redução ZConRei Valor acumulado no contador de reinício de operação

Retorno:"OK"

2.16.2 GRAVAR MOVIMENTOS DA REDUÇÃO Z

Ação:SID.Rez.GravarMovimento (CIEC)


CodEqu Código do equipamento fiscal da redução ZDatRef Data de referência da redução ZSigUfs Sigla do estado do movimento da redução ZCodTns Código da transação do movimento da redução ZNumCfi Número do primeiro cupom fiscal de referência da redução ZNumCff Número do último cupom fiscal de referência da redução ZCodSnf Código da série do movimento da redução ZVlrCtb Valor contábil do movimento da redução ZCodAgf Código de agrupamento para escrita fiscal

Parâmetros opcionais:SitCfi Situação do movimento da redução ZCliCon Indicativo se o cliente é contribuinteCodEdc Espécie de documento da redução Z para fins fiscaisCodTrd Código do tipo de ICMS reduzido do movimento da redução ZPerIcm Percentual do ICMS do movimento da redução ZVlrBic Valor base do ICMS do movimento da redução ZVlrIcm Valor do ICMS do movimento da redução ZVlrIic Valor isento ICMS do movimento da redução ZVlrOic Valor outros ICMS do movimento da redução ZPerIpi Percentual de IPI do movimento da redução ZVlrBip Valor base do IPI do movimento da redução ZVlrIpi Valor do IPI do movimento da redução ZVlrIip Valor isento de IPI do movimento da redução ZVlrOip Valor outros IPI do movimento da redução ZPerIss Percentual do ISS do movimento da redução ZVlrBis Valor base do ISS do movimento da redução ZVlrIss Valor do ISS do movimento da redução ZVlrDsc Valor do desconto do movimento da redução ZVlrAcr Valor do acréscimo do movimento da redução ZObsRez Observação do movimento da redução Z

NumLot Número do lote contábilCtaRed Conta contábil reduzidaSitTri Situação Tributária dos Itens do Cupom FiscalCodFpg Código da forma de pagamentoPerPit Percentual do PIS faturamentoVlrBpt Base de cálculo do PIS faturamento

8/2/2019 SapiensSID


AliPif Alíquota por Valor do PISQtdBpf Quantidade da Base do PISVlrPit Valor do PIS faturamentoPerCrt Percentual do COFINS faturamentoVlrBct Base de cálculo do COFINS faturamentoAliCff Alíquota por Valor do COFINSQtdBcf Quantidade da Base do COFINSVlrCrt Valor do COFINS faturamentoCstPis Código da Situação Tributária do PISCstCof Código da Situação Tributária do COFINS

Retorno:<SeqRez> Seqüência de lançamento do movimento da redução Z

2.16.3 GRAVAR RATEIOS DOS MOVIMENTOS DA REDUÇÃO Z

Ação:SID.Rez.GravarRateio (CIEC)

Parâmetros obrigatórios:CodEqu Código do equipamento fiscal da redução ZDatRef Data de referência da redução ZSeqRez Seqüência de lançamento do movimento da redução Z

CriRat Critério utilizado para o Rateio

Parâmetros opcionais:SeqRat Seqüência do RateioDatBas Data base contábil e financeiraCtaRed Conta contábil reduzidaPerCta Percentual rateado para a contaVlrCta Valor rateado para a contaCodCcu Código do centro de custosPerRat Percentual rateado para o centro de custosVlrRat Valor rateado para o centro de custosObsRat Observação do rateio

Retorno:<SeqRat> Seqüência do Rateio

2.16.4 GRAVAR ITENS DA REDUÇÃO Z

Ação:SID.Rez.GravarItem (CIEC)

Parâmetros obrigatórios:CodEqu Código do equipamento fiscal da redução ZDatRef Data de referência da redução ZSeqRez Seqüência de lançamento do movimento da redução ZNumCfi Número do cupom fiscal de referência do itemVlrCtb Valor contábil do item no movimento do cupom fiscal

Parâmetros opcionais:PerIcm Percentual do ICMS do item no movimento do cupom fiscal

VlrBic Valor base do ICMS do item no movimento do cupom fiscalVlrIcm Valor do ICMS do item no movimento do cupom fiscalVlrIic Valor isento ICMS do item no movimento do cupom fiscalVlrOic Valor outros ICMS do item no movimento do cupom fiscalPerIpi Percentual de IPI do item no movimento do cupom fiscalVlrBip Valor base do IPI do item no movimento do cupom fiscalVlrIpi Valor do IPI do item no movimento do cupom fiscalVlrIip Valor isento de IPI do item no movimento do cupom fiscalVlrOip Valor outros IPI do item no movimento do cupom fiscalPerIss Percentual do ISS do item no movimento do cupom fiscalVlrBis Valor base do ISS do item no movimento do cupom fiscalVlrIss Valor do ISS do item no movimento do cupom fiscalVlrDsc Valor do desconto do item no movimento do cupom fiscalVlrAcr Valor do acréscimo do item no movimento do cupom fiscalObsItr Observação do item no movimento do cupom fiscalCodPro Código do ProdutoCodDer Código da DerivaçãoCodSer Código do ServiçoQtdIte Quantidade do ItemPerPit Percentual do PIS faturamentoVlrBpt Base de cálculo do PIS faturamento

8/2/2019 SapiensSID


AliPif Alíquota por Valor do PISQtdBpf Quantidade da Base do PISVlrPit Valor do PIS faturamentoPerCrt Percentual do COFINS faturamentoVlrBct Base de cálculo do COFINS faturamentoAliCff Alíquota por Valor do COFINSQtdBcf Quantidade da Base do COFINSVlrCrt Valor do COFINS faturamentoCstPis Código da Situação Tributária do PISCstCof Código da Situação Tributária do COFINS

Retorno:<SeqIte> Seqüência do item no movimento do cupom fiscal

2.17 CONTROLADORIA – TRIBUTOS – NOTA FISCAL COMPRA

2.17.1 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)

Ação:SID.Nic.Gravar (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de entradaCodTns Código da transação de entradaCodAgf Código do Agrupamento fiscalDatEmi Data de EmissãoCodAgf Código de agrupamento para escrita fiscal

Parâmetros opcionais:DatEnt Data de EntradaNopOpe Natureza de operaçãoCodEdc Espécie de documento para fins fiscaisObsNfc Observação lançamento de ICMSObsIpi Observação lançamento de IPIVlrCtb Valor contábil da nota fiscalVlrBic Valor base do ICMSPerIcm Percentual do ICMSVlrIcm Valor do ICMSVlrOic Valor outros ICMSVlrIic Valor isento ICMSVlrDai Diferença de Alíquota Interestadual do ICMSVlrBip Valor base do IPIVlrIpi Valor do IPIVlrBid Valor base IPI destacado/presumido (50% compra no comércio)VlrIpd Valor do IPI destacado/presumido (50% compra no comércio)VlrOip Valor outros IPIVlrIip Valor isento IPIVlrBir Valor base do IRRFPerIrf Percentual do IRRFVlrIrf Valor do IRRFCtaRed Código da conta contábil

CodCpg Código da condição de pagamentoVlrBsi Valor base do ICMS substituídoVlrSic Valor do ICMS substituídoVlrBpr Base de cálculo do PIS a recuperarVlrPir Valor do PIS a recuperarVlrBcr Base de cálculo do COFINS a recuperarVlrCor Valor do COFINS a recuperarVlrDsc Valor do DescontoSitNfc Situação da nota fiscalPerCrt Percentual do COFINS RetidoVlrBct Valor Base do COFINS RetidoVlrCrt Valor do COFINS RetidoPerPit Percentual do PIS RetidoVlrBpt Valor Base do PIS RetidoVlrPit Valor PIS Retido

PerCsl Percentual da CSLLVlrBcl Valor Base da CSLLVlrCsl Valor da CSLLPerOur Percentual das Outras RetençõesVlrBor Valor Base das Outras RetençõesVlrOur Valor das Outras Retenções

8/2/2019 SapiensSID


PerIss Percentual do ISSVlrBis Valor Base do ISSVlrIss Valor do IssPerIns Percentual do INSSVlrBin Valor Base do INSSVlrIns Valor do INSSVlrBpf Valor Base do PIS FaturamentoVlrPif Valor do PIS FaturamentoVlrBcf Valor Base do COFINS FaturamentoVlrCff Valor do COFINS Faturamento

VlrBsd Valor base do ICMS substituído destacadoVlrIsd Valor do ICMS substituído destacadoVlrBsp Valor base da substituição do PISVlrStp Valor da substituição do PISVlrBsc Valor base da substituição do COFINSVlrStc Valor da substituição do COFINSVlrBfu Valor base do FunruralPerFun Percentual do FunruralVlrFun Valor do FunruralCodTri Código de tributação para emissão da DARFTipNfe Tipo de nota fiscal de entradaVlrFre Valor do frete da nota fiscal de entradaCifFob Indicativo se o valor do frete é CIF ou FOBVlrSeg Valor do seguro da nota fiscal de entradaVlrDac Valor das despesas acessóriasCodCcu Código do centro de custoCodTra Código da transportadora da nota fiscal de entradaCodVia Via de transporte da nota fiscal de entradaPlaVei Placa do veículo de transporte das mercadorias da nota fiscal de entradaPreImp Número pré-impresso no formulário da nota fiscalCodTic Código do ICMS especialCodTrd Código de redução de impostosVlrBii Valor base do imposto de importaçãoVlrIim Valor do imposto de importaçãoVlrBie Valor base do INSS parte empresaVlrIem Valor do INSS parte empresaNumDoi Número do documento de importaçãoVlrRis Valor de retenção de ICMS substitutoDatDoi Data do registro do documento de importaçãoCodSel Código da série legal da nota fiscal de entradaCodSsl Código da sub-série legal da nota fiscal de entrada

SeqOrm Seqüência do endereço de origem da mercadoriaPesBru Peso bruto da nota fiscal de entradaPesLiq Peso liquido da nota fiscal de entradaPerIcf Percentual de ICMS sobre o freteIcmFre Valor de ICMS sobre o freteSomFre Somar o valor do frete no valor da nota fiscalCodMs1 Código da mensagem 1CodMs2 Código da mensagem 2CodMs3 Código da mensagem 3CodMs4 Código da mensagem 4ChvNel Chave de acesso da nota fiscal eletrônicaUfsCic Sigla do estado base para o cálculo do ICMSEquRez Código do equipamento fiscal da redução Z devolvidaDatRez Data de referência da redução Z devolvidaCfiRez Número do cupom fiscal de referência da redução Z devolvida

VlrFei Valor de frete de importaçãoVlrSei Valor do seguro de importaçãoVlrOui Valor de outras despesas de importaçãoQtdBip Quantidade da Base do IPIQtdBpi Quantidade da Base do PIS a recuperarQtdBco Quantidade da Base do COFINS a recuperarQtdBpf Quantidade da Base do PIS por faturamento (Estorno devolução)QtdBcf Quantidade da Base do COFINS por faturamento (Estorno devolução)VlrSub Valor Subsídio

Retorno:"OK"

2.17.2 GRAVAR RATEIOS DOS DADOS GERAIS

Ação:SID.Nic.GravarRateio (CIEC)

Parâmetros obrigatórios:CodFor Código do FornecedorNumNfi Número inicial da nota fiscal de entrada

8/2/2019 SapiensSID


NumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal saídaCodTns TransaçãoCriRat Critério utilizado para rateio

Parâmetros opcionais:SeqRat Seqüência do rateioDatBas Data base contábil e financeiraCtaRed Conta contábil reduzidaPerCta Percentual rateado para a conta

VlrCta Valor rateado para a contaCodCcu Código do centro de custosPerRat Percentual rateado para o centro de custosVlrRat Valor rateado para o centro de custosObsRat Observação do rateio


2.17.3 GRAVAR ITEM (INCLUIR/ALTERAR)

Ação:SID.Nic.GravarItem (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de entradaCodTns Código da transação de entradaSeqInc* Seqüência de lançamento do item* Opcional na inclusão

Parâmetros opcionais:CodPro Código do produtoCodDer Código da derivação do produtoCplPro Descrição complementar do produto ou serviçoCodClf Código interno da classificação fiscalClaFis Código da classificação fiscal - NCMQtdEnt Quantidade de entrada do produtoUniMed Unidade de medida da quantidade do produtoPreUni Preço unitário do item da nota fiscal de entradaVlrBic Valor base do ICMSPerIcm Percentual do ICMSVlrIcm Valor do ICMSVlrIic Valor isentas ICMSVlrOic Valor outras ICMSVlrBip Valor base do IPIPerIpi Percentual de IPIVlrIpi Valor do IPIVlrIip Valor isentas IPIVlrOip Valor outras IPIVlrBid Valor base do IPI presumidoVlrIpd Valor do IPI presumidoVlrBsi Valor base do ICMS substituído

VlrCip Valor do ICMS não creditado no CIAPSitCip Situação do CIAPDatIna Data da inativação do item para o cálculo do CIAPObsIna Observação ou motivo da inativação do item para o cálculo do CIAPSeqIpc Seqüência do item na nota fiscal de entradaVlrDsc Valor do desconto do itemCodStr Situação tributária do item da nota fiscal de entradaCodTrd Código de redução do ICMSCodSer Código do item de serviço da nota fiscal de entradaVlrCtb Valor contábil do item da nota fiscalCtaRed Conta contábil reduzidaFilNfv Código da filial da nota fiscal de saídaNumNfv Número da nota fiscal de saídaSnfNfv Série da nota fiscal de saídaSeqIpv Seqüência do item da nota fiscal de saída

VlrDac Valor das despesas acessórias (embalagem, encargos, outras despesas)CodTst Código do ICMS substituídoPerIim Percentual de imposto de importação do item da nota fiscal de entradaVlrBii Valor base imposto de importaçãoVlrIim Valor do imposto de importação do item da nota fiscal de entradaVlrRis Valor de retenção de ICMS Substituto

8/2/2019 SapiensSID


CodBem Código do bemPesEnt Peso na entradaDifPes Diferença de pesoBasDif Base de cálculo de ICMS da diferença de pesoNfiPro Nota fiscal do produtorVlrBsi Valor base do ICMS substituídoVlrSic Valor do ICMS substituídoPerIrf Percentual do IRRFVlrBir Valor Base do IRRFVlrIrf Valor do IRRF

PerCrt Percentual do COFINS RetidoVlrBct Valor Base do COFINS RetidoVlrCrt Valor do COFINS RetidoPerPit Percentual do PIS RetidoVlrBpt Valor Base do PIS RetidoVlrPit Valor do PIS RetidoPerCsl Percentual da CSLLVlrBcl Valor Base da CSLLVlrCsl Valor da CSLLPerOur Percentual das Outras RetençõesVlrBor Valor Base da Outras RetençõesVlrOur Valor das Outras RetençõesPerIss Percentual do ISSVlrBis Valor Base do ISSVlrIss Valor do ISSPerIns Percentual do INSSVlrBin Valor Base do INSSVlrIns Valor do INSSVlrBpr Valor Base do PIS a RecuperarVlrPir Valor do PIS a RecuperarVlrBcr Valor Base do COFINS a RecuperarVlrCor Valor do COFINS a RecuperarCstIpi Código da Situação Tributária IPICstPis Código da Situação Tributária PISCstCof Código da Situação Tributária COFINSCodCcu Código do centro de custoCodCli Código do clienteTnsNfv Código da transaçãoNffNfv Seqüencial de lançamento da nota fiscalVlrDai Diferença de alíquota interestadual do ICMSVlrBsd Valor base do ICMS substituído destacado

VlrIsd Valor do ICMS substituído destacadoVlrBsp Valor base para cálculo da substituição do PISVlrStp Valor da substituição do PISVlrBsc Valor base da substituição do COFINSVlrStc Valor da substituição do COFINSVlrBfu Valor base do FunruralPerFun Percentual do FunruralVlrFun Valor do FunruralVlrSeg Valor do seguroVlrFre Valor do freteVlrBpr Base de cálculo do PIS a recuperarVlrPir Valor do PIS a recuperarVlrBcr Base de cálculo do COFINS a recuperarVlrCor Valor do COFINS a recuperarVlrBie Valor base do INSS parte empresa

VlrIem Valor do INSS parte empresaPerPif Percentual do PIS FaturamentoVlrBpf Valor base do PIS FaturamentoVlrPif Valor do PIS FaturamentoPerCff Percentual do COFINS faturamentoVlrBcf Valor base do COFINS faturamentoVlrCff Valor do COFINS faturamentoCodDfs Código do dispositivo fiscalVlrAjs Valor do ajuste do item referente ao dispositivo fiscalVlrFei Valor de frete de importaçãoVlrSei Valor do seguro de importaçãoVlrOui Valor de outras despesas de importaçãoQtdBip Quantidade da Base do IPIAliIpi Alíquota por Valor do IPIQtdBpi Quantidade da Base do PIS a recuperar

AliPis Alíquota por Valor do PIS a recuperarQtdBco Quantidade da Base do COFINS a recuperarAliCof Alíquota por Valor do COFINS a recuperarQtdBpf Quantidade da Base do PIS por faturamento (Estorno devolução)AliPif Alíquota por Valor do PIS por faturamento (Estorno devolução)QtdBcf Quantidade da Base do COFINS por faturamento (Estorno devolução)

8/2/2019 SapiensSID


AliCff Alíquota por Valor do COFINS por faturamento (Estorno devolução)VlrSub Valor Subsídio

Retorno:<SeqInc>

2.17.4 EXCLUIR ITEM

Ação:SID.Nic.ExcluirItem (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de entradaCodTns Código da transação de entradaSeqInc Seqüência de lançamento do item

Retorno:"OK"

2.17.5 GRAVAR PARCELA COMPRA (INCLUIR/ALTERAR)

Ação:

SID.Nic.GravarParcelaCompra (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaVctPar Data de Vencimento da Parcela da Nota Fiscal de entradaVlrPar Valor da Parcela da Nota Fiscal de entrada

Parâmetros Opcionais:CodPar Seqüência de parcelas da Nota Fiscal de entradaNumTit Número do título a ser gerado no Contas a PagarCodTpt Código do tipo de título a ser gerado no Contas a PagarObsPar Texto da observação

Retorno:<CodPar>

2.17.6 EXCLUIR PARCELA COMPRA

Ação:SID.Nic.ExcluirParcelaCompra (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaCodPar Seqüência de parcelas da Nota Fiscal de entrada

Retorno:

“OK”

2.17.7 GRAVAR ENTRADA, VENCIMENTO, LOTE E SÉRIE (INCLUIR/ALTERAR)

Ação:SID.Nic.GravarEntardaVencimentoLoteSerie (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaSeqIpc Seqüência do item da Nota Fiscal de Entrada

Parâmetros Opcionais:

SeqDls Seqüência de movimento de itemCodDep Código do DepósitoDatEnt Data da Entrada do Produto no depósitoDatFab Data de Fabricação do loteDatVlt Data de Validade do produto no depósitoCodLot Código do Lote de fabricação para estocagem

8/2/2019 SapiensSID


NumSeq Número de série do produtoQtdEst Quantidade a ser movimentada do estoqueObsDls Texto da observação

Retorno:<SeqDls>

2.17.8 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SÉRIE

Ação:

SID.Nic.ExcluirEntardaVencimentoLoteSerie (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaSeqIpc Seqüência do item da Nota Fiscal de EntradaSeqDls Seqüência de movimento de item

Retorno: “OK”

2.17.9 GRAVAR LIGAÇÃO ENTRE ITENS (INCLUIR/ALTERAR)

Ação:SID.Nic.GravarLigacaoItens (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entradaSeqIpc Seqüência do item da Nota Fiscal de EntradaEmpRlc Empresa da Nota Fiscal relacionadaFilRlc Filial da Nota Fiscal relacionadaForRlc Código do Fornecedor da Nota Fiscal de entrada relacionadaSnfRlc Série da Nota Fiscal relacionadaNfcRlc Número da Nota Fiscal de entrada relacionadaIncrlc Seqüência do item de produto relacionado

Parâmetros OpcionaisSeqLni Seqüência de ligação

Retorno:<SeqLni>

2.17.10 EXCLUIR LIGAÇÃO ENTRE ITENS

Ação:SID.Nic.ExcluirLigacaoItens (CIEC)

Parâmetros obrigatórios:CodFor Código do fornecedor da nota fiscal de entradaCodSnf Código da série da nota fiscal de entradaNumNfi Número inicial da nota fiscal de entrada

SeqIpc Seqüência do item da Nota Fiscal de EntradaSeqLni Seqüência de ligação

Retorno: “OK”

2.18 CONTROLADORIA – TRIBUTOS – NOTA FISCAL VENDA

2.18.1 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)

Ação:

SID.Niv.Gravar (CIEC)

Parâmetros obrigatórios:CodCli Código do cliente da nota fiscal de saídaNumNfi Número inicial da nota fiscal de saídaNumNff Seqüencial de lançamento da nota fiscal

8/2/2019 SapiensSID


CodSnf Código da série da nota fiscal de saídaCodTns Código da transação de saídaCodAgf Código do Agrupamento FiscalDatEmi Data de emissão da nota fiscal de saídaCodAgf Código de agrupamento para escrita fiscal

Parâmetros opcionais:NopOpe Natureza de operação de saídaObsNfv Observação lançamento de ICMSObsIpi Observação lançamento de IPI

DatSai Data da saída da nota fiscal de saídaCodEdc Espécie de documento para fins fiscaisVlrCtb Valor contábil da nota fiscalVlrBic Valor base do ICMSPerIcm Percentual do ICMSVlrIcm Valor do ICMSVlrOic Valor outros ICMSVlrIic Valor isento ICMSVlrBip Valor base do IPIVlrIpi Valor do IPIVlrOip Valor outros IPIVlrIip Valor isento IPIVlrBsi Valor base do ICMS SubstituídoVlrSic Valor do ICMS SubstituídoVlrBsd Valor base ICMS substituído destacadoVlrIsd Valor ICMS substituído destacadoVlrBis Valor base do ISSPerIss Percentual do ISSVlrIss Valor do ISSVlrBir Valor base do IRRFPerIrf Percentual do IRRFVlrIrf Valor do IRRFVlrBin Valor base do INSSPerIns Percentual do INSSVlrIns Valor do INSSCtaRed Código da conta contábilCodCpg Código da condição de pagamentoVlrBpr Base de cálculo do PIS a recuperar (estorno por devolução)VlrPir Valor do PIS a recuperar (estorno por devolução)VlrBcr Base de cálculo do COFINS a recuperar (estorno por devolução)VlrCor Valor do COFINS a recuperar (estorno por devolução)

VlrDsc Valor do DescontoSitNfv Situação da nota fiscalPerCrt Percentual do COFINS RetidoVlrBct Valor Base do COFINS RetidoVlrCrt Valor do COFINS RetidoPerPit Percentual do PIS RetidoVlrBpt Valor Base do PIS RetidoVlrPit Valor do PIS RetidoPerCsl Percentual da CSLLVlrBcl Valor Base da CSLLVlrCsl Valor da CSLLPerOur Percentual das Outras RetençõesVlrBor Valor Base das Outras RetençõesVlrOur Valor das Outras RetençõesVlrBpf Valor Base do PIS Faturamento

VlrPif Valor do PIS FaturamentoVlrBcf Valor Base do COFINS FaturamentoVlrCff Valor do COFINS FaturamentoCodRai Código da cidade para recolhimento do ISSVlrDai Valor da diferença de alíquota interestadual do ICMSVlrBid Valor base IPI destacado / presumidoVlrIpd Valor do IPI destacado / presumidoVlrBsp Valor base da substituição do PISVlrStp Valor da substituição do PISVlrBsc Valor base da substituição do COFINSVlrStc Valor da substituição do COFINSVlrBfu Valor base do FunruralPerFun Percentual do FunruralVlrFun Valor do FunruralCodTri Código de tributação para emissão da DARF

PerIcf Percentual do ICMS sobre o freteIcmFre Valor do ICMS sobre o freteTipNfs Tipo da nota fiscal de saídaVlrFre Valor do freteCifFob Indicativo se o valor do frete é CIF ou FOBVlrSeg Valor do seguro

8/2/2019 SapiensSID


VlrDac Valor das despesas acessóriasCodCcu Código do centro de custoRemDes Indicativo se o cliente da transportadora é remetente, destinatário ou consignatárioTipRde Indicativo do tipo de pessoa do remetente/destinatárioCgcRde Número do CNPJ/CPF do remetente/destinatárioInsRde Inscrição estadual do remetente/destinatárioEstRde Sigla do estado do remetente/destinatárioMunRde Cidade do remetente/destinatárioCodTra Código da transportadora da nota fiscal de saídaCodVia Via de transporte da nota fiscal de saída

PlaVei Placa do veículo de transporte das mercadoriasUfsVei Sigla do estado do veículo de transporte das mercadoriaskmtDis Distância em quilômetros a percorrer com o veículo de transporte das mercadoriasForCal Indicativo da forma de cálculo do valor do fretePreImp Número pré-impresso no formulário da nota fiscalSelFis Número do selo fiscal de segurançaCodCl1 Código do cliente 1CodCl2 Código do cliente 2CodTic Código do ICMS especialCodTrd Código de redução de impostosVlrBii Valor base de imposto de importaçãoVlrIim Valor do imposto de importaçãoVlrRis Valor de retenção de ICMS substitutoNumRde Número do registro de exportaçãoPesBru Peso brutoPesLiq Peso líquidoDatCex Data do comprovante de exportaçãoNumNsu Número seqüencial únicoDatNsu Data de geração do número seqüencial únicoHorNsu Hora de geração do número seqüencial únicoSisMex Tipo do siscomexSomFre Somar o valor do frete no valor da nota fiscalCodMs1 Código da mensagem 1CodMs2 Código da mensagem 2CodMs3 Código da mensagem 3CodMs4 Código da mensagem 4SeqEnt Seqüência do endereço de entrega do clienteCodFpg Código da forma de pagamentoSeqPco Seqüência do endereço do participante da coletaSeqPen Seqüência do endereço do participante da entregaEquRez Código do equipamento fiscal da redução Z

DatRez Data de referência da redução ZCfiRez Número do cupom fiscal de referência da redução ZTotCid Total do Imposto CIDEQtdBip Quantidade da Base do IPIQtdBpf Quantidade da Base do PIS por faturamentoQtdBcf Quantidade da Base do COFINS por faturamentoQtdBpi Quantidade da Base do PIS a recuperar (Estorno devolução)QtdBco Quantidade da Base do COFINS a recuperar (Estorno devolução)QtdEmb Quantidade de embalagens da nota fiscalHorSai Hora da saída das mercadorias da nota fiscal de saídaVlrSub Valor Subsídio

Retorno:"OK"

2.18.2 GRAVAR RATEIOS DOS DADOS GERAIS

Ação:SID.Niv.GravarRateio (CIEC)

Parâmetros obrigatórios:CodCli Código do ClienteNumNfi Número inicial da nota fiscal de entradaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal saídaCodTns TransaçãoCriRat Critério utilizado para rateio

Parâmetros opcionais:SeqRat Seqüência do rateioDatBas Data base contábil e financeira

CtaRed Conta contábil reduzidaPerCta Percentual rateado para a contaVlrCta Valor rateado para a contaCodCcu Código do centro de custosPerRat Percentual rateado para o centro de custosVlrRat Valor rateado para o centro de custos

8/2/2019 SapiensSID


ObsRat Observação do rateio


2.18.3 GRAVAR ITEM (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarItem (CIEC)

Parâmetros obrigatórios:CodCli Código do cliente da nota fiscal de saídaNumNfi Número inicial da nota fiscal de saídaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de saídaCodTns Código da transação de saídaSeqInv* Seqüência de lançamento do item* Opcional na inclusão

Parâmetros opcionais:CodPro Código do produtoCodDer Código da derivação do produtoCplPro Descrição complementar do produto ou serviçoCodClf Código interno da classificação fiscalClaFis Código da classificação fiscal - NCM

QtdEnt Quantidade de saída do produtoUniMed Unidade de medida da quantidade do produtoPreUni Preço unitário do item da nota fiscal de saídaVlrBic Valor base do ICMSPerIcm Percentual do ICMSVlrIcm Valor do ICMSVlrIic Valor isentas ICMSVlrOic Valor outras ICMSVlrBip Valor base do IPIPerIpi Percentual de IPIVlrIpi Valor do IPIVlrIip Valor isentas IPIVlrOip Valor outras IPIVlrBid Valor base IPI destacado/presumido (50% compra no comércio)VlrIpd Valor do IPI destacado/presumido (50% compra no comércio)VlrBsi Valor base do ICMS substituídoSeqIpv Seqüência do item na nota fiscal de saídaVlrDsc Valor do desconto do itemCodStr Situação tributária do item da nota fiscal de saídaCodTrd Código de redução do ICMSCodSer Código do item de serviço da nota fiscal de saídaVlrCtb Valor contábil do item da nota fiscalCtaRed Conta contábil reduzidaFilNfc Código da filial da nota fiscal de entradaCodFor Fornecedor da nota fiscal de entradaNumNfc Número da nota fiscal de entradaSnfNfc Código da série da nota fiscal de entradaSeqIpc Seqüência do item da nota fiscal de entradaVlrDac Valor das despesas acessórias (embalagem, encargos, outras despesas)CodTst Código do ICMS substituídoPerIim Percentual do imposto de importação do item da nota fiscal de saída

VlrBii Valor base imposto de importaçãoVlrIim Valor do imposto de importação do item da nota fiscal de saídaVlrRis Valor de retenção de ICMS SubstitutoCodBem Código do bemSeqNfi Seqüência do item na nota fiscal impressaPerIrf Percentual do IRRFVlrBir Valor Base do IRRFVlrIrf Valor do IRRFPerCrt Percentual do COFINS RetidoVlrBct Valor Base do COFINS RetidoVlrCrt Valor do COFINS RetidoPerPit Percentual do PIS RetidoVlrBpt Valor Base do PIS RetidoVlrPit Valor do PIS RetidoPerCsl Percentual da CSLL

VlrBcl Valor Base da CSLLVlrCsl Valor da CSLLPerOur Percentual das Outras RetençõesVlrBor Valor Base das Outras RetençõesVlrOur Valor das Outras RetençõesPerIss Percentual do ISS

8/2/2019 SapiensSID


VlrBis Valor Base do ISSVlrIss Valor do ISSPerIns Percentual do INSSVlrBin Valor Base do INSSVlrIns Valor do INSSVlrBpr Valor Base do PIS a RecuperarVlrPir Valor do PIS a RecuperarVlrBcr Valor Base do COFINS a RecuperarVlrCor Valor do COFINS a RecuperarCstIpi Código da Situação Tributária IPI

CstPis Código da Situação Tributária PISCstCof Código da Situação Tributária COFINSCodCcu Código do centro de custoTnsNfc Código da transaçãoNffNfc Seqüencial de lançamento da nota fiscalDesImp Descrição do produto para impressãoVlrDai Valor da diferença de alíquota interestadual do ICMSVlrSic Valor do ICMS substituídoVlrBsd Valor base ICMS substituído destacadoVlrIsd Valor do ICMS substituído destacadoVlrBsp Valor base da substituição do PISVlrStp Valor da substituição do PISVlrBsc Valor base da substituição do COFINSVlrStc Valor da substituição do COFINSVlrBfu Valor base do FunruralPerFun Percentual do FunruralVlrFun Valor do FunruralVlrFre Valor do freteVlrSeg Valor do seguroVlrBpr Base de cálculo do PIS a recuperarVlrPir Valor do PIS a recuperarVlrBcr Base do cálculo do COFINS a recuperarVlrCor Valor do COFINS a recuperarPerPif Percentual do PIS FaturamentoVlrBpf Valor base do PIS FaturamentoVlrPif Valor do PIS FaturamentoPerCff Percentual do COFINS FaturamentoVlrBcf Valor base do COFINS FaturamentoVlrCff Valor do COFINS FaturamentoNumRde Número do registro de exportaçãoCodDfs Código do dispositivo fiscal

VlrAjs Valor do ajuste do item referente ao dispositivo fiscalVlrCid Valor Unitário do Imposto CIDETotCid Total do Imposto CIDEQtdBip Quantidade da Base do IPIAliIpi Alíquota por Valor do IPIQtdBpf Quantidade da Base do PIS por faturamentoAliPif Alíquota por Valor do PIS por faturamentoQtdBcf Quantidade da Base do COFINS por faturamentoAliCff Alíquota por Valor do COFINS por faturamentoQtdBpi Quantidade da Base do PIS a recuperar (Estorno devolução)AliPis Alíquota por Valor do PIS a recuperar (Estorno devolução)QtdBco Quantidade da Base do COFINS a recuperar (Estorno devolução)AliCof Alíquota por Valor do COFINS a recuperar (Estorno devolução)VlrSub Valor Subsídio

Retorno:<SeqInv>

2.18.4 EXCLUIR ITEM

Ação:SID.Niv.ExcluirItem (CIEC)

Parâmetros obrigatórios:CodCli Código do cliente da nota fiscal de saídaNumNfi Número inicial da nota fiscal de saídaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de saídaCodTns Código da transação de saídaSeqInv Seqüência de lançamento do item

Retorno:"OK"

8/2/2019 SapiensSID


2.18.5 GRAVAR CONHECIMENTO DE TRANSPORTE (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarTransporte (CIEC)

Parâmetros obrigatórios:CodCli Código do cliente da nota fiscal de saídaNumNfi Número inicial da nota fiscal de saídaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de saída

CodTns Código da transação de saídaDatEmi Data de emissão da Nota Fiscal transportadaCodEdc Código de documento da Nota Fiscal transportadaCodSel Código da Série Legal da Nota Fiscal transportadaNumNft Número da Nota fiscal transportadaVlrTot Valor total da Nota Fiscal transportadaQtdMer Quantidade das Mercadorias da Nota Fiscal transportadaUniMed Unidade de medida das Mercadorias da Nota Fiscal transportada

Parâmetros OpcionaisSeqCct Seqüência da composição do conhecimento de transporteCodSsl Código da Sub-série Legal da Nota Fiscal transportadaChvNel Chave de acesso da NF-e transportadaVlrMer Valor total da mercadoria da Nota Fiscal transportadaPesBru Peso Bruto da Nota Fiscal transportada

PesLiq Peso Líquido da Nota Fiscal transportada

Retorno:<SeqCct>

2.18.6 EXCLUIR CONHECIMENTO DE TRANSPORTE

Ação:SID.Niv.ExcluirTransporte (CIEC)

Parâmetros obrigatórios:CodCli Código do cliente da nota fiscal de saídaNumNfi Número inicial da nota fiscal de saídaNumNff Seqüencial de lançamento da nota fiscalCodSnf Código da série da nota fiscal de saída

CodTns Código da transação de saídaSeqCct Seqüência da composição do conhecimento de transporte

Retorno: “OK”

2.18.7 GRAVAR PARCELAS DE VENDA (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarParcelaVenda (CIEC)

Parâmetros obrigatórios:CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saída

VctPar Data de Vencimento da parcela da Nota Fiscal de saídaVlrPar Valor da Parcela da Nota Fiscal de saída

Parâmetros OpcionaisCodPar Seqüência de parcelas da Nota FiscalNumTit Número do título a ser gerado no Contas a ReceberCodTpt Código do Tipo de Título a ser gerado no Contas a ReceberObsPar Texto da Observação

Retorno:<CodPar>

2.18.8 EXCLUIR PARCELAS DE VENDA

Ação:

SID.Niv.ExcluirParcelaVenda (CIEC)

Parâmetros obrigatórios:CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saídaCodPar Seqüência de parcelas da Nota Fiscal

8/2/2019 SapiensSID


Retorno: “OK”

2.18.9 GRAVAR ENTRADA, VENCIMENTO, LOTE E SÉRIE (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarEntradaVencimentoLoteSerie (CIEC)

Parâmetros obrigatórios:CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saídaSeqIpv Seqüência do item na Nota Fiscal

Parâmetros OpcionaisSeqDls Seqüência de Movimento de itemCodDep Código do DepósitoDatEnt Data de Entrada do produto no depósitoDatFab Data de Fabricação do loteDatVlt Data de Validade do produto no depósitoCodLot Código do lote de fabricação para estocagemNumSep Número de série do produtoQtdEst Quantidade a ser movimenta do estoqueObsDls Texto da Observação

Retorno:<SeqDls>

2.18.10 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SÉRIE

Ação:SID.Niv.ExcluirEntradaVencimentoLoteSerie (CIEC)

Parâmetros obrigatórios:CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saídaSeqIpv Seqüência do item na Nota FiscalSeqDls Seqüência de Movimento de item

Retorno: “OK”

2.18.11 GRAVAR LIGAÇÃO ENTRE ITENS (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarLigacaoItens (CIEC)

Parâmetros obrigatórios:CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saídaSeqIpv Seqüência do item na Nota FiscalEmpRlc Empresa da Nota Fiscal de saída relacionadaFilRlc Filial da Nota Fiscal de saída relacionadaSnfRlc Série da Nota Fiscal de saída relacionada

NfvRlc Número da Nota Fiscal de saída relacionadaInvRlc Seqüência do Item de produto relacionado

Parâmetros OpcionaisSeqLni Seqüência de ligação

Retorno:<SeqLni>

2.18.12 EXCLUIR LIGAÇÃO ENTRE ITENS

Ação:SID.Niv.ExcluirLigacaoItens (CIEC)


CodSnf Código da Série da Nota FiscalNumNfi Número inicial da nota fiscal de saídaSeqIpv Seqüência do item na Nota FiscalSeqLni Seqüência de ligação

Retorno:

8/2/2019 SapiensSID


“OK”

2.18.13 GRAVAR INFORMACOES DOCUMENTO ELETRÔNICO (INCLUIR/ALTERAR)

Ação:SID.Niv.GravarInformacoesDocumentoEletronico (CIEC)

Parâmetros obrigatórios:CodEmp Código empresaCodFil Código filial

CodSnf Série da nota fiscalNumNfi Número da nota fiscalUsuEmi Usuário emissor do documento eletrônico

Parâmetros OpcionaisSitDoe Situação do documento eletrônicoSitDea Situação do documento eletrônico anteriorChvDoe Chave do documento eletrônicoNumDfs Número da nota fiscal de serviço na prefeituraCodVer Código de verificação do documento eletrônicoNumPrt Número do protocolo de autorização do documento eletrônicoDatAut Data de autorização do documento eletrônicoHorAut Hora da autorização do documento eletrônicoUsuEmi Usuario que realizou a emissão do documento eletrônicoNumPrc Número do protocolo de cancelamento do documento eletrônico

DatCan Data de autorização para cancelamento do documento eletrônicoHorCan Hora da autorização do cancelamento do documento eletrônicoUsuCan Usuario que solicitou o cancelamento do documento eletrônicoNumPri Número do protocolo de inutilização do documento eletrônicoDatInu Data de autorização da Inutilização do documento eletrônicoHorInu Hora da autorização de inutilização do documento eletrônicoUsuInu Usuário que solicitou inutilização do documento eletrônico

Retorno: “OK”

2.18.14 EXCLUIR INFORMACOES DOCUMENTO ELETRÔNICO

Ação:SID.Niv.ExcluirInformacoesDocumentoEletronico (CIEC)

Parâmetros obrigatórios:CodEmp Código empresaCodFil Código filialCodSnf Série da nota fiscalNumNfi Número da nota fiscal

Retorno: “OK”

2.19 CONTROLADORIA – TRIBUTOS – INVENTÁRIO DE ESTOQUES

2.19.1 GRAVAR SALDOS FÍSICOS MENSAIS (INCLUIR/ALTERAR)

Ação:SID.Est.GravarInventario (CIEC)

Parâmetros obrigatórios:CodPro Código do produtoCodDep Código do depósitoMesAno Mês e ano correspondente as informações (MM/YYYY)

Parâmetros OpcionaisCodFil Código da FilialCodDer Código da derivaçãoQtdEst Quantidade física total do estoque no depósitoVlrEst Valor total em estoque no depósitoQtdCfo Quantidade consignada a fornecedor

VlrCfo Valor consignado a fornecedorQtdCcl Quantidade consignada a clienteVlrCcl Valor total consignado a clientePreMed Preço médio

Retorno:

8/2/2019 SapiensSID


“OK”

2.19.2 GRAVAR SALDOS CONSIGNADOS (INCLUIR/ALTERAR)

Ação:SID.Est.GravarConsignado (CIEC)

Parâmetros obrigatórios:CodPro Código do produtoCodDep Código do depósito

MesAno Mês e ano correspondente as informações

Parâmetros OpcionaisCodDer Código da derivaçãoCodCli Código do cliente com o produto consignadoCodFor Código do fornecedor do produto consignadoQtdCfo Quantidade consignada a fornecedorVlrCfo Valor consignado a fornecedorQtdCcl Quantidade consignada a clienteVlrCcl Valor total consignado a cliente

Retorno: “OK”

2.20 CONTROLADORIA – CONTABILIDADE

2.20.1 GERAR LOTE CONTÁBIL

Ação:SID.Lct.GerarLote (CCCT)

Parâmetros obrigatórios:DatLot Data do loteTotInf Total informado para fechamento do lote

Retorno:<NumLot> Número do lote gerado

2.20.2 EXCLUIR LOTE CONTÁBIL

Ação:SID.Lct.ExcluirLote (CCCT)

Parâmetros obrigatórios:NumLot Número do lote contábil

Parâmetros opcionais:CodEmp Código da empresaOriLct* Origem do lote contábil* Quando não informado é utilizado origem "MAN"

Retorno:"OK"

2.20.3 GERAR LANÇAMENTOAção:SID.Lct.Gravar (CCCT)

Parâmetros obrigatórios:NumLot Número do loteCtaDeb* Número reduzido da conta de débitoCtaCre* Número reduzido da conta de créditoVlrLct Valor do lançamento contábilCodHpd** Código do histórico padrãoCplLct** Descrição complementar do lançamento* Informar CtaDeb e/ou CtaCre** Informar CodHpd e/ou CplLct

Parâmetros opcionais:DatLct Data de lançamentoDatLot Data do loteDocLot Documento de controle de lançamentosCgcCpf C.N.P.J./C.P.F.CtaRed(n)* Conta contábil reduzida

8/2/2019 SapiensSID


CodCcu(n)* Código do centro de custoPerRat(n)* Percentual do rateioVlrRat(n)* Valor do rateio* (n) = Seqüência incremental da linha do rateio, iniciando sempre em 1 (um) – Não utilizar os parênteses.

Retorno:<NumLct> Número do lançamento gerado

2.20.4 INTEGRAÇÃO CONTÁBIL

Ação:SID.Ctb.Integrar (CCCT)

Parâmetros obrigatórios:(ver Observação)

Parâmetros opcionais:CodFil Código da filialDatIni Data inicial (sugestão)DatFin Data final (sugestão)CodAgi Agrupamento de filiaisTipLot Lote diário (0=Não, 1=Sim*)TipAtu Tipo de atualização (0=Período completo*, 1=Por intervalos)QtdDia Quantidade de diasIndVal Indicativo de validação (0=Não*, 1=Sim)

IntNfs Indicativo se integra Notas Fiscais de Saida (0=Não*, 1=Sim)IntVef Indicativo se integra Faturas – Vendas (0=Não*, 1=Sim)IntEst Indicativo se integra Estoques (0=Não*, 1=Sim)IntCre Indicativo se integra Contas a Receber (0=Não*, 1=Sim)IntNfe Indicativo se integra Notas Fiscais de Entrada (0=Não*, 1=Sim)IntCof Indicativo se integra Faturas – Compras (0=Não*, 1=Sim)IntCpa Indicativo se integra Contas a Pagar (0=Não*, 1=Sim)IntCom Indicativo se integra Comissões (0=Não*, 1=Sim)IntTes Indicativo se integra Tesouraria (0=Não*, 1=Sim)IntPat Indicativo se integra Patrimônio (0=Não*, 1=Sim)IntIve Indicativo se integra Impostos – Vendas (0=Não*, 1=Sim)IntIco Indicativo se integra Impostos – Compras (0=Não*, 1=Sim)IntIvz Indicativo se integra Impostos – Redução Z (0=Não*, 1=Sim)IntPrj Indicativo se integra Projetos (0=Não*, 1=Sim)IniNfs Data inicial para integração Notas Fiscais de SaídaFinNfs Data final para integração Notas Fiscais de SaídaIniVef Data inicial para integração Faturas – VendasFinVef Data final para integração Faturas – VendasIniEst Data inicial para integração EstoquesFinEst Data final para integração EstoquesIniCre Data inicial para integraçã o Contas a ReceberFinCre Data final para integração Contas a ReceberIniNfe Data inicial para integração Notas Fiscais de EntradaFinNfe Data final para integração Notas Fiscais de EntradaIniCof Data inicial para integração Faturas – ComprasFinCof Data final para integração Faturas – ComprasIniCpa Data inicial para integração Contas a PagarFinCpa Data final para integração Contas a PagarIniCom Data inicial para integração ComissõesFinCom Data final para integração ComissõesIniTes Data inicial para integração Tesouraria

FinTes Data final para integração TesourariaIniPat Data inicial para integração PatrimônioFinPat Data final para integração PatrimônioIniIve Data inicial para integração Impostos – VendasFinIve Data final para integração Impostos – VendasIniIco Data inicial para integração Impostos – ComprasFinIco Data final para integração Impostos – ComprasIniIvz Data inicial para integração Impostos – Redução ZFinIvz Data final para integração Impostos – Redução ZIniPrj Data inicial para integração ProjetosFinPrj Data final para integração Projetos* = Valor padrão

Retorno:<QtdLct> Quantidade de lançamentos gerados

Observação:Os campos DatIni e DatFin são usados para sugerir um período para TODOS os módulos de integração, não havendo

necessidade de informar o período individualmente. Neste caso, é necessário informar também o indicativo de integração de cadamódulo desejado. Se o período de datas dos módulos forem informados, não será necessário informar o indicativo de integração domódulo. Neste caso, não deve-se usar os campos DatIni e DatFin.

8/2/2019 SapiensSID


2.21 CONTROLADORIA – PATRIMÔNIO

2.21.1 MOVIMENTAR BEM

Ação:SID.Pat.Movimentar (CPBE)

Parâmetros obrigatórios:CodBem Código do bemCodTns Código da transaçãoCcuNov Código do centro de custos de destinoDatTrf Data da transferência

Parâmetros opcionais:NumPla Número da plaqueta (caso deseja-se transferir apenas uma plaqueta de centro custos)EmpNfv Código da empresa da nota fiscal de saídaFilNfv Código da filial da nota fiscal de saídaSnfNfv Código da série da nota fiscal de saídaNumNfv Número da nota fiscal de saídaSeqIpv Seqüência do item de produto na nota fiscal de saídaSeqIsv Seqüência do item de serviço na nota fiscal de saídaDatBai Baixa de bensLocNov Transferência de Local RealFilNov Transferência de FilialEspNov Transferência de EspécieCtaNov Transferência de Conta ContábilVlrVen Valor de venda

Retorno:"OK"

2.21.2 BUSCAR DEPRECIAÇÃO DO BEM

Ação:SID.Pat.BuscarDepreciacao (CPBE)

Parâmetro obrigatório:

CodBem (n)* Código do bemParâmetros opcionais:MulQtd(n)* Retorno vem multiplicado pela quantidade de itens (S=sim, N=não)DatCal(n)* Data do cálculo da depreciaçãoMesAnt(n)* Indicativo se é para buscar depreciação do período anterior ao informado (S=sim, N=não)DprBem(n)*1 Indicativo se deve buscar a depreciação na tabela de bens caso não existam cálculos de

depreciação *** (n) = Seqüência incremental, iniciando sempre em 1 (um) – Não utilizar os parênteses.** Não é utilizado quando informado data do cálculo "DatCal".

Retorno:XML contendo o código do bem, depreciação mensal, depreciação acumulada e retorno. Quando não possuir cálculo de

depreciação para a data informada retorna "1", conforme exemplo:

<?xml version="1.0"?>

<depreciacao><bem><codbem>VEICORSA0001-000</codbem><dprmes>374,17</dprmes><dpracu>2993,33</dpracu><retorno>0</retorno></bem><bem><codbem>TERFABRI0001-000</codbem><dprmes>0</dprmes><dpracu>0</dpracu><retorno>0</retorno></bem><bem><codbem>VEIPARAT0001-000</codbem>

<dprmes>0</dprmes><dpracu>0</dpracu><retorno>1</retorno></bem></depreciacao>

8/2/2019 SapiensSID


2.22 MANUFATURA – ORDEM DE PRODUÇÃO

2.22.1 APONTAR ORDENS DE PRODUÇÃO

Ação:SID.Prd.ApontarOps (MCAP)

Parâmetros obrigatórios:CodOri Código da origem

NumCad Código do operadorNumOrp Número da O.P.CodEtg Código do estágioSeqRot Seqüência de roteiroCodEqp Código do equipamento

Parâmetros opcionais:StrPrm String com todos os parâmetros concatenadosEndCol Endereço do coletorTurTrb TurnoCodCre Centro de recursoDatMov Data do movimento da O.P.HorMov Hora do movimento da O.P.QtdRe1 Quantidade de 1a. qualidadeQtdRe2 Quantidade de 2a. qualidade

QtdRe3 Quantidade de 3a. qualidadeQtdRfg Quantidade de refugoCodPro Código do produtoCodDer Código da derivaçãoCodLot Código do loteNumSep Código da sérieCodMtv Código do motivo de paradaCodDft Código do defeito de fabricaçãoCodDep Código do depósito

Retorno:"OK"

2.22.2 REMETER/RETORNAR SERVIÇO DE TERCEIROS

Ação:SID.Prd.RemeterRetornarServico (MCRR)

Parâmetros obrigatórios:CodEmp Código da empresaCodOri Código da origemNumOrp Número da O.P.CodEtg Código do estágioRemSer Remessa/retorno de serviço (S = Remessa; N = Retorno de serviço)CodFor Código do fornecedorCodSer Código do serviço

Parâmetros opcionais:SeqRot Seqüência de roteiroCodPro Código do produto

DatGer Data de geração do registroHorGer Hora de geração do registroCodUsu Código do usuário que gerou o registroQtdRfg Quantidade de refugoQtdRe1 Quantidade de 1a. qualidade no estágioQtdRe2 Quantidade de 2a. qualidade no estágioQtdRe3 Quantidade de 3a. qualidade no estágio

Retorno:"OK"

2.22.3 BAIXAR COMPONENTES DA O.P./O.S.

Ação:

SID.Prd.BaixarComponentes (MPMO)

Parâmetros obrigatórios:CodOri Código da origemNumOrp Número da O.P./O.S.CodEtg Código do estágio

8/2/2019 SapiensSID


CodCmp Código do componenteCodDer Código da derivação do componenteQtdUti Quantidade a utilizar (quantidade a baixar)

Parâmetros opcionais:SeqCmp Sequência do componenteQtdMnc Quantidade de material não-conformeQtdCdr Quantidade destinada para refugoQtdUn2 Quantidade de acordo com a segunda unidade de medidaCodLot Código do lote do componente

NumSep Número de série do componenteLotDes Lote do produto da O.P./O.S. para o qual o componente foi utilizadoSepDes Série do produto da O.P./O.S. para o qual o componente foi utilizadoDatMov Data do movimento

Retorno:"OK"

Observação:Para maiores detalhes, consultar a documentação da função de programador BaixarComponentes na ajuda do sistema.

2.23 INTEGRAÇÕES – CARTÃO PRESENTE

2.23.1 GRAVAR CARTÃO PRESENTE

Ação:SID.Int.GravarCartaoPresente (IVME)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialCarPre Código do cartão presenteTipPro Tipo de processamento (I – Inclusão; A – Alteração)DatVal Data de validade do cartão presenteDatEmi¹ Data de emissão do cartão presenteVlrCar¹ Valor do cartão presenteVlrInc² Valor de incremento do valor do cartão presente¹ Campos obrigatórios apenas para inclusão.² Campos obrigatórios apenas para alteração.

Retorno:"OK"

2.23.2 CONSULTAR CARTÃO PRESENTE

Ação:SID.Int.ConsultarCartaoPresente (IVME)

Parâmetros obrigatórios:CodEmp Código da empresaCodFil Código da filialCarPre Código do cartão presente

Retorno:"VlrCar;VlrSal;DatVal"

Legenda:VlrCar = Valor do cartão presente.VlrSal = Valor do saldo do cartão presente.DatVal = Data de validade do cartão presente.

2.23.3 CONSUMIR CARTÃO PRESENTE

Ação:SID.Int.ConsumirCartaoPresente (IVME)

Parâmetros obrigatórios:CodEmp Código da empresa

CodFil Código da filialCarPre Código do cartão presenteVlrUti Valor do cartão presente a ser utilizadoDatRes Data do resgate do valor do cartão presente

Retorno:

8/2/2019 SapiensSID


"OK"

3 SIDXMLSIDXML é o conceito atribuído à forma de agrupar ações SID em texto pseudo XML e submetê-las em uma única requisição

HTTP. O benefício é a possibilidade de processamento agrupado dentro de uma transação de banco, assim ocorrendo alguma falha todoo bloco de comandos SID é desfeito, além de reduzir o tráfego via rede. Outra característica é a possibilidade de utilizar o "retorno" deações como parâmetros em outras.

3.1 SINTAXE XML

Para utilizá-lo, deve-se enviar a ação de "login" (EXESENHA) normalmente e, em seguida, enviar a ação "SID.SRV.XML" com otexto XML. O texto XML deve ser montado como abaixo:

<sidxml><sid acao='[ACAOSID]' retorno='[RETORNO]'>

<param nome='[PARAMETRO]' valor='[VALOR]' />...demais parâmetros...

</sid>...demais ações...

</sidxml>

Onde:

[ACAOSID] Nome da ação SID que se deseja executar;[RETORNO]* Nome qualquer para uma variável interna que armazenará o conteúdo do retorno da ação;[PARAMETRO] Nome do parâmetro SID;[VALOR] Valor do parâmetro;* Parâmetro opcional

Observações técnicas:• Para submeter o texto XML, deve-se utilizar sempre o método "POST";• Não há limite de quantidade de ações ou parâmetros, apenas o tamanho final do texto XML (1 Mb);• Para utilizar o conteúdo de uma variável interna, deve-se preceder o nome da variável um "@" no parâmetro valor. Exemplo:

<param nome='NUMPED' valor='@RETORNO_PEDIDO '>;• Os valores dos parâmetros devem sempre estar delimitados por apóstrofos ('), independente do tipo de conteúdo;• O Sapiens Server considera falha ou erro, todo retorno de ação iniciando com "ERRO:";

Parâmetros do SIDXML:

A passagem de parâmetros para o SIDXML pode ser feita definindo o primeiro sub-elemento do SIDXML com o rótulo "param",sendo os atributos deste elemento considerados como parâmetros.

Os parâmetros existentes, e seus possíveis valores, são:a) retorno – indica o formato de resultado da execução da ação SIDXML. Possíveis valores:

• <padrão> – o resultado da ação é um texto simples "OK" ou "ERRO:....";• XML – o resultado da ação é um XML indicando o retorno individual de cada ação;

b) transacao – indica o modo de tratamento de transações de banco de dados. Possíveis valores:• <padrão> – todo conteúdo do SIDXML é processado dentro de uma transação única, assim ocorrendo erro em

alguma ação, tudo é desfeito;• INDIVIDUAL – cada ação dentro do SIDXML é processado em sua própria transação, assim ocorrendo erro em

alguma ação, somente o resultado desta ação é desfeito, sendo as ações posteriores também processadas;

Exemplo:<sidxml>

<param retorno='XML' transacao='INDIVIDUAL ' />... ações...</sidxml>

Observações:A utilização de parâmetro transacao como INDIVIDUAL torna obrigatório a utilização do parâmetro retorno como XML.

Limitações:• Por questões técnicas internas, o XML não deverá conter quebras de linha, ou seja, todo o conteúdo deverá ser submetido numa

única linha, exemplo: <sidxml><sid acao=...><...><...></sidxml>• Não utilizar o cabeçalho padrão do XML (<?xml version="1.0"?>);• Não utilizar caracteres como "?" e "&" no XML;• Não utilizar o caractere apóstrofo (') no valor de um parâmetro;• A ação SID.SRV.EXEREL não pode ser utilizada no SIDXML;

3.2 EXEMPLO

O exemplo de XML a seguir, realiza as seguintes funções:• Cadastra um novo cliente e suas definições;• Gera uma nota fiscal de venda e seus itens (para este novo cliente);

8/2/2019 SapiensSID


• Processa o fechamento da nota fiscal;• Executa uma regra LSP para buscar uma informação adicional da base;• Gera o boleto cliente do cliente e o envia via e-mail;

<sidxml><param retorno='XML' /><sid acao='SID.CLI.GRAVAR ' retorno='RET_CODCLI'>

<param nome='NOMCLI' valor='Senior Sistemas' /><param nome='APECLI' valor='Senior' /><param nome='TIPCLI' valor='J' />

<param nome='CGCCPF' valor='80680093000181' /><param nome='ENDCLI' valor='R. Luiz Sachtleben, 115 Victor Konder' /><param nome='SIGUFS' valor='SC' /><param nome='CEPCLI' valor='89012530' /><param nome='EMACLI' valor='[email protected]' />

</sid><sid acao='SID.CLI.GRAVARDEFINICOES '>

<param nome='CODCLI' valor='@RET_CODCLI' /><param nome='CODREP' valor='1' /><param nome='VLRLIM' valor='1000000' /><param nome='LIMAPR ' valor='S' />

</sid><sid acao='SID.NFV.GRAVAR ' retorno='RET_NUMNFV'>

<param nome='CODSNF' valor='U' /><param nome='CODCLI' valor='@RET_CODCLI' /><param nome='TNSPRO' valor='512' />

</sid><sid acao='SID.NFV.GRAVARPRODUTOS '>

<param nome='CODSNF' valor='U' /><param nome='NUMNFV' valor='@RET_NUMNFV' /><param nome='SEQIPV' valor='1' /><param nome='CODPRO' valor='CA000101' /><param nome='CODDER ' valor='M' /><param nome='QTDFAT' valor='1' /><param nome='PREUNI' valor='19.50' />

</sid><sid acao='SID.NFV.FECHAR '>

<param nome='CODSNF' valor='U' /><param nome='NUMNFV' valor='@RET_NUMNFV' />

</sid><sid acao='SID.SRV.REGRA ' retorno='RET_TITULO_GERADO '>

<param nome='NUMREG' valor='123' /><param nome='vAlfaNumNfv' valor='@RET_NUMNFV' /><param nome='vAlfaCodSnf ' valor='U' />

</sid><sid acao='SID.SRV.EXEBLO ' retorno='RET_ARQUIVO'>

<param nome='NOME' valor='CN00999.BLO' /><param nome='NUMTIT' valor='@RET_TITULO_GERADO ' /><param nome='CODTPT' valor='01' /><param nome='FORMATO' valor='JPEG' /><param nome='QUALIDADE' valor='80' />

</sid><sid acao='SID.SRV.EMAIL '>

<param nome='DESTINATARIO' valor='[email protected]' /><param nome='ASSUNTO' valor='Seu boleto para pagamento segue em anexo ' /><param nome='ANEXO' valor='@RET_ARQUIVO' />

</sid></sidxml>

SapiensSID

Documents