Sapiens SID

Guia de Referncia Sapiens SID

Servio Interativo Dinmico

(C) Senior Julho 2011

(C) Senior

Sapiens SID

NDICE ANALTICO
1 GUIA DE REFERNCIA.............................................................................................................................................5 1.1 AUTENTICAR (LOGIN/REGISTRO).............................................................................................................5 1.2 EXECUTAR AES (SUBMETER REQUISIES)..........................................................................................5 1.3 AUTENTICAO EMBUTIDA........................................................................................................................5 1.4 EXECUTAR SID ATRAVS DE SERVIO MC.................................................................................................6 1.5 NOTAS DE IMPLEMENTAO......................................................................................................................6 2 AES SID............................................................................................................................................................7 2.1 AES UTILITRIAS..................................................................................................................................7 2.1.1 Alterar empresa/filial (usurio ativo)................................................................................................7 2.1.2 Executar regra interna (regras LSP).................................................................................................7 2.1.3 IMPRIMIR RELATRIO (Imprimir ou gerar imagens)............................................................................7 2.1.4 IMPRIMIR BLOQUETOS (Imprimir, gerar imagens e gerar PDF).............................................................8 2.1.5 IMPRIMIR NOTAS FISCAIS DE SADA................................................................................................8 2.1.6 OBTER INFORMAES DA CONEXO ATUAL (Uso interno)...................................................................8 2.1.7 ENCERRAR CONEXO ATUAL (Somente se invocado via HTTP)..............................................................9 2.2 MERCADO PEDIDO DE VENDAS...............................................................................................................9 2.2.1 GRAVAR CABECALHO PEDIDO (Incluir/alterar)...................................................................................9 2.2.2 GRAVAR CABECALHO PEDIDO PREVISO (Incluir/alterar)....................................................................9 2.2.3 GRAVAR ITEM DE PRODUTO (Incluir/alterar)....................................................................................10 2.2.4 GRAVAR ITEM DE PRODUTO PREVISO (Incluir/alterar).....................................................................11 2.2.5 GRAVAR ITEM DE SERVIO (Incluir/alterar).....................................................................................11 2.2.6 FECHAR PEDIDO..........................................................................................................................12 2.2.7 FECHAR PEDIDO PREVISO...........................................................................................................12 2.2.8 EXCLUIR PEDIDO.........................................................................................................................12 2.2.9 EXCLUIR PEDIDO PREVISO..........................................................................................................12 2.2.10 EXCLUIR ITEM DE PRODUTO........................................................................................................12 2.2.11 Excluir item de PRODUTO PREVISO.............................................................................................13 2.2.12 Excluir item de servio................................................................................................................13 2.2.13 GRAVAR OBSERVAO (Incluir/alterar).........................................................................................13 2.2.14 EXCLUIR OBSERVAO...............................................................................................................13 2.2.15 LISTAR EMBALAGENS DO PEDIDO................................................................................................13 2.2.16 CONFIRMAR CONFERNCIA DA EMBALAGEM..................................................................................14 2.2.17 SUBSTITUIR EMBALAGEM............................................................................................................14 2.2.18 ANALISAR ESTOQUE DE EMBALAGENS..........................................................................................14 2.2.19 ANALISAR OBSERVAO DE BLOQUEIO POR REA..........................................................................15 2.2.20 GRAVAR PEDIDO VIA CONTRATO DE LICITAO.............................................................................15 2.2.21 GRAVAR PEDIDO EM GRADE........................................................................................................18 2.2.22 CANCELAR PEDIDO....................................................................................................................25 2.3 SUPRIMENTOS COTAES.....................................................................................................................25 2.3.1 GRAVAR COTAO.......................................................................................................................25 2.4 MERCADO NOTA FISCAL VENDA............................................................................................................26 2.4.1 GRAVAR CABEALHO DA NOTA FISCAL VENDA (Incluir).....................................................................26 2.4.2 FECHAR NOTA FISCAL VENDA........................................................................................................26 2.4.3 CANCELAR NOTA FISCAL VENDA....................................................................................................27 2.4.4 RECALCULAR PARCELAS (Baseado na cond. pgto.)............................................................................27 2.4.5 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL VENDA (Incluir)...........................................................27 2.4.6 GRAVAR ITEM DE SERVIO NA NOTA FISCAL VENDA (Incluir)............................................................28 2.4.7 CANCELAR FATURA......................................................................................................................29 2.4.8 LISTAR EMBALAGENS DA NFV PARA CONTROLE DE EMBARQUE..........................................................29 2.4.9 COMPOR O DOCUMENTO DE EMBARQUE COM A NFV.........................................................................29 2.4.10 2.4.10 ATUALIZAO DA SITUAO DA NFV ELETRNICA...............................................................30 2.4.11 ATUALIZAO DA SITUAO DO CT ELETRNICO...........................................................................31 2.4.12 ATUALIZAO DA SITUAO DA NFS ELETRNICA.........................................................................31 2.4.13 FECHAR CONTROLE DE EMBARQUE...............................................................................................32 2.4 SUPRIMENTOS NOTA FISCAL COMPRA.................................................................................................32 2.4.14 GRAVAR CABEALHO DA NOTA FISCAL COMPRA (Incluir).................................................................32 2.4.15 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL COMPRA (Incluir)........................................................33 2.4.16 GRAVAR ITEM DE SERVIO NA NOTA FISCAL COMPRA (Incluir).........................................................35 2.4.17 GRAVAR PARCELAS MANUAIS NA NOTA FISCAL DE COMPRA.............................................................37 2.4.18 FECHAR NOTA FISCAL COMPRA....................................................................................................37 2.4.19 CANCELAR NOTA FISCAL COMPRA................................................................................................38 2.4.20 GERAR NOTA FISCAL VIA ORDEM DE COMPRA................................................................................38 2.4.21 GRAVAR RATEIO PARA ITEM DE PRODUTO.....................................................................................38 2.4.22 GRAVAR RATEIO PARA ITEM DE SERVIO......................................................................................39 2.5 SUPRIMENTOS ORDEM DE COMPRA......................................................................................................39 2.4.23 GRAVAR CABEALHO ORDEM DE COMPRA.....................................................................................39 2.4.24 EXCLUIR ORDEM DE COMPRA......................................................................................................40 2.4.25 GRAVAR ITEM DE PRODUTO NA ORDEM DE COMPRA.......................................................................40 2.4.26 GRAVAR ITEM DE SERVIO NA ORDEM DE COMPRA........................................................................40 2.4.27 FECHAR ORDEM DE COMPRA.......................................................................................................41 2.4.28 GERAR ORDEM DE COMPRA VIA COTAO.....................................................................................41 2.5 SUPRIMENTOS ESTOQUES.....................................................................................................................41 2.5.1 GERAR REQUISIO....................................................................................................................41 (C) Senior 2

Sapiens SID 2.5.2 ATENDER REQUISIO.................................................................................................................42 2.5.3 EXCLUIR REQUISIO..................................................................................................................42 2.5.4 GRAVAR RATEIO REQUISIO.......................................................................................................42 2.5.5 MOVIMENTAR ESTOQUE...............................................................................................................43 2.5.6 EXCLUIR MOVIMENTO DE ESTOQUE...............................................................................................43 2.5.7 LISTAR ITENS DA EMBALAGEM......................................................................................................43 2.5.8 CONFIRMAR CONFERNCIA DA EMBALAGEM....................................................................................44 2.5.9 GRAVAR SOLICITAO DE COMPRA (Incluir/alterar).........................................................................44 2.5.10 EXCLUIR SOLICITAO DE COMPRA.............................................................................................45 2.5.11 BUSCAR ESTOQUE DISPONVEL...................................................................................................45 2.5.12 BUSCAR PREO MDIO...............................................................................................................45 2.5.13 BUSCAR ESTOQUE GRADE...........................................................................................................45 2.5.14 ESTOQUE PAF/ECF (VAREJO).......................................................................................................47 2.6 MERCADO NOTA FISCAL TRANSFERNCIA............................................................................................47 2.6.1 Marcar embalagem/produto para transferncia.................................................................................47 2.6.2 BUSCAR ITENS DA NOTA FISCAL DE TRANSFERNCIA.......................................................................48 2.6.3 CONFIRMAR CONFERNCIA DOS ITENS DA NFT................................................................................48 2.7 MERCADO PR-FATURAS.......................................................................................................................49 2.7.1 CRIAR EMBALAGEM PARA PR-FATURA...........................................................................................49 2.7.2 INCLUIR OS CONTEDOS DAS EMBALAGEM DA PR-FATURA..............................................................49 2.7.3 EXCLUIR EMBALAGEM DA PR-FATURA...........................................................................................49 2.8 CADASTROS CLIENTES..........................................................................................................................50 2.8.1 GRAVAR CLIENTE (Incluir/alterar)..................................................................................................50 2.8.2 GRAVAR DEFINIES DO CLIENTE (Incluir/alterar)...........................................................................51 2.8.3 EXCLUIR CLIENTE........................................................................................................................52 2.8.4 EXCLUIR DEFINIES DO CLIENTE.................................................................................................52 2.8.5 GRAVAR DADOS PESSOA JURDICA (Incluir/alterar)..........................................................................52 2.8.6 EXCLUIR DADOS PESSOA JURDICA...............................................................................................53 2.8.7 GRAVAR DADOS PESSOA FSICA (Incluir/alterar).............................................................................53 2.8.8 EXCLUIR DADOS PESSOA FSICA...................................................................................................54 2.8.9 GRAVAR CONTATO DO CLIENTE (Incluir/alterar)...............................................................................54 2.8.10 EXCLUIR CONTATO DO CLIENTE...................................................................................................55 2.8.11 GRAVAR ENDEREO DE ENTREGA.................................................................................................55 2.8.12 EXCLUIR ENDEREO DE ENTREGA................................................................................................55 2.8.13 GRAVAR ENDEREO DE COBRANA..............................................................................................56 2.8.14 EXCLUIR ENDEREO DE COBRANA..............................................................................................56 2.9 CADASTROS REPRESENTANTES.............................................................................................................56 2.9.1 GRAVAR REPRESENTANTE (Incluir/alterar).......................................................................................56 2.9.2 GRAVAR DEFINIES DO REPRESENTANTE (Incluir/alterar)...............................................................57 2.9.3 EXCLUIR REPRESENTANTE............................................................................................................58 2.9.4 EXCLUIR DEFINIES DO REPRESENTANTE.....................................................................................58 2.10 CADASTROS FORNECEDORES..............................................................................................................58 2.10.1 GRAVAR FORNECEDOR (Incluir/alterar).........................................................................................58 2.10.2 GRAVAR DEFINIES DO FORNECEDOR (Incluir/alterar)..................................................................59 2.10.3 EXCLUIR FORNECEDOR...............................................................................................................60 2.10.4 EXCLUIR DEFINIES DO FORNECEDOR.......................................................................................60 2.11 CADASTROS PRODUTOS......................................................................................................................60 2.11.1 GRAVAR PRODUTO (Incluir/alterar)...............................................................................................60 2.11.2 EXCLUIR PRODUTO....................................................................................................................60 2.11.3 GRAVAR DERIVAO (Incluir/alterar)............................................................................................61 2.11.4 EXCLUIR DERIVAO.................................................................................................................61 2.12 FINANAS CONTAS A RECEBER...........................................................................................................61 2.12.1 GRAVAR TTULO CR....................................................................................................................61 2.12.2 BAIXAR TTULO CR....................................................................................................................62 2.12.3 GRAVAR RATEIO TTULO CR........................................................................................................63 2.12.4 EXCLUIR TTULO CR...................................................................................................................63 2.12.5 EXCLUIR BAIXA CR.....................................................................................................................64 2.12.6 ALTERAR TTULO CR (Somente data de vencimento).......................................................................64 2.12.7 SELECIONAR TTULO CR.............................................................................................................64 2.12.8 PROCESSAR BAIXAS AUTOMTICAS..............................................................................................65 2.13 FINANAS CONTAS A PAGAR ............................................................................................................65 2.13.1 GRAVAR TTULO CP....................................................................................................................65 2.13.2 BAIXAR TTULO CP.....................................................................................................................66 2.13.3 GRAVAR RATEIO TTULO CP........................................................................................................67 2.13.4 EXCLUIR TTULO CP...................................................................................................................67 2.13.5 EXCLUIR BAIXA CP.....................................................................................................................67 2.14 FINANAS TESOURARIA ....................................................................................................................68 2.14.1 GRAVAR MOVIMENTO (Incluir/alterar)...........................................................................................68 2.14.2 GRAVAR RATEIO DO MOVIMENTO.................................................................................................68 2.14.3 PROCESSAR MOVIMENTO (CHEQUE).............................................................................................68 2.15 FINANAS PROJETOS..........................................................................................................................69 2.15.1 GRAVAR LANAMENTO...............................................................................................................69 2.15.2 EXCLUIR LANAMENTO...............................................................................................................69 2.16 CONTROLADORIA TRIBUTOS - REDUO Z.........................................................................................70 2.16.1 GRAVAR TOTALIZADORES DA REDUO Z.....................................................................................70 2.16.2 GRAVAR MOVIMENTOS DA REDUO Z.........................................................................................70 (C) Senior 3

Sapiens SID 2.16.3 GRAVAR RATEIOS DOS MOVIMENTOS DA REDUO Z.....................................................................71 2.16.4 GRAVAR ITENS DA REDUO Z....................................................................................................71 2.17 CONTROLADORIA TRIBUTOS NOTA FISCAL COMPRA......................................................................72 2.17.1 GRAVAR DADOS GERAIS (Incluir/alterar).......................................................................................72 2.17.2 GRAVAR RATEIOS DOS DADOS GERAIS.........................................................................................73 2.17.3 GRAVAR ITEM (Incluir/alterar).....................................................................................................74 2.17.4 EXCLUIR ITEM...........................................................................................................................76 2.17.5 GRAVAR PARCELA COMPRA (Incluir/alterar)...................................................................................76 2.17.6 EXCLUIR PARCELA COMPRA.........................................................................................................76 2.17.7 GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (Incluir/alterar)......................................................76 2.17.8 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE ...........................................................................77 2.17.9 GRAVAR LIGAO ENTRE ITENS (Incluir/alterar)............................................................................77 2.17.10 EXCLUIR LIGAO ENTRE ITENS................................................................................................77 2.18 CONTROLADORIA TRIBUTOS NOTA FISCAL VENDA.........................................................................77 2.18.1 GRAVAR DADOS GERAIS (Incluir/alterar).......................................................................................77 2.18.2 GRAVAR RATEIOS DOS DADOS GERAIS.........................................................................................79 2.18.3 GRAVAR ITEM (Incluir/alterar).....................................................................................................80 2.18.4 EXCLUIR ITEM...........................................................................................................................81 2.18.5 GRAVAR CONHECIMENTO DE TRANSPORTE (Incluir/alterar)..............................................................82 2.18.6 EXCLUIR CONHECIMENTO DE TRANSPORTE...................................................................................82 2.18.7 GRAVAR PARCELAS DE VENDA (Incluir/alterar)...............................................................................82 2.18.8 EXCLUIR PARCELAS DE VENDA....................................................................................................82 2.18.9 GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (Incluir/alterar)......................................................83 2.18.10 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE .........................................................................83 2.18.11 GRAVAR LIGAO ENTRE ITENS (Incluir/alterar)...........................................................................83 2.18.12 EXCLUIR LIGAO ENTRE ITENS ...............................................................................................83 2.18.13 GRAVAR INFORMACOES DOCUMENTO ELETRNICO (Incluir/Alterar) ...............................................84 2.18.14 EXCLUIR INFORMACOES DOCUMENTO ELETRNICO .....................................................................84 2.19 CONTROLADORIA TRIBUTOS INVENTRIO DE ESTOQUES..............................................................84 2.19.1 GRAVAR SALDOS FSICOS MENSAIS (Incluir/alterar).......................................................................84 2.19.2 GRAVAR SALDOS CONSIGNADOS (Incluir/alterar)...........................................................................85 2.20 CONTROLADORIA CONTABILIDADE ...................................................................................................85 2.20.1 GERAR LOTE CONTBIL..............................................................................................................85 2.20.2 EXCLUIR LOTE CONTBIL............................................................................................................85 2.20.3 GERAR LANAMENTO.................................................................................................................85 2.20.4 INTEGRAO CONTBIL.............................................................................................................86 2.21 CONTROLADORIA PATRIMNIO .........................................................................................................87 2.21.1 MOVIMENTAR BEM.....................................................................................................................87 2.21.2 BUSCAR DEPRECIAO DO BEM...................................................................................................87 2.22 MANUFATURA ORDEM DE PRODUO.................................................................................................88 2.22.1 APONTAR ORDENS DE PRODUO................................................................................................88 2.22.2 REMETER/RETORNAR SERVIO DE TERCEIROS...............................................................................88 2.22.3 BAIXAR COMPONENTES DA O.P./O.S.............................................................................................88 2.23 INTEGRAES CARTO PRESENTE......................................................................................................89 2.23.1 GRAVAR CARTO PRESENTE........................................................................................................89 2.23.2 CONSULTAR CARTO PRESENTE...................................................................................................89 2.23.3 CONSUMIR CARTO PRESENTE....................................................................................................89 3 SIDXML...............................................................................................................................................................90 3.1 SINTAXE XML...........................................................................................................................................90 3.2 EXEMPLO..................................................................................................................................................90

(C) Senior

1 GUIA DE REFERNCIA
1.1 AUTENTICAR (LOGIN/REGISTRO)
O primeiro procedimento a ser efetuado a autenticao da integrao. Para tal, deve-se enviar uma ao de "login" ao Sapiens Server para que o mesmo valide as permisses do usurio que ir interagir com a base Sapiens. Sintaxe: http://<servidor>/<diretrio_virtual>/conector.exe? SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usurio>&SENUSU=<senha> Onde: <servidor> <diretrio_virtual> SIS=CO LOGIN=SID <usurio> <senha> Nome ou IP do servidor web. Nome do diretrio virtual. Parmetro interno: obrigatrio em todas as aes Parmetro interno: obrigatrio em todas as aes Nome do usurio do Sistema Sapiens. Senha do usurio do Sistema Sapiens.

Se a validao do usurio for efetivada, o retorno da requisio acima dever ser um "cdigo de conexo", que ser repassado posteriormente como parmetro para validar e garantir a autenticidade das demais aes. IMPORTANTE: Deve-se utilizar uma conta de usurio 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: Usurio ou senha invlido Ou <html>Time-out error...</html>

1.2 EXECUTAR AES (SUBMETER REQUISIES)

Nesta etapa, so enviadas as aes que interagem diretamente com a base do Sapiens. O cdigo de conexo, retornado no login, dever ser acrescido em todas estas aes enviadas ao Sapiens Server. Sintaxe:

http://<servidor>/<diretrio_virtual>/conector.exe? SIS=CO&LOGIN=SID&USER=<usurio>&CONNECTION=<cdigo_de_conexo>&ACAO=<ao>&<parmetro>=<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 requisio ao Sapiens Server para que seja gerado um pedido (cabealho) na base Sapiens, cujo cdigo de cliente seja 99. A ao SID.PED.GRAVAR retorna o nmero do pedido gerado (caso no ocorra erro). Parmetro opcional: AcceptEmptyField Indica se os campos passados sem valor ("CAMPO=") devem ser considerados ou no nas aes. Valores possveis: "0" - no considera; "1" (padro) - considera.

1.3 AUTENTICAO EMBUTIDA

possvel executar uma ao comum juntamente com a ao de autenticao EXESENHA. Este mtodo facilita a implementao e melhora o desempenho. A forma de escrev-la semelhante ao de login, acrescido do parmetro "PROXACAO=<ao>" e mais os parmetros da prxima ao. Recomenda-se utiliz-la apenas quando houver necessidade de executar aes isoladas. Formato:

http://<servidor>/<diretrio_virtual>/conector.exe? SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usurio>&SENUSU=<senha>&PROXACAO=<ao_a_executar_aps_login >&<parmetro>=<valor>&...

Exemplo:

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 ATRAVS DE SERVIO MC

Haver cada vez mais incentivos para que os Web Services substituam o SID, pois so implementados sob uma arquitetura mais robusta, segura e com melhor desempenho. No entanto, para suprir a variedade reduzida Web Services disponveis, haver possibilidade de invocar aes SID por meio de um deles. O benefcio, neste caso, o fato do processamento ser totalmente local a no necessitar do ambiente "Sapiens Server" instalado. No entanto, o servio MC SID limita-se a processar apenas aes de "negcio" e dentro da empresa/filial ativa do usurio que executar a regra. O exemplo abaixo demonstra a execuo de uma ao SID atravs de servio MC local. necessrio habilitar a opo Utiliza servios em Recursos/Implementaes/Servios/Configuraes.

@ Define o servio e porta @ definir interno.com.senior.g5.co.ger.sid.executar vAcaoSID; @ Adiciona os parmetros SID -- cada parmetro 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 ao @ vAcaoSID.ModoExecucao = 1; vAcaoSID.Executar(); @ Processar resultado @ definir alfa ValStr; ValStr = vAcaoSID.Resultado;

1.5 NOTAS DE IMPLEMENTAO

As notas abaixo enfatizam dicas e limitaes importantes para a utilizao do SID nas requisies HTTP: a) b) c) d) e) Recomenda-se limpar o retorno das aes, ou seja, remover eventuais "CR+LF" e excesso de espaos. Toda ao enviada sempre retorna alguma informao, seja ela, uma simples literal "OK" ou vrias linhas de dados. Algumas aes possuem um parmetro opcional denominado "Delim". Sua funo determinar o caractere separador dos campos de retorno da ao. O valor padro ";" (ponto-e-vrgula). O cdigo de conexo perde a validade aps a execuo da ao de LOGOFF ou quando o tempo de ociosidade expira. Quando isso ocorrer, necessrio um efetuar novo login. Os valores de cada parmetro devem ser sempre atribudos diretamente sem caracteres tipo aspas, independente do tipo de dado esperado pelo parmetro (Exemplo: NOMCLI=SENIOR, CODCLI=33, DATATU=01/01/2003, VALDSC=199.50). No deve ser utilizado espaos antes ou depois do caractere "=" (Exemplo incorreto: CODCLI = 123 Exemplo correto: CODCLI=123). Todas as operaes sero realizadas sempre baseadas na empresa/filial ativa do usurio utilizado no login. Deve-se criar um usurio Sapiens exclusivo para o SID. Havendo necessidade de operar em mltiplas empresas/filial, deve-se criar e posicionar um usurio distinto para cada uma delas. O separador decimal utilizado nos parmetros numricos deve ser o ponto ".".

f)

g)

h)

recomendvel consistir o retorno de cada ao 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 nmero vlido, ou seja, contendo apenas dgitos numricos. O servidor (Sapiens Server) gera sempre um histrico de aes recebidas e processadas por ele. Estes arquivos so gerados no diretrio de LOGs do sistema, com o nome: SAPIENSRV_DUMPLOG_<nnn>_<DATAHORA>.LOG. IMPORTANTE: O tempo mximo de processamento de uma ao cinco minutos (limite do IIS). Depois deste tempo, a comunicao interrompida seguida de uma mensagem de time-out. Deve-se ficar atento esta limitao, principalmente quando utilizar o recurso SIDXML.

i) j)

2 AES SID
Segue abaixo a relao das aes implementadas no Sapiens Server at a data de reviso deste documento.

2.1 AES UTILITRIAS

Aes de uso genrico e utilitrias.

2.1.1 ALTERAR EMPRESA/FILIAL (USURIO ATIVO)

Ao: SID.Srv.AltEmpFil Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial Retorno: "OK" Observao: Esta ao deve ser utilizada com cautela, pois modifica a empresa/filial ativa do usurio utilizado na autenticao. Alteraes de empresa/filial no Sapiens podem conflitar com as aes SID, assim como aes concorrentes, caso estejam todos usando o mesmo usurio. Recomenda-se criar e usar um usurio distinto para cada empresa/filial. Esta ao no deve ser utilizada em situaes em que no ocorre a autenticao do usurio (como no WebService de invocao SID).

2.1.2 EXECUTAR REGRA INTERNA (REGRAS LSP)

Ao: SID.Srv.Regra Parmetros obrigatrios: NumReg Nmero da regra Parmetros opcionais: Todo parmetro adicional passado com algum valor, poder ser utilizado internamente pela regra, bastando criar uma varivel de mesmo nome (definir alfa <parmetro>) Retorno: O retorno da regra dever ser atribudo varivel alfa "ValStr".

2.1.3 IMPRIMIR RELATRIO (IMPRIMIR OU GERAR IMAGENS)

Ao: SID.Srv.ExeRel Parmetros obrigatrios Nome Nome do modelo (.ger) Parmetros opcionais Impressora* Formato* Qualidade Dado_<Campo>... Nome ou compartilhamento da impressora, se desejar imprimir direto Informar o valor "JPEG" ou "PDF" Qualidade do JPEG (0-100 padro 65) Nome do campo de entrada, definido no modelo

* Acrescentar sempre o termo "Dado_" antes do nome do campo definido nos parmetros de entrada do modelo * Utilizar este parmetro se desejar imprimir ao invs de apenas executar * Utilizar este parmetro para gerar uma imagem JPEG ao inves de apenas executar

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

Ou "<caminho do arquivo PDF>"

(caso seja informado o parmetro "Formato= PDF")

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

Ao: SID.Srv.ExeBlo Parmetros obrigatrios Nome Nome do modelo (.blo) Impressora Nome ou compartilhamento da impressora, caso desejar imprimir direto NosNum* Nosso nmero CodPor Cdigo do portador CodCrt Cdigo da carteira
* Apenas quando requerido, se no informar, gravar 0 como ltimo nosso nmero.

Parmetros obrigatrios para bloquetos do comercial CodSnf Srie da nota fiscal NumNfv Nmero da nota fiscal Parmetros obrigatrios para bloquetos do financeiro CodTpt Cdigo do tipo de ttulo NumTit Nmero do ttulo Parmetros opcionais WheCla Clusula WHERE Mens01 Texto da mensagem 1 Mens02 Texto da mensagem 2 Mens03 Texto da mensagem 3 Mens04 Texto da mensagem 4 Formato Informar valor "JPEG" ou PDF Qualidade Qualidade do JPEG (0-100 padro 65) Retorno: "OK" Ou "<caminho>" Ou "<caminho>" (caso seja informado o parmetro "Impressora=...") (caso seja informado o parmetro "Formato=JPEG") (caso seja informado o parmetro "Formato=PDF")

2.1.5 IMPRIMIR NOTAS FISCAIS DE SADA

Ao: SID.Srv.ExeNfs (RFNF) Parmetros obrigatrios: Nome Nome do modelo (.nfs) Impressora Nome ou compartilhamento da impressora CodSnf Srie da nota fiscal de sada NumNfv Abrangncia de nmeros de notas fiscais de sada Parmetros opcionais: PreImp Nmero pr-impresso inicial Retorno: "OK" Observaes: Esta ao respeita os formatos de sada e a lgica definida nos modelos, com exceo das definies de impressora (selecionar impressora, impressora padro, etc), por exemplo, se o objetivo a "impresso para arquivo", isto deve ser definido no modelo do relatrio, pelo gerador de relatrios. O modelo de nota fiscal de sada no pode estar configurado para pr-visualizar o relatrio ou imprimir para vdeo, caso contrrio a ao retornar um erro. A impressora a ser usada (passada por parmetro) deve obrigatoriamente estar instalada no servidor e ser do tipo texto. Importante ressaltar que, no SapiensWeb, o diretrio padro para gerao dos arquivos de relatrio definido no CFG (chave REPORTS) ignorado e sempre usado o diretrio temporrio para este fim.

2.1.6 OBTER INFORMAES DA CONEXO ATUAL (USO INTERNO)

Ao: SID.Srv.Status Retorno: Informaes referentes conexo ativa uso interno

2.1.7 ENCERRAR CONEXO ATUAL (SOMENTE SE INVOCADO VIA HTTP)

Ao: LogOff Retorno: "OK"

2.2 MERCADO PEDIDO DE VENDAS

2.2.1 GRAVAR CABECALHO PEDIDO (INCLUIR/ALTERAR)
Ao: SID.Ped.Gravar (RVPE) Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: NumPed Nmero do pedido TipPed Tipo do pedido TnsPro Transao para produtos TnsSer Transao para servios DatEmi Data da emisso DatPrv Data de previso do pedido ObsPed Observao do pedido SeqEnt Seqncia do endereo de entrega do cliente SeqCob Seqncia do endereo de cobrana do cliente SeqCto Seqncia do contato do cliente PedCli Nmero do pedido no cliente CodCpg Cdigo da condio de pagamento CodFpg Cdigo da forma de pagamento SitPed Situao do pedido CodRep Cdigo do representante CodVen Cdigo do vendedor CodTra Cdigo da transportadora CodRed Cdigo da transportadora de redespacho CodRoe Cdigo da rota de entrega SeqRoe Seqncia do cliente na rota CodPor Cdigo do portador CodCrt Cdigo da carteira VlrFre Valor de frete do pedido PerFre Percentual de frete do pedido CifFob Indicativo se o frete CIF (C) ou FOB (F) QtdAbe Quantidade em aberto PerOf1 Percentual de oferta 1 para o pedido PerOf2 Percentual de oferta 2 para o pedido PerDs1 Percentual de desconto 1 do cliente PerDs2 Percentual de desconto 2 do cliente PerDs3 Percentual de desconto 3 do cliente PerDs4 Percentual de desconto 4 do cliente PedBlo Indicativo de pedido bloqueado AcePar Indicativo se o pedido aceita faturamento parcial VlrDar Valor de Arredondamento (em caso de desconto esse valor deve ser negativo) PlaVei Placa do Veculo CodMoe Cdigo da moeda/ndice que o preo unitrio est representado CodMcp Moeda ou ndice para correo do preo unitrio VlrEmb Valor das embalagens para o pedido VlrFrd Valor frete destacado VlrEnc Valor dos encargos para o pedido VlrOud Valor outras despesas destacado VlrOut Valor das outras despesas para o pedido VlrSeg Valor do seguro para o pedido Retorno: <NumPed> Nmero do pedido gerado

Observao: Esta ao aceita campos de usurio.

2.2.2 GRAVAR CABECALHO PEDIDO PREVISO (INCLUIR/ALTERAR)

Ao: SID.Ped.GravarPrevisao (RVPE)

Parmetros opcionais: NumPed Nmero do pedido DatEmi Data da emisso DatPrv Data de previso do pedido SitPed Situao do pedido CodPvp* Cdigo do perodo de produo e venda
* O campo codpvp no existe fisicamente na tabela de pedidos, mas usado no cabealho da funo apenas para atribuir a data final do perodo data de previso do pedido

Retorno: <NumPed>

Nmero do pedido gerado

Observao: Esta ao aceita campos de usurio.

2.2.3 GRAVAR ITEM DE PRODUTO (INCLUIR/ALTERAR)

Ao: SID.Ped.GravarProduto (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqIpd Seqncia informar somente para alterao CodPro Cdigo do produto CodDer Cdigo da derivao QtdPed Quantidade do produto CodTpr* Cdigo da tabela de preo PreUni* Preo unitrio
* Utilizar CodTpr ou PreUni

Parmetros opcionais: TnsPro Transao para produtos UniVen* Unidade de medida de venda QtdVen* Quantidade de medida de venda PreVen* Preo de venda PedCli Nmero do pedido no cliente SeqPcl Seqncia do pedido no cliente CplIpd Complemento da descrio do produto CodDep Cdigo do depsito CodLot Nmero do lote QtdCan Quantidade cancelada DatEnt Data da entrega PerOfe Percentual de oferta PerDsc Percentual de desconto PerCom Percentual de comisso SitIpd Situao do item ResEst Reserva estoque (S=sim, N=no) IdxGrd Indexador da Grade CodFxa Cdigo da faixa da grade CodCcu Cdigo do centro de custo CtaRed Cdigo da conta contbil reduzida PerIpi Percentual de IPI PerIcm Percentual de ICMS PerIrf Percentual de IRRF PerCff Percentual de COFINS PerPif Percentual de PIS PerCrt Percentual de COFINS Retido PerPit Percentual de PIS Retido PerCsl Percentual de CSLL Retido CtaFin(n)* Conta financeira CtaRed(n)* Conta contbil reduzida CodCcu(n)* Cdigo do centro de custo PerCta(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 desconto NumPrj(n)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto ObsRat(n)* Observao do rateio

* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. * Informar apenas o percentual ou valor. * Utilizar estes campos para entrar com uma unidade de medida diferente da padro no informar QtdPed, PreUni.

Retorno: <SeqIpd>

Seqncia do item

Observao: Esta ao aceita campos de usurio.

2.2.4 GRAVAR ITEM DE PRODUTO PREVISO (INCLUIR/ALTERAR)

Ao: SID.Ped.GravarProdutoPrevisao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqIpd Seqncia informar somente para alterao CodPro Cdigo do produto CodDer Cdigo da derivao QtdPed Quantidade do produto Parmetros opcionais: TnsPro Transao para produtos UniVen* Unidade de medida de venda QtdVen* Quantidade de medida de venda PedCli Nmero do pedido no cliente SeqPcl Seqncia do pedido no cliente CplIpd Complemento da descrio do produto CodDep Cdigo do depsito QtdCan Quantidade cancelada DatEnt* Data da entrega CodPvp* Cdigo do perodo de produo e venda SitIpd Situao do item
* Utilizar estes campos para entrar com uma unidade de medida diferente da padro no informar QtdPed. * Informando valor para esse campo, ser sobreposta qualquer sugesto feita com base nos dados gerais do pedido ou a partir do cdigo do perodo de produo e venda. * Ao informar o campo CodPvp o sitema faz automaticamente a busca da data final do perodo e atribui esta ao item de produto.

Retorno: <SeqIpd>

Seqncia do item

Observao: Esta ao aceita campos de usurio.

2.2.5 GRAVAR ITEM DE SERVIO (INCLUIR/ALTERAR)

Ao: SID.Ped.GravarServico (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqIsp Seqncia informar somente para alterao CodSer Cdigo do servio QtdPed Quantidade do servio CodTpr* Cdigo da tabela de preo PreUni* Preo unitrio
* Utilizar CodTpr ou PreUni

Parmetros opcionais: TnsSer Transao para servios PedCli Nmero do pedido no cliente SeqPcl Seqncia do pedido no cliente CplIsp Complemento da descrio do servio QtdCan Quantidade cancelada DatEnt Data da entrega PerDsc Percentual de desconto PerCom Percentual de comisso SitIsp Situao do item CodCcu Cdigo do centro de custo CtaRed Cdigo da conta contbil reduzida PerIpi Percentual de IPI PerIcm Percentual de ICMS PerIss Percentual de ISS PerIns Percentual de INSS PerIrf Percentual de IRRF PerCff Percentual de COFINS PerPif Percentual de PIS PerCrt Percentual de COFINS Retido PerPit Percentual de PIS Retido PerCsl Percentual de CSLL Retido CtaFin(n)* Conta financeira** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custo

PerCta(n)* VlrCta(n)* PerRat(n)* VlrRat(n)* NumPrj(n)* CodFpj(n)* ObsRat(n)*

Percentual do rateio da conta*** Valor do rateio da conta*** Percentual do rateio*** Valor do rateio*** Nmero interno do projeto Cdigo da fase do projeto Observao do rateio

* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

Retorno: <SeqIsp>

Seqncia do item

Observao: Esta ao aceita campos de usurio.

2.2.6 FECHAR PEDIDO

Ao: SID.Ped.Fechar (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido Parmetros opcionais: RecPed Recalcular o pedido (0=No*, 1=Sim-buscando valores, 2=Sim-sem buscar valores)
* Valor padro

Retorno: "OK"

2.2.7 FECHAR PEDIDO PREVISO

Ao: SID.Ped.FecharPrevisao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido Retorno: "OK"

2.2.8 EXCLUIR PEDIDO

Ao: SID.Ped.Excluir (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido PedCli Nmero do pedido do Cliente Retorno: "OK" Observaes: Se o parmetro NumPed for informado, no necessrio informar o PedCli, e vice-versa.

2.2.9 EXCLUIR PEDIDO PREVISO

Ao: SID.Ped.ExcluirPrevisao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido Retorno: "OK"

2.2.10

EXCLUIR ITEM DE PRODUTO

Ao: SID.Ped.ExcluirProduto (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido

SeqIpd PedCli Retorno: "OK"

Seqncia do item de produto do pedido Nmero do Pedido do cliente

Observaes: Se o parmetro NumPed for informado, no necessrio informar o PedCli, e vice-versa.

2.2.11

EXCLUIR ITEM DE PRODUTO PREVISO

Ao: SID.Ped.ExcluirProdutoPrevisao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqIpd Seqncia do item de produto do pedido Retorno: "OK"

2.2.12

EXCLUIR ITEM DE SERVIO

Ao: SID.Ped.ExcluirServico (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqIsp Seqncia do item de servio do pedido PedCli Nmero do Pedido do cliente Retorno: "OK" Observaes: Se o parmetro NumPed for informado, no necessrio informar o PedCli, e vice-versa.

2.2.13

GRAVAR OBSERVAO (INCLUIR/ALTERAR)

Ao: SID.Ped.GravarObservacao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido ObsPed Texto da observao do pedido SitObs Situao da observao Parmetros opcionais: SeqObs Seqncia da observao do pedido SeqIpd Seqncia do item de produto do pedido que gerou a observao SeqIsp Seqncia do item de servio do pedido que gerou a observao CodMot Cdigo do motivo da observao SolObs Soluo dada a observao Retorno: <SeqObs> Seqncia da observao do pedido

Observao: Esta ao aceita campos de usurio.

2.2.14

EXCLUIR OBSERVAO

Ao: SID.Ped.ExcluirObservacao (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqObs Seqncia da observao do pedido Retorno: "OK"

2.2.15

LISTAR EMBALAGENS DO PEDIDO

Ao:

SID.Ped.ListarEmbalagens (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido Parmetros opcionais: CodEmp Cdigo da empresa CodFil Cdigo 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 CONFERNCIA DA EMBALAGEM

Ao: SID.Ped.ConfirmarConferEmb (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido SeqEmb* Seqncia de embalagem NumEmb* Nmero da embalagem * Pelo menos um desses campos deve ser informado, sendo os demais ignorados. Parmetros opcionais: CodEmp Cdigo da empresa CodFil Cdigo da filial Retorno: "OK"

2.2.17

SUBSTITUIR EMBALAGEM

Ao: SID.Ped.SubstituirEmb (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido EmbOri Nmero da embalagem original EmbSub Nmero da embalagem substituta Parmetros opcionais: CodEmp Cdigo da empresa CodFil Cdigo da filial Retorno: "OK"

2.2.18

ANALISAR ESTOQUE DE EMBALAGENS

Ao: SID.Ped.AnalisarEstoqueEmb (RVPE) Parmetros opcionais: AbrPed Abrangncia de nmero de pedidos CodEmp Cdigo da empresa CodFil Cdigo da filial DatEmi Data de emisso inicial DatEmf Data de emisso final DatEni Data de entrega inicial

DatEnf AceBlo Retorno: "OK"

Data de entrega final Aceita Pedido Bloqueado (S ou N (padro da rotina))

2.2.19

ANALISAR OBSERVAO DE BLOQUEIO POR REA

Ao: SID.Ped.AnalisarObsBloArea (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido bloqueado SeqObs Seqncia da observao de bloqueio a ser analisada AreEmp rea da empresa da observao de bloqueio AprRpr Se aprova ("S") ou desaprova ("N") a observao de bloqueio ObsSol Observao da soluo da observao de bloqueio analisada Parmetros opcionais: CodEmp Cdigo da empresa CodFil Cdigo da filial Retorno: "OK"

2.2.20

GRAVAR PEDIDO VIA CONTRATO DE LICITAO

Ao SID.Ped. GravarPedidoContrato (RVPE) Parmetros obrigatrios: XML Texto em formato SID XML, cuja definio 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 descrio de cada delimitador e sua funcionalidade ou obrigatoriedade est a seguir <pedidos></pedidos> Delimitadores da seqncia de pedidos a serem importados. Indicam que dentro dos mesmos existe uma seqncia de pedidos a serem importados. Esses delimitadores so obrigatrios na estrutura. <pedido></pedido> Delimitadores de um pedido. Devem existir um para cada pedido, e dentro desses delimitadores devem estar os campos e valores de um pedido. Esses delimitadores so obrigatrios na estrutura. <codcli></codcli> Dentro desses delimitadores deve estar o cdigo do cliente do pedido, que obrigatrio. Deve ser um cliente que esteja nos cadastros de clientes de um contrato e ativo no contrato e no sistema.

<pedcli></pedcli> Delimitadores do cdigo do nmero do pedido de cliente. opcional, porm se no contrato ou nas definies do cliente for exigido que deve ser informado o nmero do pedido do cliente, a importao desse pedido exigir como consistncia esse campo. Se o mesmo no vier informado, a importao do pedido ser cancelada, passando ao prximo pedido <ctrcli></ctrcli> Delimitadores onde deve estar o nmero do contrato do cliente para o pedido. Este campo opcional desde que nas definies do cliente exista o cdigo do contrato padro para o cliente do pedido. Pode ser informado independentemente disto, inclusive um nmero de contrato diferente do padro. Se informado, o sistema ir consistir se o contrato existe, est ativo, e possui o cliente do pedido informado nos seus clientes. Se no for informado e no houver um contrato padro nas definies do cliente, ou ocorrer algum erro de consistncia, a importao do pedido cancelada e ser passado ao prximo pedido. <numemp></numemp> Delimitadores do nmero de empenho do contrato. Este campo opcional, e no deve ser informado se o contrato no controlado por empenho. Se o contrato controlar por empenho e este campo no for informado, ser gerado um erro de consistncia informando que o contrato controla por empenho e o mesmo deve ser informado. Se o empenho informado for vlido, o sistema consiste 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 no for informada, sugerida a data corrente para o pedido. O valor atribudo a este campo (seja informado ou a data corrente), ser sugerido aos itens se no for informada data de entrega nos mesmos. A data de entrega consistida com o perodo de inatividade do cliente do pedido informado no contrato e se for controlado por empenho, ir consistir contra a validade do empenho. <seqent></seqent> Delimitador onde entre eles deve estar cdigo do endereo de entrega do pedido. Este campo opcional, mas se no cadastro de filial vendas estiver definido que o pedido deve conter o endereo de entrega esse campo obrigado a ser informado. <itens></itens> Delimitadores que indicam que dentro dos mesmos existe uma seqncia de itens do pedido a serem importados. Esses delimitadores so obrigatrios na estrutura e devem estar dentro dos delimitadores <pedido></pedidos>. <item></item> Delimitador que indica a existncia de um item de pedido a ser importado. Dentro desses delimitadores deve estar a seqncia de campos e valores do item do pedido a importar. Esses delimitadores so obrigatrios na estrutura e devem ser internos aos 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 cdigo do produto do cliente para o contrato atual. A funcionalidade dessse campo em conjunto com a funcionalidade do campo cdigo do produto, e documentada logo a seguir documentao deste campo, logo abaixo. <codpro></codpro> Delimitadores onde deve estar o cdigo do produto do Sapiens para o contrato atual Ao menos um dos cdigos de produto acima deve ser informado. Tambm ambos podem ser informados ao mesmo tempo, mas a precedncia ou o que ocorre em caso de erro descrita a seguir: a) Se ambos forem informados, o sistema busca primeiramente o cdigo do produto do cliente e o cdigo associado ao produto Sapiens. Se este existir, o cdigo do produto do Sapiens ignorado. Se no existir o cdigo do produto do cliente, o sistema utiliza o cdigo do produto do Sapiens. Se estiver correto assumido o cdigo do produto Sapiens e caso contrrio o sistema gera um erro e interrompe a importao do pedido atual, passando ao prximo pedido. b) Se apenas o cdigo do produto do cliente for informado, e se este existir, utilizado, sendo que o sistema busca o cdigo do produto do Sapiens associado. Caso contrrio gerado um erro e interrompida a importao do pedido atual, passando ao prximo pedido. c) Se apenas o cdigo do produto do Sapiens for informado, e se este existir, utilizado. Caso contrrio gerado um erro e interrompida a importao do pedido atual, passando ao prximo.

<datent></datent> Delimitadores onde deve estar a data de entrega do item do pedido. O valor do campo opcional, pois sugerido por padro a data de entrega dos dados gerais do pedido. Porm est disponvel para o caso em que seja necessrio possuir itens com datas de entrega diferentes em um mesmo pedido, sobrescrevendo a sugesto dos dados gerais do pedido. <qtdped></qtdped> Delimitadores da quantidade pedida do item. O valor nesse campo obrigatrio (deve ser igual a zero quando informa-se valores para a unidade de medida de venda) e se no for informado gerado um erro e interrompida a importao do pedido atual, passando ao prximo pedido. O valor informado consistido contra a quantidade mnima e mxima do item do contrato, e com o saldo de 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 preo de venda devem obrigatoriamente ser informados tambm.

<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 converso para a unidade de estoque (quantidade pedida) feita automaticamente pelo sistema. A quantidade pedida ento consistida contra a quantidade mnima e mxima do item do contrato, e com o saldo de quantidade desse item no contrato. <preven></preven> Delimitadores do preo 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 ao O retorno da ao um texto tambm em formato XML, dentro dos delimitadores <retorno></retonro>. Dentro desses delimitadores indicado o erro ou o sucesso na importao para cada pedido dentro da seqncia de pedidos, ordenados numericamente pela seqncia de entrada e iniciando em 1 (um) e envolvidos nos delimitadores <pedido ></pedido>. O nmero de ordenao exibido no retorno no o nmero de pedido no Sapiens. O formato geral do retorno para um pedido : <retorno> <pedido pedido= 'seqncia_do_pedido' [item='seqncia_do_item'] resultado='erro ou sucesso'>texto do ou nmero do pedido</pedido> . . . (demais pedidos) </retorno> O formato do retorno para um determinado pedido com erro durante a importao : <pedido pedido= 'seqncia_do_pedido' [item='seqncia_do_item'] resultado='erro'>texto_do_erro</pedido> onde 'seqncia_do_pedido' o nmero de seqncia em que foi processado o pedido delimitado pelos delimitadores <pedido></pedido> 'seqncia_do_item' o nmero de seqncia do item que est sendo processado dentro do pedido, caso o erro tenha ocorrido em um item delimitado pelos delimitadores <itens></itens>. A seqncia do item reiniciada para cada pedido. Se o erro for gerado pelos dados gerais ou outra consistncia no fechamento do pedido e validao dos valores contra o contrato, esse texto no exibido. 'texto_do_erro' a informao textual do erro ocorrido pela consistncia ou pela verificao da estrutura do comando XML para um pedido. O formato do retorno para um determinado pedido processado com sucesso : <pedido pedido= 'seqncia_do_pedido' resultado='sucesso'>numero pedido gerado = 'nmero_pedido_sapiens' </pedido> onde 'seqncia_do_pedido' tambm o nmero de seqncia em que foi processado o pedido delimitado pelos delimitadores <pedido></pedido> 'nmero_pedido_sapiens' o nmero do pedido gerado pelo Sapiens

erro

O texto de retorno plano e sem quebras de linha. Documentaes adicionais: Dentro dos delimitadores <pedidos></pedidos> podero ser informados vrios pedidos e dentro de cada delimitador <itens></itens> devem ser informados os vrios itens do pedido. A ao pode ser chamada individualmente para um pedido apenas, porm recomenda-se a utilizao de vrios pedidos dentro de uma nica ao, que confere um desempenho melhor importao. A funo ir processar pedido a pedido que estiver dentro dos delimitadores <pedidos></pedidos>. Caso ocorra um erro em um pedido, este pedido todo descartado e a funo segue processando o prximo pedido na seqncia. Ao final, ser gerado o retorno da funo indicando, para cada pedido com sucesso gerado, o seu nmero e para cada pedido no processado, o erro correspondente, na mesma seqncia que foi informada no documento XML. A rotina possui o mesmo funcionamento da rotina da tela do Comercial\Vendas\Pedidos\Via Contrato de Licitao, gerando pedidos com procedncia do tipo 8 e abatendo dos saldos de valor e quantidade dos itens do contrato padro ou do informado, bem como do empenho em relao a valores ou quantidades, conforme os parmetros do contrato. Os pedidos so gerados j fechados, ou

seja, no necessitam de conferncia. A filial e empresa em que so gerados os pedidos so o da filial ativa no Sapiens Server e no permitido indicar filial ou empresa na ao. Em relao ao documento XML a ser enviado ao, este deve ser plano, ou seja, sem quebras de linha e sem espaos entre os delimitadores. Os valores dentro dos delimitadores podem ter espaos entre os mesmos, desde que o valor no seja numrico. Segue um exemplo de uma ao 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 disponvel no item do contrato (500,00) insuficiente para atender ao valor lquido 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

Ao SID.Ped. GravarPedidoGrade (RVPE) Parmetros obrigatrios: SIDXML Texto em formato SID XML, cuja definio 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>

<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 descrio de cada delimitador e sua funcionalidade ou obrigatoriedade est a seguir <pedidos></pedidos> Delimitadores da seqncia de pedidos a serem importados. Indicam que dentro dos mesmos existe uma seqncia de pedidos a serem importados. Esses delimitadores so obrigatrios na estrutura. <pedido></pedido> Delimitadores de um pedido. Devem existir um para cada pedido, e dentro desses delimitadores devem estar os campos e valores de um pedido. Esses delimitadores so obrigatrios na estrutura. <tipped></tipped> Dentro desses delimitadores deve estar o tipo do pedido. Opcional, sendo considerado o tipo 1 se no for informado o tipo.

<codrep></codrep> Dentro desses delimitadores deve estar o cdigo do representante do pedido, que obrigatrio. <codcdi></codcdi> Dentro desses delimitadores deve estar o cdigo do canal de distribuio do pedido, que opcional, sendo sugerido o canal de distribuio padro do representante se no for informado. <codmar></codmar> Dentro desses delimitadores deve estar o cdigo da marca do pedido. O mesmo opcional, sendo sugerido o do cliente se no for informado. Porm, se no existir no cliente a marca padro, ser exigido ao consistir o pedido. <codcli></codcli> Dentro desses delimitadores deve estar o cdigo do cliente do pedido, que obrigatrio. Deve ser um cliente que esteja nos cadastros de clientes, ligado a marca e ativo no contrato e no sistema. <TnsPro></TnsPro> Esse campo tem como objetivo permitir informar uma transao para o pedido e seus itens diferente da transao padro existente nas configuraes do sistema. <catcli></catcli> Delimitadores do cdigo da categoria do cliente do pedido. opcional, sendo sugerida a categoria do cliente se no for informado. <codcpg></codcpg> Delimitadores onde deve estar o cdigo da condio de pagamento do pedido. Este campo opcional, desde que exista a sugesto do campo no sistema, nas marcas, representantes ou no prprio cliente. Se no existir sugesto ou no for informado, o mesmo exigido na consistncia do pedido. <codlip></codlip> Delimitadores onde deve estar o cdigo da lista de preo do pedido. Este campo opcional, desde que exista a sugesto do campo no sistema. Se no for informado ou no possuir sugesto, exigido na consistncia do pedido. Se informado, a regra de consistncia a mesma da rotina de pedidos em grade do cliente servidor. <codtpr></codtpr> Delimitadores onde deve estar o cdigo da tabela de preo do pedido. Este campo opcional, desde que exista a sugesto do campo no sistema. Se no for informado ou no possuir sugesto, exigido na consistncia do pedido. Se informado valor neste campo, a regra de consistncia a mesma da rotina de pedidos em grade do cliente servidor. <datprv></datprv> Delimitadores da data de entrega do pedido. Este campo opcional. Se no for informada, sugerida a data corrente para o pedido. O valor atribudo a este campo (seja informado ou a data corrente) ser sugerido aos itens se no for informada data de entrega nos mesmos. <pedcli></pedcli> Dentro desses delimitadores deve estar o cdigo do pedido do cliente, que opcional. <seqent></seqent> Dentro desses delimitadores deve estar o cdigo da seqncia do endereo de entrega do cliente, que opcional, a no ser que seja exigido se o cliente possuir mais de um endereo de entrega. <seqcob></seqcob> Dentro desses delimitadores deve estar o cdigo da seqncia do endereo de cobrana do cliente, que opcional, a no ser que seja exigido se o cliente possuir mais de um endereo de cobrana. <seqcto></seqcto> Dentro desses delimitadores deve estar o cdigo da seqncia do cdigo do contato do cliente, que opcional. <codven></codven> Dentro desses delimitadores deve estar o cdigo do vendedor do pedido, que opcional. Se no for informado, ser utilizado o cdigo do vendedor nas definies do cliente. <codtra></codtra> Dentro desses delimitadores deve estar o cdigo da transportadora do pedido, que opcional. Se no for informado, ser utilizado o cdigo da transportadora nas definies do cliente. Pode ser informado com vazio, sobrescrevendo a sugesto padro. <codred></codred> Dentro desses delimitadores deve estar o cdigo da transportadora de redespacho do pedido, que opcional. Se no for informado, ser utilizada a sugesto do sistema para o redespacho. Pode ser informado com vazio, sobrescrevendo a sugesto padro. <cepfre></cepfre> Dentro desses delimitadores deve estar o cdigo do CEP de frete para o pedido, que opcional. Se no for informado, ser utilizado a sugesto do sistema. Pode ser informado com vazio, sobrescrevendo a sugesto padro. <codfpg></codfpg> Dentro desses delimitadores deve estar o cdigo da forma de pagamento para o pedido, que opcional. Se no for informado, pode ser exigido se no cadastro do usurio existir um parmetro que obriga a informao desse campo. <itens></itens>

Delimitadores que indicam que dentro dos mesmos existe uma seqncia de itens grade do pedido a serem importados. Esses delimitadores so obrigatrios na estrutura e devem estar dentro dos delimitadores <pedido></pedidos>. <item></item> Delimitador que indica a existncia de um item grade de pedido a ser importado. Dentro desses delimitadores deve estar a seqncia de campos e valores do item grade do pedido a importar. Esses delimitadores so obrigatrios na estrutura e devem ser internos 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 cdigo do produto. Este campo obrigatrio, e pode ser um cdigo de produto que no existe. Se no existir, so exigidos o cdigo da famlia e cdigo do modelo no documento XML, pois sem os quais no possvel gerar o cdigo do novo produto. O novo produto ser gerado dentro das condies do sistema, avaliando se a montagem e estrutura do mesmo esto corretas. <codfam></codfam> Delimitadores onde deve estar o cdigo da famlia do produto. Este campo obrigatrio apenas se o produto for um novo produto (no existente no sistema). Pode ser informado mesmo que o produto seja j existente, pois no ser considerado se o produto j existir. <codmod></codmod> Delimitadores onde deve estar o cdigo do modelo de produo ligado ao produto. Este campo obrigatrio apenas se o produto for um novo produto (no existente no sistema). Pode ser informado mesmo que o produto seja j existente, pois no ser considerado se o produto j existir. <codfxa></codfxa> Delimitadores onde deve estar o cdigo da faixa do produto. Este campo obrigatrio. <codpgr></codpgr> Delimitadores onde deve estar o cdigo da proporcionalidade da faixa do produto. Este campo no obrigatrio. Se for informado, o sistema ir desconsiderar caso estejam sendo passadas derivaes e quantidades logo abaixo dos delimitares <derivacoes></derivacoes> no item atual, e ir gerar o item com as derivaes da proporcionalidade. Se no for passado, obrigatria a passagem de valores dentro dos delimitadores <derivacoes></derivacoes>. Nesse caso o sistema ir avaliar as derivaes corretamente e buscar ou gerar uma nova proporcionalidade conforme as derivaes passadas. <qtdgrd></qtdgrd> Delimitadores onde deve estar a quantidade de grades do item do pedido. opcional, sendo assumido o valor 1 se no for informado. Se ocorrer a exploso de grades, o mesmo desconsiderado. <codclc></codclc> Delimitadores onde deve estar o valor do campo coleo do item. Se a coleo no for informada, sugerida a coleo padro do produto. <derivacoes></derivacoes> Delimitadores onde devem estar internamente a eles as derivaes e respectivas quantidades de cada derivao. Os valores internos a esses delimitadores so considerados sempre que no for informada uma proporcionalidade para o item grade do pedido. Dentro dos delimitadores, para cada par derivao/quantidade, devem existir so seguintes delimitadores: <derivacao></derivacao> Dentro desses delimitadores deve estar informado um cdigo de derivao do produto. <quantidade></quantidade> Dentro desses delimitadores deve estar informada a quantidade da derivao imediatamente anterior Os dois delimitadores acima devem ser sempre em pares, com a derivao em primeiro e em seguida a sua respectiva quantidade. Se no existirem em forma de pares o sistema ir gerar erro e a importao do pedido atual no ser feita. <observacoes></observacoes> Delimitadores da seqncia de observaes a serem importadas para o pedido. Devem estar dentro dos delimitadores <pedido></pedido>. Indicam que dentro dos mesmos existe uma seqncia de observaes a serem importados. Esses delimitadores no so obrigatrios na estrutura. ignorada se no existirem as seqncias de observaes. <observacao></observacao> Delimitadores de uma observao do pedido. Para cada observao deve existir um delimitador destes. Dentro desses delimitadores estaro os campos de observao permitidos para importao, que esto descritos a seguir. Cada item observao gravado como uma observao manual na tabela de observaes do pedido atual. A situao da observao G (gravada). Se no existirem delimitadores internos a esse delimitador, no gravada observao. Observao: se for utilizado o controle de bloqueio por rea na filial e o parmetro E:AGRINGS no aplicativo, as observaes so geradas com a rea da empresa VEN (vendas) e no aprovadas. <obsped></obsped> Texto de uma observao do pedido. opcional, sendo ignorado se no existir valor ou o valor for vazio e no existir o cdigo do motivo da observao. Se existir apenas o cdigo do motivo, a observao gravada em branco. <codmot></codmot> Cdigo do motivo de uma observao do pedido. opcional, sendo ignorado se no existir valor ou o valor for vazio.

<campos_usuario></campos_usuario> Delimitadores de campos de usurio a serem importadas para o pedido. Devem estar dentro dos delimitadores <pedido></pedido>. Indicam que dentro dos mesmos existe campos de usurio a serem importados. Esses delimitadores no so obrigatrios na estrutura. ignorada se no existirem os campos de usurios. <campo_usurio></campo_usurio> Delimitadores de um campo de usurio do pedido. Para cada campo de usurio deve existir um delimitador destes. Dentro desses delimitadores estaro os valores dos campos de usurio permitidos para importao, que esto descritos a seguir. <nomcmp></nomcmp> Nome do campo de usurio do pedido na base de dados. obrigatrio, uma vez que seu valor usado para encontrar o campo de usurio onde o valor deve ser inserido. <vlrcmp></vlrcmp> Valor do campo de usurio do pedido na base de dados. obrigatrio e representa o valor do campo de usurio a ser importado para a base de dados. Para campos numricos ou hora deve ser informado apenas o valor inteiro. Para campos de valor real deve ser informado o valor com vrgula. Para campos texto ou data, deve ser informado por extenso, sem aspas simples ou dupla. Parmetros no obrigatrios: ManErrFec Indica que, se ocorrer erro no fechamento, o pedido no deva ser descartado, apenas gerado sem fechar. O nmero de pedido gerado, a situao (no fechado) e o erro ocorrido no fechamento sero evidenciados no retorno. ManErrIte Indica que, se ocorrer erro na gerao de um item de pedido, o pedido no deva ser descartado, e os demais itens devam ser processados normalmente, sem interromper todo o processo do pedido a ser importado. O pedido ser apenas gerado sem fechar. O nmero de pedido gerado, a situao (no fechado) e os erros ocorridos nos itens sero evidenciados no retorno. Retorno da ao O retorno da ao um texto tambm em formato XML, dentro dos delimitadores <retorno></retonro>. Dentro desses delimitadores indicado o erro ou o sucesso na importao para cada pedido dentro da seqncia de pedidos, ordenados numericamente pela seqncia de entrada e iniciando em 1 (um) e envolvidos nos delimitadores <pedido ></pedido>. O nmero de ordenao exibido no retorno no o nmero de pedido no Sapiens. O formato geral do retorno para um pedido : <retorno> <pedido pedido= 'seqncia_do_pedido' [item='seqncia_do_item'] resultado='erro ou sucesso'>texto do ou nmero do pedido</pedido> . . . . (demais pedidos) </retorno> O

erro

O formato do retorno para um determinado pedido com erro durante a importao : <pedido pedido= 'seqncia_do_pedido' [item='seqncia_do_item'] resultado='erro'>texto_do_erro</pedido> onde 'seqncia_do_pedido' o nmero de seqncia em que foi processado o pedido delimitado pelos delimitadores <pedido></pedido>

'seqncia_do_item' o nmero de seqncia do item grade que est sendo processado dentro do pedido, caso o erro tenha ocorrido em um item delimitado pelos delimitadores <itens></itens>. A seqncia do item reiniciada para cada pedido. Se o erro for gerado pelos dados gerais ou outra consistncia no fechamento do pedido e validao dos valores contra o contrato, esse texto no exibido.

'texto_do_erro' a informao textual do erro ocorrido pela consistncia ou pela verificao da estrutura do comando XML para um pedido.

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

<pedido pedido= 'seqncia_do_pedido' resultado='sucesso'>situao = 'fechado ou no fechado' [motivo = 'motivo do erro no fechamento'] nmero pedido gerado = 'nmero_pedido_sapiens' </pedido> onde 'seqncia_do_pedido' o nmero de seqncia em que foi processado o pedido delimitado pelos delimitadores <pedido></pedido>

'nmero_pedido_sapiens' o nmero do pedido gerado pelo Sapiens

'fechado ou no fechado' ir exibir o valor 'fechado' quando o pedido for fechado com sucesso ou 'no fechado' caso o parmetro ManErrFec for igual a 'S' e ocorrer erro no fechamento do pedido, sendo este apenas gravado

[motivo = 'motivo do erro no fechamento'] (sem os colchetes) ir ser exibido somente caso o parmetro ManErrFec for igual a 'S' e ocorre erro no fechamento do pedido, evidenciando o motivo do no fechamento do pedido, caso em que ser apenas gravado e no descartado o pedido

O texto de retorno plano e sem quebras de linha. O retorno da ao com o uso do parmetro no obrigatrio ManErrIte diferenciado. O formato geral do retorno para um pedido quando do uso do parmetro no obrigatrio ManErrIte : <retorno> <pedido pedido = 'seqncia_do_pedido' resultado='erro ou sucesso [, no pedido, com erros na gravao dos itens]'> <mensagem> texto do erro ou nmero do pedido </mensagem> [<itens><item item='seqncia_do_item_do_pedido'> texto_do_erro_do_item </itens>] </pedido> . . . . (demais pedidos) </retorno> O

O formato do retorno quando do uso do parmetro no obrigatrio ManErrIte para um determinado pedido com sucesso durante a importao do pedido (dados gerais, itens do pedido e fechamento) : <pedido pedido = 'seqncia_do_pedido' resultado='sucesso'> <mensagem> informaes sobre o pedido gerado pelo Sapiens </mensagem> </pedido> O formato do retorno quando do uso do parmetro no obrigatrio ManErrIte para um determinado pedido com erro no fechamento ou na gerao do pedido, durante a importao : <pedido pedido = 'seqncia_do_pedido' resultado = 'erro'> <mensagem> texto_do_erro </mensagem> </pedido> O formato do retorno quando do uso do parmetro no obrigatrio ManErrIte para um determinado pedido com erro nos itens, durante a importao : <pedido pedido = 'seqncia_do_pedido' resultado = 'sucesso no pedido, com erros na gravao dos itens'> <mensagem> <itens> <item item= 'seqncia_do_item_do_pedido'> texto_do_erro_do_item </item> </itens> </mensagem> </pedido> O formato do retorno quando do uso do parmetro no obrigatrio ManErrIte para um determinado pedido com erro no fechamento do pedido e erros nos itens, durante a importao : <pedido pedido = 'seqncia_do_pedido' resultado = 'erro no pedido, com erros na gravao dos itens'> <mensagem> texto_do_erro_do_pedido </mensagem> <itens> <item item= 'seqncia_do_item_do_pedido'> texto_do_erro_do_item </item> </itens> </pedido>

Documentaes adicionais: Dentro dos delimitadores <pedidos></pedidos> podero ser informados vrios pedidos e dentro de cada delimitador <itens></itens> devem ser informados os vrios itens do pedido. A ao pode ser chamada individualmente para um pedido apenas, porm recomenda-se a utilizao de vrios pedidos dentro de uma nica ao, que confere um desempenho melhor importao. A funo ir processar pedido a pedido que estiver dentro dos delimitadores <pedidos></pedidos>. Caso ocorra um erro em um pedido, este pedido todo descartado e a funo segue processando o prximo pedido na seqncia. O pedido gerado automaticamente fechado. Se ocorrer erro no fechamento, o pedido descartado, a no ser que exista o parmetro ManFecErr igual a 'S', que no caso ir apenas gravar o pedido se houver erro no fechamento. Ao final, ser gerado o retorno da funo indicando, para cada pedido com sucesso gerado, o seu nmero e para cada pedido no processado, o erro correspondente, na mesma seqncia que foi informada no documento XML. A rotina possui o mesmo funcionamento da rotina da tela do Comercial\Vendas\Pedidos\Via Grade de Produto, gerando pedidos fechados. A filial e empresa em que so gerados os pedidos so o da filial logada no Sapiens Server e no permitido indicar filial ou empresa na ao. Em relao ao documento XML a ser enviado ao, este deve ser plano, ou seja, sem quebras de linha e sem espaos entre os delimitadores. Os valores dentro dos delimitadores podem ter espaos entre os mesmos, desde que o valor no seja numrico. Segue um exemplo de uma ao com um pedido e dois itens: acao=sid.ped.gravarpedidograde sidxml= <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 importao</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> </campo_usuario> <campo_usuario> <nomcmp>usu_texto</nomcmp> <vlrcmp>Texto do pedido</vlrcmp> </campo_usuario> <campo_usuario> <nomcmp>usu_data</nomcmp> <vlrcmp>01/01/2008</vlrcmp> </campo_usuario> <campo_usuario> <nomcmp>usu_hora</nomcmp> <vlrcmp>658</vlrcmp> </campo_usuario> </campos_usuario> </pedido> <pedido> <tipped>6</tipped> <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> </itens> </pedido> </pedidos> Exemplo de um retorno com erro e um com sucesso: Com erro: <retorno><pedido pedido='1' resultado='erro'> necessrio informar o cliente</pedido></retorno>

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

2.2.22

CANCELAR PEDIDO

Ao: SID.Ped.Cancelar (RVPE) Parmetros obrigatrios: NumPed Nmero do pedido NumDav Nmero do DAV Retorno: "OK" Observaes: necessrio informar apenas um parmetro, porm possvel informar os dois.

2.3 SUPRIMENTOS COTAES

2.3.1 GRAVAR COTAO
Ao: SID.Cot.Gravar (SCCP) Parmetros obrigatrios: NumSol Nmero da solicitao SeqSol Seqncia da solicitao CodFor Cdigo do fornecedor QtdCot Quantidade cotada PreCot Preo da cotao PrzEnt Prazo de entrega Parmetros opcionais: TipRet Tipo de retorno da ao, quando bem sucedida (ver Retorno para mais detalhes) DscCot Percentual de Desconto IpiCot Percentual de IPI IcmCot Percentual de ICMS CodCpg Condio de pagamento DatPrv Data de previso de entrega ObsCot Observao da cotao de preo de compra CifFob Indicativo se o frete CIF ou FOB Retorno: Se o parmetro TipRet (tipo de retorno da ao) for: - 0 (padro): "OK"

- 1: <NumCot>/<SeqCot> (Nmero e seqncia da cotao gerada)

2.4 MERCADO NOTA FISCAL VENDA

2.4.1 GRAVAR CABEALHO DA NOTA FISCAL VENDA (INCLUIR)
Ao: SID.Nfv.Gravar (RFNF) Parmetros obrigatrios: CodSnf Srie da nota fiscal CodCli Cdigo do cliente TnsPro Transao da nota para produtos TnsSer Transao da nota para servios Parmetros opcionais: NumNfv Nmero da nota fiscal TipNfs Tipo da nota fiscal de sada CodCpg Cdigo da condio de pagamento CodEdc Espcie de documento DatEmi Data de emisso DatSai Data de sada CodFpg Cdigo da forma de pagamento CodRep Cdigo do representante CodTra Cdigo da transportadora CodEmb Cdigo da embalagem QtdEmb Quantidade de embalagens PesBru Peso bruto PesLiq Peso lquido PerDs1 Percentual de desconto-1 PerDs2 Percentual de desconto-2 PerDs3 Percentual de desconto-3 PerDs4 Percentual de desconto-4 PerEnc Percentual de encargos PerFre Percentual do frete ObsNfv Observao da nota VlrDar Valor de arredondamento (- desconto, + acrscimo) PrcNfv Procedncia da nota PreImp Nmero pr-impresso do formulrio da nota fiscal PlaVei Placa do veculo da nota fiscal TraMtr Transportadora do motorista CodMtr Cdigo do motorista VlrPar(n)* Valor da parcela a ser gerada** VctPar(n)* Data de vencimento da parcela** GerBai(n)* Indica se liquida o ttulo imediatamente aps sua gerao (S=sim, N=no) TnsBai(n)* Transao utilizada para baixar o ttulo
* (n) = Seqncia da parcela, variando de 1 at o total de parcelas No utilizar os parnteses. Se a sequncia da parcela no for informada para qualquer uma dessas variveis (exemplo: VlrPar=100 ou VctPar=01/01/2000 ou GerBai=S ou TnsBai=90355), ficar valendo apenas para a primeira parcela. ** Se no informados estes valores, a nota ser sempre gerada com uma nica parcela fixa. Utilizar ao "Sid.Nfv.RecalcularParcelas" para gerar parcelas da NF automaticamente conforme a condio de pagamento.

Retorno: <NumNfv>

Nmero da nota fiscal

Observaes: Somente incluso de notas fiscais tipo 1. Outros tipos podem ser includos, mas tipos de notas que possuem composio ou ligaes com outras tabelas no sero contemplados de forma automtica. Esta ao aceita campos de usurio.

2.4.2 FECHAR NOTA FISCAL VENDA

Ao: SID.Nfv.Fechar (RFNF) Parmetros obrigatrios: NumNfv Nmero da nota fiscal (no utilizar para fechamento agrupado) CodSnf Srie da nota fiscal Parmetros opcionais: NumIni Nmero da nota fiscal inicial (fechamento agrupado) NumFim Nmero 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=no, 1=sim*)

BusVal GerNfe MsgBlo

* Valor padro

Indicativo para buscar valores (0=no, 1=sim*) Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim) Indicativo se deve exibir o motivo do bloqueio no retorno (0=no*, 1=sim)

Retorno: "OK"

2.4.3 CANCELAR NOTA FISCAL VENDA

Ao: SID.Nfv.Cancelar (RFNF) Parmetros obrigatrios: NumNfv Nmero da nota fiscal CodSnf Srie da nota fiscal Parmetros opcionais: ExcUlt Excluir fisicamente a nota fiscal, caso seja a ltima gerada (0=no*, 1=sim) GerNfe Indicativo para gerar arquivo eletrnico de cancelamento de nota fiscal de sada (0 =no, 1=sim*)
* Valor padro

Retorno: "OK" Observao: O parmetro ExcUlt somente ir excluir a nota fiscal de sada se ela estiver com situao de digitao (E140Nfv.SitNfv = 1), alm de ser a ltima nota da srie fiscal.

2.4.4 RECALCULAR PARCELAS (BASEADO NA COND. PGTO.)

Ao: SID.Nfv.RecalcularParcelas (RFNF) Parmetros obrigatrios: NumNfv Nmero da nota fiscal CodSnf Srie da nota fiscal Retorno: "OK"

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

Ao: SID.Nfv.GravarProduto (RFNF) Parmetros obrigatrios: NumNfv Nmero da nota fiscal CodSnf Srie da nota fiscal SeqIpv Seqncia do item CodPro Cdigo do produto CodDer Cdigo da derivao (quando existir) QtdFat Quantidade faturada PreUni Preo unitrio Parmetros opcionais: TnsPro Transao dos itens NopPro Natureza da operao CplIpv Complemento da descrio CodTpr Cdigo da tabela de preo PesBru Peso bruto PesLiq Peso lquido FilPed Filial do pedido NumPed Nmero do pedido SeqIpd Seqncia do pedido PreBas Preo base PerDsc Percentual de desconto PerIpi Percentual de IPI PerIcm Percentual de ICMS PerFun Percentual de Funrural VlrFre Valor do frete VlrSeq Valor do seguro VlrLiq Valor lquido CodLot Nmero do lote VlrDar Valor de arredondamento (- desconto, +acrscimo) CodDep Cdigo do depsito

UniVen FilNfc CodFor NumNfc SnfNfc SeqIsc Retorno: "OK"

Unidade de medida de venda Filial da nota fiscal de entrada Cdigo do fornecedor Nmero da nota fiscal de entrada Cdigo da srie da nota fiscal de entrada Seqncia do item de servio da NF de entrada

Observao: Esta ao aceita campos de usurio. O parmetro PreUni torna-se opcional quando CodTpr informado. Ao informar CodTpr no necessrio informar PreUni, pois o preo unitrio passado(PreUni) ser substitudo pelo valor unitrio da tabela de preo. Caso o cliente da nota possua uma tabela de preo associada nas suas definies, PreUni e CodTpr no precisam ser informados, pois o sistema busca a tabela de preo das definies do cliente e atribui para o item. Com isso o sistema busca o preo unitrio do item conforme tabela de preo. Quando for enviada a alquota de ICMS como parmetro, o cdigo de ICMS Especial da transao ou do produto ser ignorado e a alquota de ICMS enviada ser mantida.

2.4.6 GRAVAR ITEM DE SERVIO NA NOTA FISCAL VENDA (INCLUIR)

Ao: SID.Nfv.GravarServico (RFNF) Parmetros obrigatrios: NumNfv Nmero da nota fiscal CodSnf Srie da nota fiscal SeqIsv Seqncia do item CodSer Cdigo do servio QtdFat Quantidade faturada PreUni Preo unitrio Parmetros opcionais: TnsSer Transao dos itens NopSer Natureza da operao CplIsv Complemento da descrio do servio CodTpr Cdigo da tabela de preo FilPed Filial do pedido NumPed Nmero do pedido SeqIsp Seqncia do pedido PerDsc Percentual de desconto PerIpi Percentual de IPI PerIcm Percentual de ICMS VlrLiq Valor lquido FilCtr Cdigo da filial do contrato de venda NumCtr Nmero do contrato que gerou a nota DatCpt Ms e ano de competncia do item do contrato SeqCvs Seqncia do item do contrato na competncia UniMed Unidade de medida do servio PerIss Percentual do ISS PerIrf Percentual do IRRF PerIns Percentual do INSS PerCom Percentual de comisso do servio NumPrj Nmero do projeto CodFpj Cdigo da fase do projeto CtaFin Conta financeira CtaRed Conta contbil CodCcu Centro de custos FilNfc Filial da nota fiscal de entrada CodFor Cdigo do fornecedor NumNfc Nmero da nota fiscal de entrada SnfNfc Cdigo da srie da nota fiscal de entrada SeqIsc Seqncia do item de servio da NF de entrada QtdDev Soma das quantidades devolvidas da NF de entrada VlrDar Valor de arredondamento (- desconto, +acrscimo) Retorno: "OK" Observao: Esta ao aceita campos de usurio. O parmetro PreUni torna-se opcional quando CodTpr informado. Ao informar CodTpr no necessrio informar PreUni, pois o preo unitrio passado(PreUni) ser substitudo pelo valor unitrio da tabela de preo.

Caso o cliente da nota possua uma tabela de preo associada nas suas definies, PreUni e CodTpr no precisam ser informados, pois o sistema busca a tabela de preo das definies do cliente e atribui para o item. Com isso o sistema busca o preo unitrio do item conforme tabela de preo. Quando for enviada a alquota de ICMS como parmetro, o cdigo de ICMS Especial da transao ou do servio ser ignorado e a alquota de ICMS enviada ser mantida.

2.4.7 CANCELAR FATURA

Ao: SID.Nfv.CancelarFatura (RFNF) Parmetros obrigatrios: NumNff Nmero da fatura a ser cancelada Retorno: "OK"

2.4.8 LISTAR EMBALAGENS DA NFV PARA CONTROLE DE EMBARQUE

Ao: SID.Nfv.ListarEmbCtrlEbq (RFNF) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial CodSnf Cdigo da srie da nota fiscal NumNfv Nmero da nota fiscal Parmetros opcionais: NumEbq Nmero do embarque CodTra Cdigo da transportadora Retorno: Xml contendo o nmero 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> Observaes: Alm de listar as embalagens de uma nota, essa ao verifica o controle de embarque. Passando-se 0 no parmetro NumEbq um novo nmero de controle de embarque gerado e retornado, seno consistida a existncia de um controle de embarque com tal nmero.

2.4.9 COMPOR O DOCUMENTO DE EMBARQUE COM A NFV

Ao: SID.Nfv.ComporCtrlEbq (RFNF) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial CodSnf Cdigo da srie da nota fiscal NumNfv Nmero da nota fiscal NumEbq Nmero do embarque Retorno: "OK" Observaes:

Antes dessa ao deve ser executada a SID.Nfv.ListarEmbCtrlEbq, que se encarregar de gerar um nmero de controle de embarque, devendo este ser passado para esta ao pelo parmetro NumEbq.

2.4.10

2.4.10 ATUALIZAO DA SITUAO DA NFV ELETRNICA

Ao: SID.Nfv.AtualizarNFE (RFNF) Parmetros obrigatrios NF-e: ChvNel Nmero da chave de acesso nota fiscal eletrnica. SitNel Situao (1=No Enviada, 2=Enviada, 3=Autorizada, 4=Rejeitada, 5=Denegada, 6=Solicitado Inutilizao, 7=Solicitado Cancelamento, 8=Inutilizada, 9=Cancelada, 10=Erro Gerao, 11-Erro Solicitao Cancelamento, 12-Erro Solicitao Inutilizao, 13-Impresso em Modo Contingncia). NumPrt Nmero do protocolo da nota fiscal eletrnica. DatHor Data e Hora de Autorizao da NF-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28). Parmetros obrigatrios para CC-e: SeqEve Sequncia do evento da carta de correo eletrnica. Parmetros opcionais: ChvNov Nova chave de acesso da nota fiscal eletrnica. DesMot[x] onde x a seqncia da observao. Exemplo: DesMot1, DesMot2, Desmot3... Retorno: "OK" Observao: Campos obrigatrios de um retorno de NF-e autorizada, cancelada ou inutilizada. Campos obrigatrios de um retorno de problema na solicitao de autorizao/cancelamento/inutilizao. * DesMot[x] s vlido para retorno de problema na solicitao de autorizao ou problema na solicitao de cancelamento/inutilizao. O uso desta ao SID exclusivo para clientes que possuem a integrao IENF (Nota Fiscal Eletrnica) ativada em sua proprietria. No retorno da CC-e s podero ser informadas 3 situaes: 3- Autorizada, 4 Rejeitada , 5 Denegada e 10=Erro Gerao. Ao informar SeqEve assumi-se que a solicitao se trata de uma CC-e. Documentaes adicionais:

Retornos esperados na nota fiscal eletrnica. Situao do documento no Sapiens 2 = Enviada 2 = Enviada 2 = Enviada 2 = Enviada 6 = Solicitado Inutilizao 6 = Solicitado Inutilizao 7 = Solicitado Cancelamento 7 = Solicitado Cancelamento Retorno esperado 3 = Autorizada 4 = Rejeitada 5 = Denegada 10 = Erro Gerao 8 = Inutilizada 12 = Erro Solicitao Inutilizao 9 = Cancelada 11 = Erro Solicitao Cancelamento Documento aguardando inutilizao. Somente so vlidos os retornos de documento eletrnico inutilizado(8) ou erro na solicitao de inutilizao(12). Foi informado a situao do documento eletrnico como = X. Documento aguardando cancelamento. Somente so vlidos os retornos de documento eletrnico cancelado(9), erro na solicitao de cancelamento(11). Foi informado a situao do documento eletrnico como = X. Documento aguardando autorizao. Somente so vlidos os retornos de documento eletrnico autorizado(3), rejeitado(4), denegado(5) ou erro de gerao (10). Foi informado a situao do documento eletrnico como = X. Mensagem de retorno quando no est nas situaes esperadas

Retornos esperados na Carta de Correo eletrnica. Situao do documento no Sapiens 2 = Enviada 2 = Enviada 2 = Enviada 2 = Enviada Retorno esperado 3 = Autorizada 4 = Rejeitada 5 = Denegada 10 = Erro Gerao Carta de correo aguardando autorizao. Somente so vlidos os retornos de autorizado(3), rejeitado(4), denegado(5) ou erro gerao(10). Foi informada a situao da carta de correo eletrnica como = X. Mensagem de retorno quando no est nas situaes esperadas

Caso ocorra uma situao totalmente incomum, como por exemplo a situao do documento no Sapiens ser 3 = Autorizada, e receber um retorno 3 = Autorizada ser retornada a mensagem "No foi solicitado um retorno para esse documento eletrnico. ".

2.4.11

ATUALIZAO DA SITUAO DO CT ELETRNICO

Ao: SID.Nfv.AtualizarCTE (RFNF) Parmetros obrigatrios: ChvNel Nmero da chave de acesso do conhecimento de transporte eletrnico. SitNel Situao (1=No Enviada, 2=Enviada, 3=Autorizada, 4=Rejeitada, 5=Denegada, 6=Solicitado Inutilizao, 7=Solicitado Cancelamento, 8=Inutilizada, 9=Cancelada, 10=Erro Gerao, 11-Erro Solicitao Cancelamento, 12-Erro Solicitao Inutilizao, 13-Impresso em Modo Contingncia). NumPrt Nmero do protocolo do conhecimento de transporte eletrnico. DatHor Data e Hora de Autorizao do CT-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28). Novo nmero para chae de acesso da nota fiscal eletrnica. Parmetros opcionais: ChvNov DesMot[x] onde x a sequncia da observao. Exemplo: DesMot1, DesMot2, Desmot3... Data e Hora de Autorizao do CT-e (ex: AAAA-MM-DDTHH:MM; ex2: 2008-10-30T09:28). Retorno: "OK" Observao: Campos obrigatrios de um retorno de CT-e autorizado, cancelada ou inutilizada.. Campos obrigatrios de um retorno de problema na solicitao de autorizao/cancelamento/inutilizao. * DesMot[x] s vlido para retorno de problema na solicitao de autorizao ou problema na solicitao de cancelamento/inutilizao. O uso desta ao SID exclusivo para clientes que possuem a integrao ICTE (Conhecimento de Transporte Eletrnico) ativada em sua proprietria. Documentaes adicionais: Retornos esperados no Conhecimento de Transporte Eletrnico. Situao do documento no Sapiens 2 = Enviada 2 = Enviada 2 = Enviada 2 = Enviada 6 = Solicitado Inutilizao 6 = Solicitado Inutilizao 7 = Solicitado Cancelamento 7 = Solicitado Cancelamento Retorno esperado 3 = Autorizada 4 = Rejeitada 5 = Denegada 10 = Erro Gerao 8 = Inutilizada 12 = Erro Solicitao Inutilizao 9 = Cancelada 11 = Erro Solicitao Cancelamento Documento aguardando inutilizao. Somente so vlidos os retornos de documento eletrnico inutilizado(8) ou erro na solicitao de inutilizao(12). Foi informado a situao do documento eletrnico como = X. Documento aguardando cancelamento. Somente so vlidos os retornos de documento eletrnico cancelado(9), erro na solicitao de cancelamento(11). Foi informado a situao do documento eletrnico como = X. Documento aguardando autorizao. Somente so vlidos os retornos de documento eletrnico autorizado(3), rejeitado(4), denegado(5) ou erro de gerao (10). Foi informado a situao do documento eletrnico como = X. Mensagem de retorno quando no est nas situaes esperadas

Caso ocorra uma situao totalmente incomum, como por exemplo a situao do documento no Sapiens ser 3 = Autorizada, e receber um retorno 3 = Autorizada ser retornada a mensagem "No foi solicitado um retorno para esse documento eletrnico. ".

2.4.12

ATUALIZAO DA SITUAO DA NFS ELETRNICA

Ao: SID.Nfv.AtualizarNFSE (RFNF) Parmetros obrigatrios: NumCgc * Nmero do CNPJ da Filial NumRps Nmero do RPS CodSnf Cdigo da Srie RPS NumNfs * Nmero da Nota Fiscal de Servio Eletrnica CodVrf Cdigo de verificao da Nota fiscal eletrnica de Servio DatHor Data e Hora de Autorizao da NF-e (ex: AAAA-MM-DDTHH:MM; ex2: 2009-06-30T09:28). IndSuc * Indica se a solicitao ocorreu com sucesso (1=Sim, 2=No, 3=Erro**) Parmetros opcionais:

DesMot[x] onde x a sequncia da observao. Exemplo: DesMot1, DesMot2, Desmot3... Retorno: "OK" Observao: Campos obrigatrios de um retorno de NFS-e autorizada. Campos obrigatrios de um retorno de cancelamento. Campos obrigatrios de um retorno de problema na solicitao de autorizao. * Campos obrigatrios de um retorno de problema na solicitao de cancelamento. ** Tipo de Retorno somente permitido quando a solicitao for de autorizao. *** DesMot[x] s vlido para retorno de problema na solicitao de autorizao ou problema na solicitao de cancelamento. O uso desta ao SID exclusivo para clientes que possuem a integrao IENS (Nota Fiscal de Servio Eletrnica) ativada em sua proprietria. Documentaes adicionais: Retornos esperados na nota fiscal eletrnica de servio. Situao do documento no Sapiens 2 = Enviada 2 = Enviada 2 = Enviada 7 = Solicitado Cancelamento 7 = Solicitado Cancelamento Retorno esperado 3 = Autorizada 4 = Rejeitada 10 = Erro Gerao 9 = Cancelada 11 = Erro Solicitao Cancelamento Mensagem de retorno quando no est nas situaes esperadas Documento aguardando autorizao. Somente so vlidos os retornos de documento eletrnico autorizado(3), rejeitado(4), denegado(5) ou erro de gerao (10). Foi informado a situao do documento eletrnico como = X. Documento aguardando cancelamento. Somente so vlidos os retornos de documento eletrnico cancelado(9), erro na solicitao de cancelamento(11). Foi informado a situao do documento eletrnico como = X.

2.4.13

FECHAR CONTROLE DE EMBARQUE

Ao: SID.Nfv.FecharCtrlEbq (RFNF) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial NumEbq Nmero do embarque Retorno: Embarque fechado com sucesso. Observaes: Quando definido NumEbq e executada a ao o controle de embarque fechado. No permitindo mais que o controle de embarque sej alterado.

2.4
2.4.14

SUPRIMENTOS NOTA FISCAL COMPRA

GRAVAR CABEALHO DA NOTA FISCAL COMPRA (INCLUIR)

Ao: SID.Nfc.Gravar (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada TnsPro* Transao da NF entrada para produtos TnsSer* Transao da NF entrada para servios Parmetros opcionais: CodCpg Cdigo da condio de pagamento da nota fiscal de entrada TipNfe Tipo de nota fiscal de entrada UfsCic Sigla do estado base para o clculo do ICMS CodEdc Espcie de documento para fins fiscais CodTri Cdigo de tributao para emisso da DARF DatEnt Data da Entrada da Nota NopPro Natureza de operao para produtos NopSer Natureza de operao para servios DatEmi Data de emisso da nota fiscal de entrada CodFpg Cdigo da forma de pagamento CodTra Cdigo da transportadora da nota fiscal de entrada

CodRed QtdEmb CodEmb NumEmb ObsNfc PesBru PesLiq PerDs1 PerDs2 PerFin VlrDzf VlrFre VlrDs1 VlrDs2 VlrDar VlrFin NumLot VlrInf IntImp TipNdi NumDoi DatDoi LocDes DatDes UfsDes CodExp VlrFei VlrSei VlrOui CifFob SomFre DatParSid Retorno: <NumNfc>

Cdigo da transportadora de redespacho da nota fiscal de entrada Quantidade de embalagens da nota fiscal Cdigo da embalagem Numerao das embalagens da nota fiscal Texto da observao Peso bruto da nota fiscal de entrada Peso lquido da nota fiscal de entrada Percentual de desconto - 1 do fornecedor Percentual de desconto - 2 do fornecedor Percentual de Acrscimo Financeiro Valor do desconto referente zona franca Valor do frete da nota fiscal de entrada Valor do desconto - 1 do fornecedor Valor do desconto - 2 do fornecedor Valor dos descontos para arredondamento do total da nota fiscal de entrada Valor lquido da nota fiscal para o financeiro Nmero do lote contbil Valor informado para fechamento Indicativo se a nota foi integrada com mdulo de impostos Tipo do documento de importao Nmero do documento de importao (Comrcio Exterior) Data do documento de importao (Comrcio Exterior) Local de desembarao Data do desembarao aduaneiro Sigla da UF onde ocorreu o desembarao aduaneiro Cdigo do exportador (Fornecedor emitente da Nf-e) Valor de Frete de importao Valor de Seguro de importao Valor de Outras Despesas de importao Indicativo se o frete para o cliente CIF (C) ou FOB (F) Somar o valor do frete no valor da nota fiscal Indica se deve gerar as parcelas pela data de emisso (0=no, 1=sim*). *Padro Nmero da nota

Observaes: * Somente incluso de notas fiscais tipo 1. * Outros tipos podem ser includos, mas tipos de notas que possuem composio ou ligaes com outras tabelas no sero contemplados de forma automtica. de responsabilidade do desenvolvedor que ir utilizar as aes SID de nota fiscal de entrada cujo tipo for diferente de 1 (no contemplado) definir todos os campos de ligao, tabelas relacionadas, valores, enfim tudo que o sistema faz de forma automtica quando utilizado a tela em si. * Aceita campos de usurio.

2.4.15

GRAVAR ITEM DE PRODUTO NA NOTA FISCAL COMPRA (INCLUIR)

Ao: SID.Nfc.GravarProduto (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada TnsPro Transao de produto do item da nota CodPro Cdigo do produto da nota fiscal de entrada CodDer Cdigo da derivao do produto da nota fiscal de entrada QtdRec Quantidade recebida do item da nota fiscal de entrada PreUni Preo unitrio do item da nota fiscal de entrada Parmetros opcionais: SeqIpc Seqncia do item na nota fiscal de entrada NopPro Cdigo da natureza de operao FilOcp Cdigo da filial da ordem de compra NumOcp Nmero da ordem de compra da nota fiscal de entrada SeqIpo Sequncia do item na ordem de compra da nota fiscal de entrada CodClf Cdigo da classificao fiscal do item da nota fiscal de entrada CodStr Situao tributria do item da nota fiscal de entrada CodTic Cdigo do ICMS especial CodTrd Cdigo de reduo de impostos CodTst Cdigo do ICMS substitudo CodStp Cdigo de substituio do PIS CodStc Cdigo de substituio do COFINS CodDep Cdigo do depsito para entrada de estoque do produto CodLot Cdigo do lote de estocagem DatVlt Data de validade do lote

UniNfc QtdAjb QtdDev UniMed QtdEst VlrFum QtdFre ForFre PesBru PesLiq PreEst PreBas PerDsc PerDs3 PerDs4 PerDs5 PerIpi PerIcm PerFun NumPrj CodFpj CtaFin CtaRed CodCcu VlrFre VlrSeg VlrEmb VlrEnc VlrOut VlrDar VlrFrd VlrOud VlrBru VlrDsc VlrDs1 VlrDs2 VlrDs3 VlrDs4 VlrDs5 VlrDzf VlrBfu VlrFun VlrBip VlrIpi VlrBid VlrIpd VlrBic VlrIcm VlrDfa VlrBsi VlrIcs VlrBsd VlrIsd VlrBsp VlrStp VlrBsc VlrStc VlrIip VlrIic VlrOip VlrOic VlrLpr VlrLou VlrLiq VlrFin AcrFin EmpNfv FilNfv SnfNfv NumNfv SeqIpv CodFab NumEpi VlrBpi VlrPis FilCtr NumCtr

Cdigo da unidade de medida da nota fiscal de entrada Quantidade de Ajuste de Balana para Efeito de Estoque Quantidade devolvida do item da nota fiscal de entrada Unidade de medida de estoque do item da nota fiscal de entrada Quantidade de entrada conforme unidade de medida de estoque Valor do frete por unidade de medida quando CIF Quantidade base na unidade do produto valida para o valor do frete Cdigo do fornecedor para gerao ttulo de frete Peso bruto do item da nota fiscal de entrada Peso lquido do item da nota fiscal de entrada Preo do item conforme unidade de medida de estoque Preo unitrio base para o movimento de estoque Percentual de desconto do item da nota fiscal de entrada Percentual de desconto 3 Percentual de desconto 4 Percentual de desconto 5 Percentual de IPI do item da nota fiscal de entrada Percentual do ICM do item da nota fiscal de entrada Percentual do Funrural ou INSS Nmero do projeto Cdigo da fase do projeto Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Valor frete Valor do seguro Valor embalagem Valor encargos financeiros Valor outras despesas Valor para arredondamento Valor frete destacado Valor outras despesas destacado Valor bruto do item da nota fiscal de entrada Valor do desconto do item da nota fiscal de entrada Valor do desconto 1 Valor do desconto 2 Valor de desconto 3 Valor de desconto 4 Valor de desconto 5 Valor do desconto referente zona franca Valor base do Funrural ou INSS Valor do Funrural ou INSS Valor base IPI Valor do IPI do item da nota fiscal de entrada Valor base IPI presumido (50% compra no comrcio) Valor do IPI presumido (50% compra no comrcio) Valor base do ICMS Valor do ICMS do item da nota fiscal de entrada Valor da diferena de alquota inter-estadual Valor base ICMS substitudo Valor do ICMS substitudo do item da nota fiscal de entrada Valor base ICMS substitudo destacado Valor ICMS substitudo destacado Valor base da substituio tributrio do PIS Valor da substituio tributria do PIS Valor base da substituio tributrio da COFINS Valor da substituio tributria do COFINS Valor isentas IPI Valor isentas ICMS Valor outras IPI Valor outros ICMS Valor do produto Valor dos outros valores Valor lquido do item da nota fiscal de entrada Valor do item vlido para o financeiro Valor de Acrscimo Financeiro Cdigo da empresa da nota fiscal de sada Cdigo da filial da nota fiscal de sada Srie da nota fiscal de sada Nmero da nota fiscal de sada Sequncia do item da nota fiscal de sada Cdigo do Fabricante Identificador da inspeo aberta para a liberao do item Valor base do PIS a recuperar Valor do PIS a recuperar do item da nota fiscal de entrada Cdigo da filial do contrato de compra Nmero do contrato que gerou a nota fiscal de entrada

SeqCcp VlrBcr VlrCor PerIim VlrBii VlrIim VlrRis PerPit VlrBpt VlrPit PerCrt VlrBct VlrCrt PerCsl VlrBcl VlrCsl PerOur VlrBor VlrOur PerIrf VlrBir VlrIrf PerDs1 PerDs2 BecIpi VecIpi BecIcm VecIcm VlrFei VlrSei VlrOui BcoImp CofImp BpiImp PisImp VlrBpf PerPif VlrPif VlrBcf PerCff VlrCff IgnOcp RecNot NumAdi SeqAdi DscAdi FabEst DatParSid Retorno: <SeqIpc>

Sequncia do item do contrato na competncia Valor base do Cofins a recuperar Valor do Cofins a recuperar Percentual de imposto de importao do item da nota fiscal de entrada Valor base imposto de importao Valor do imposto de importao do item da nota fiscal de entrada Valor de reteno de ICMS Substituto Percentual de PIS Retido Valor base do PIS Retido Soma dos valores do PIS retido Percentual de Cofins Retido Valor base do Cofins Retido Valor do Cofins Retido Percentual de CSLL Retido Valor base do CSLL Retido Valor do CSLL Retido Percentual de Outras Retenes Valor base de Outras Retenes Valor de Outras Retenes Percentual do IRRF Valor base IRRF Valor do IRRF Percentual de desconto 1 Percentual de desconto 2 Valor base de IPI creditado efetivamente Valor de IPI creditado efetivamente Valor base de ICMS creditado efetivamente Valor ICMS Cred. Efetivamente Valor de frete de importao Valor de seguro de importao Valor de outras despesas de importao Valor base do cofins a recuperar na importao Valor do cofins a recuperar na importao Valor base do pis a recuperar na importao Valor do pis a recuperar na importao Valor Base do PIS Faturamento Percentual do PIS Faturamento Valor do PIS Faturamento Valor Base do COFINS Faturamento Percentual do COFINS Faturamento Valor do COFINS Faturamento Ignora a carga de dados da OCP, se informada (0=no*, 1=sim). *Padro Indica se deve executar o reclculo de valores dos itens (0=no, 1=sim*). *Padro Nmero da adio Nmero sequencial do item dentro da adio Valor do desconto do item da DI adio Cdigo do fabricante estrangeiro Indica se deve gerar as parcelas pela data de emisso (0=no, 1=sim*). *Padro Seqncia do item gerado

Observao: Esta ao aceita campos de usurio.

2.4.16

GRAVAR ITEM DE SERVIO NA NOTA FISCAL COMPRA (INCLUIR)

Ao: SID.Nfc.GravarServico (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada TnsSer Transao de servio do item da nota CodSer Cdigo do servio da nota fiscal de entrada PreUni Preo unitrio do servio da nota fiscal de sada Parmetros opcionais: SeqIsc Sequncia do item na nota fiscal de entrada FilOcp Cdigo da filial da ordem de compra NumOcp Nmero da ordem de compra da nota fiscal de entrada SeqIso Sequncia da ordem de compra da nota fiscal de entrada NopSer Cdigo da natureza de operao CodTri Cdigo de tributao para emisso da DARF QtdRec Quantidade recebida do servio da nota fiscal de entrada QtdDev Soma das quantidades devolvidas pelas NF de sada

UniMed PerDsc PerIss PerIrf PerIns NumPrj CodFpj CtaFin CtaRed CodCcu VlrEnc VlrOut VlrDar VlrOud VlrBru VlrDsc VlrDs1 VlrDs2 VlrBis VlrIss VlrBir VlrIrf VlrBin VlrIns VlrLse VlrLou VlrLiq VlrFin AcrFin EmpNfv FilNfv SnfNfv NumNfv NumEpi CodClf CodStr CodTic CodTrd CodTst PerIpi PerIcm VlrDzf VlrBip VlrIpi VlrBid VlrIpd VlrBic VlrIcm VlrDfa VlrBsi VlrIcs VlrBsd VlrIsd VlrIip VlrIic VlrOip VlrOic VlrBpi VlrPis FilCtr NumCtr VlrBcr VlrCor VlrBct VlrCrt PerCrt VlrBpt VlrPit PerPit VlrBcl VlrCsl PerCsl VlrBor VlrOur PerOur VlrRis PerDs1

Unidade de medida do servio da nota fiscal de entrada Percentual de desconto do servio da nota fiscal de entrada Percentual do ISS do servio da nota fiscal de entrada Percentual do IRRF do servio da nota fiscal de entrada Percentual do INSS Nmero do projeto Cdigo da fase do projeto Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Valor encargos financeiros Valor outras despesas Valor para arredondamento Valor outras despesas destacado Valor bruto do servio da nota fiscal de entrada Valor do desconto do servio da nota fiscal de entrada Valor do desconto - 1 do fornecedor Valor do desconto - 2 do fornecedor Valor base ISS Valor do ISS sobre o servio da nota fiscal de entrada Valor base IRRF Valor do IRRF sobre o servio da nota fiscal de entrada Valor base do INSS Valor do INSS Valor do servio Valor dos outros valores Valor lquido do item de servio da nota fiscal de entrada Valor do item vlido para o financeiro Valor de Acrscimo Financeiro Cdigo da empresa da nota fiscal de sada Cdigo da filial da nota fiscal de sada Srie da nota fiscal de sada Nmero da nota fiscal de sada Identificador da inspeo aberta para o item Cdigo da classificao fiscal do item da nota fiscal de entrada Situao tributria do item da nota fiscal de entrada Cdigo do ICMS especial Cdigo de reduo de impostos Cdigo do ICMS substitudo Percentual de IPI do item da nota fiscal de entrada Percentual do ICM do item da nota fiscal de entrada Valor do desconto referente zona franca Valor base IPI Valor do IPI do item da nota fiscal de entrada Valor base IPI presumido (50% compra no comrcio) Valor do IPI presumido (50% compra no comrcio) Valor base do ICMS Valor do ICMS do item da nota fiscal de entrada Valor da diferena de alquota inter-estadual Valor base ICMS substitudo Valor do ICMS substitudo do item da nota fiscal de entrada Valor base ICMS substitudo destacado Valor ICMS substitudo destacado Valor isentas IPI Valor isentas ICMS Valor outras IPI Valor outros ICMS Valor base do PIS a recuperar Valor do PIS a recuperar do item da nota fiscal de entrada Cdigo da filial do contrato de compra Nmero do contrato que gerou a nota fiscal de entrada Valor base do Cofins a recuperar Valor do Cofins a recuperar Valor base do Cofins Retido Valor do Cofins Retido Percentual de Cofins Retido Valor base do PIS Retido Soma dos valores do PIS retido Percentual de PIS Retido Valor base do CSLL Retido Valor do CSLL Retido Percentual de CSLL Retido Valor base de Outras Retenes Valor de Outras Retenes Percentual de Outras Retenes Valor de reteno de ICMS Substituto Percentual de desconto 1

PerDs2 PerDs3 PerDs4 PerDs5 VlrDs3 VlrDs4 VlrDs5 BecIpi VecIpi BecIcm VecIcm VlrBie VlrIem VlrOui BcoImp CofImp BpiImp PisImp SeqIsp VlrBpf PerPif VlrPif VlrBcf PerCff VlrCff IgnOcp RecNot DatParSid Retorno: <SeqIsc>

Percentual de desconto 2 Percentual de desconto 3 Percentual de desconto 4 Percentual de desconto 5 Valor do desconto 3 Valor de desconto 4 Valor de desconto 5 Valor base de IPI creditado efetivamente Valor de IPI creditado efetivamente Valor base de ICMS creditado efetivamente Valor ICMS Cred. Efetivamente Valor base do INSS parte empresa Valor do INSS parte empresa Valor de outras despesas de importao Valor base do cofins a recuperar na importao Valor do cofins a recuperar na importao Valor base do pis a recuperar na importao Valor do pis a recuperar na importao Sequncia do item de servio no pedido de venda Valor Base do PIS Faturamento Percentual do PIS Faturamento Valor do PIS Faturamento Valor Base do COFINS Faturamento Percentual do COFINS Faturamento Valor do COFINS Faturamento Ignora a carga de dados da OCP, se informada (0=no*, 1=sim). *Padro Indica se deve executar o reclculo de valores dos itens (0=no, 1=sim*). *Padro Indica se deve gerar as parcelas pela data de emisso (0=no, 1=sim*). *Padro Seqncia do item gerado

Observao: Esta ao aceita campos de usurio.

2.4.17

GRAVAR PARCELAS MANUAIS NA NOTA FISCAL DE COMPRA

Ao: SID.Nfc.GravarParcelasManuais (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada VlrPar(n)1 Valor da parcela da nota fiscal de entrada VctPar(n)1 Data de vencimento da parcela da nota fiscal de entrada NumTit(n)1 Nmero do ttulo a ser gerado no conta a pagar Parmetros opcionais: CodTpt(n)1 Cdigo do tipo do ttulo a ser gerado no conta a pagar DatParSid Indica se deve gerar as parcelas pela data de emisso (0=no, 1=sim*). *Padro Retorno: "OK"
1 O ndice (n) indica o nmero da parcela ao qual o parmetro se referencia. Este ndice deve iniciar em 1 e, para cada nova parcela, ser incrementado em 1.

Observaes:

Na execuo desta ao so eliminadas todas as parcelas j definidas, manualmente ou no, para a nota fiscal de entrada sendo referenciada. A soma do valor financeiro das parcelas deve ser igual ao valor financeiro da nota fiscal de entrada, caso contrrio as parcelas no sero gravadas. Esta ao deve ser executada aps a incluso de todos os itens de produto e servio da nota fiscal de entrada, se aps a chamada desta ao for includo mais algum item de produto ou servio as parcelas sero recalculadas conforme parametrizao do sistema.

2.4.18

FECHAR NOTA FISCAL COMPRA

Ao: SID.Nfc.Fechar (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada

GerNfe

Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim)

Parmetros opcionais: RecNot Indicativo para recalcular nota (0=no*, 1=sim) Observaes: * Valor Padro Retorno: "OK"

2.4.19

CANCELAR NOTA FISCAL COMPRA

Ao: SID.Nfc.Cancelar (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada GerNfe Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim) Observaes: * Valor Padro Retorno: "OK"

2.4.20

GERAR NOTA FISCAL VIA ORDEM DE COMPRA

Ao: SID.Nfc.GerarNFCOrdemCompra (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumOcp Nmero da(s) ordem(ns) de compra (separado por vrgula, ex: 101,102,103,...) DatEnt Data de entrada da NF DatEmi Data de emisso da NF Retorno: "OK"

2.4.21

GRAVAR RATEIO PARA ITEM DE PRODUTO

Ao: SID.Nfc.GravarRateioProduto (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada SeqIpc Seqncia do item de produto da nota fiscal de entrada CtaFin(n)* Conta financeira reduzida** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custos PerCta(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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto Parmetros opcionais: ObsRat(n)* Observao do rateio Retorno: "OK" Observaes:
* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

2.4.22

GRAVAR RATEIO PARA ITEM DE SERVIO

Ao: SID.Nfc.GravarRateioServico (SRNF) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada SeqIsc Seqncia do item de servio da nota fiscal de entrada CtaFin(n)* Conta financeira reduzida** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custos PerCta(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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto Parmetros opcionais: ObsRat(n)* Observao do rateio Retorno: "OK" Observaes:
* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

2.5
2.4.23

SUPRIMENTOS ORDEM DE COMPRA

GRAVAR CABEALHO ORDEM DE COMPRA

Ao: SID.Ocp.Gravar (SCOC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da ordem de compra CodCpg Cdigo da condio de pagamento Parmetros opcionais: NumOcp Nmero da ordem de compra TnsPro Cdigo da transao para produtos TnsSer Cdigo da transao para servios CodTra Cdigo da transportadora para a ordem de compra VlrFre Valor do frete para a ordem de compra VlrSeg Valor do seguro para a ordem de compra VlrEmb Valor das embalagens para a ordem de compra VlrEnc Valor dos encargos para a ordem de compra VlrOut Valor das outras despesas para a ordem de compra VlrDar Valor dos descontos para arredondamento do total da ordem de compra VlrFrd Valor frete destacado VlrOud Valor outras despesas destacado VlrDs1 Valor de desconto 1 VlrDs2 Valor do desconto 2 VlrDs3 Valor de desconto 3 VlrDs4 Valor de desconto 4 VlrDzf Valor do desconto referente zona franca VlrBfu Valor base do funrural VlrFun Valor do funrural VlrBsp Valor base da substituio tributrio do PIS VlrStp Valor da substituio tributrio do PIS VlrBsc Valor base da substituio tributrio da COFINS VlrStc Valor da substituio tributrio da COFINS VlrBin Valor base do INSS VlrIns Valor do INSS VlrLpr Valor lquido dos itens de produtos da ordem de compra VlrLse Valor lquido dos itens de servios da ordem de compra VlrLou Valor lquido dos valores diversos da ordem de compra VlrLiq Valor lquido da ordem de compra VlrFin Valor lquido da ordem de compra para o financeiro ObsOcp Observao da ordem de compra TemPar Indicativo se a OC tem parcelas especiais na tabela E420PAR

SalCan Retorno: <NumOcp>

Indicativo se o saldo da ordem de compra dever ser cancelado Nmero da ordem de compra

Observao: Esta ao aceita campos de usurio

2.4.24

EXCLUIR ORDEM DE COMPRA

Ao: SID.Ocp.Excluir (SCOC) Parmetros obrigatrios: NumOcp Nmero da ordem de compra Retorno: "OK"

2.4.25

GRAVAR ITEM DE PRODUTO NA ORDEM DE COMPRA

Ao: SID.Ocp.GravarProduto (SCOC) Parmetros obrigatrios: NumOcp Nmero da ordem de compra CodPro Cdigo do produto da ordem de compra CodDer Cdigo da derivao do produto da ordem de compra QtdPed Quantidade do produto da ordem de compra Parmetros opcionais: SeqIpo Seqncia do item de produto na ordem de compra TnsPro Transao do item de produto da OC CplIpo Complemento da descrio do produto UniFor Unidade de medida do produto no fornecedor CodDep Cdigo do depsito para estoque do produto da ordem de compra QtdPed Quantidade do produto da ordem de compra UniMed Unidade de medida do produto comprado CodTpr Cdigo da tabela de preo do produto PreUni Preo unitrio do produto da ordem de compra PreFix Indicativo se o preo fixo ou no PerDsc Percentual de desconto para o produto da ordem de compra PerIpi Percentual de IPI do produto da ordem de compra PerIcm Percentual de ICM do produto da ordem de compra PerFun Percentual do funrural CtaFin Conta financeira reduzida CtaRed Conta contbil reduzida CodCcu Cdigo do centro de custo CodMoe Cdigo da moeda que o item da ordem de compra est representado DatMoe Data da cotao da moeda ou ndice do item da ordem de compra CotMoe Valor da cotao da moeda ou ndice do item da ordem de compra FecMoe Indicativo de o valor da cotao fechado Retorno: <SeqIpo> Seqncia do item de produto na ordem de compra

Observao: Esta ao aceita campos de usurio

2.4.26

GRAVAR ITEM DE SERVIO NA ORDEM DE COMPRA

Ao: SID.Ocp.GravarServico (SCOC) Parmetros obrigatrios: NumOcp Nmero da ordem de compra CodSer Cdigo do servio na ordem de compra QtdPed Quantidade pedida do servio na ordem de compra Parmetros opcionais: SeqIso Seqncia do item de servio na ordem de compra TnsSer Transao de servio do item da OC CplIso Complemento da descrio do servio CodTri Cdigo de tributao para emisso da DARF QtdPed Quantidade pedida do servio da ordem de compra UniMed Unidade de medida do servio da ordem de compra

PreUni PerDsc PerIss PerIrf PerIns CtaFin CtaRed CodCcu CodMoe DatMoe CotMoe FecMoe Retorno: <SeqIso>

Preo unitrio do servio da ordem de compra Percentual de desconto do servio da ordem de compra Percentual do ISS do servio da ordem de compra Percentual do IRRF do servio da ordem de compra Percentual do INSS Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Cdigo da moeda que o item da ordem de compra est representado Data da cotao da moeda ou ndice do item da ordem de compra Valor da cotao da moeda ou ndice do item da ordem de compra Indicativo de o valor da cotao fechado Seqncia do item de servio na ordem de compra

Observao: Esta ao aceita campos de usurio

2.4.27

FECHAR ORDEM DE COMPRA

Ao: SID.Ocp.Fechar (SCOC) Parmetros obrigatrios: NumOcp Nmero da ordem de compra Retorno: "OK" Observaes: Para que seja possvel fechar uma ordem de compra necessrio que a mesma esteja aprovada em todos os nveis, ou no tenha controle de aprovao multi-nvel.

2.4.28

GERAR ORDEM DE COMPRA VIA COTAO

Ao: SID.Ocp.GerarOCPCotacao (SCOC) Parmetros obrigatrios: NumCot(n)* Nmero da cotao Parmetros opcionais: SeqCot(n)* Seqncia(s) da cotao (separadas por vrgula, ex.: "101,102,103") TnsPro Transao de produto TnsSer Transao de servio Observaes: Retorno: "OK"
* (n) = ndice incremental, iniciado em 1. No utilizar os parnteses.

2.5 SUPRIMENTOS ESTOQUES

2.5.1 GERAR REQUISIO
Ao: SID.Est.Requisitar (SERE) Parmetros obrigatrios: CodPro Cdigo do produto movimentado CodDer Cdigo da derivao do produto movimentado QtdEme Quantidade do documento de movimento de estoque Parmetros opcionais: NumEme Nmero do documento de entrada do movimento de estoque SeqEme Seqncia do produto ou servio no documento CodTns Cdigo da transao de movimentao de estoque CplPro Complemento da descrio do produto ou servio UniMed Unidade de medida CodAge Cdigo de agrupamento para o estoque CodAgc Cdigo de agrupamento para compras DatPrv Data de previso de entrega do produto ou servio CtaFin Conta financeira reduzida

CtaRed QtdApr UsuAtd UsuSol UsuRes CcuRes UsuRec ObsEme ResEst1 CodDep SitEme ProSer2 NumDoc

Conta contbil reduzida Quantidade aprovado do movimento de estoque Usurio atendente do movimento de estoque Usurio responsvel pela solicitao do movimento Usurio responsvel pela aplicao do produto ou servio movimentado Centro de custo responsvel pela aplicao do produto ou servio Usurio recebedor do produto ou servio solicitado Observao da solicitao de movimento de estoque Indicativo se o estoque do produto da requisio deve ser reservado(S=sim, N=no) Cdigo do depsito para reserva Situao da movimentao de estoque Indicativo se a requisio de servio (S=Servio) Nmero de documento da requisio

Observao: 1 Quando for solicitada a Reserva de Estoque, obrigatrio que seja informado o Cdigo do Depsito. 2 O parmetro obrigatrio no caso de ser uma requisio de servio, caso seja uma requisio de produto este no precisa ser informado. Retorno: <NumEme/SeqEme> Nmero e seqncia da requisio gerada

2.5.2 ATENDER REQUISIO

Ao: SID.Est.AtenderRequisicao (SERE) Parmetros obrigatrios: NumEme Nmero do documento de entrada do movimento de estoque SeqEme Seqncia do produto ou servio no documento QtdAtd Quantidade atendida do movimento de estoque Parmetros opcionais: CodDep Cdigo do depsito movimentado CtaFin Conta financeira reduzida CtaRed Conta contbil reduzida CcuRes Centro de custo responsvel pela aplicao do produto ou servio DatMov Data da movimentao do estoque CodLot Cdigo do lote de fabricao para estocagem NumSep Cdigo da srie do produto Observao: 1. No processo de atendimento de requisio via Sid, no existe a possibilidade de gerar solicitao de compras automtica. 2. Caso no seja informada quantidade atendida (QtdAtd=0), a requisio ser cancelada com a quantidade aprovada. Retorno: "OK"

2.5.3 EXCLUIR REQUISIO

Ao: SID.Est.ExcluirRequisicao (SERE) Parmetros obrigatrios: NumEme Nmero do documento de entrada do movimento de estoque SeqEme Seqncia do produto ou servio no documento Retorno: "OK"

2.5.4 GRAVAR RATEIO REQUISIO

Ao: SID.Est.GravarRateioRequisicao (SERE) Parmetros obrigatrios: NumEme Nmero do documento de entrada do movimento de estoque SeqEme Seqncia do produto ou servio no documento Ctafin(n)* Conta financeira* CtaRed(n)* Conta contbil reduzida** PerCta(n)* Percentual do rateio da conta*** VlrCta(n)* Valor do rateio da conta*** CodCcu(n)* Cdigo do centro de custo VlrRat(n)* Valor do rateio***

PerRat(n)* NumPrj(n)* CodFpj(n)*

Percentual do rateio*** Nmero do projeto Cdigo da fase do projeto

Parmetros opcionais: ObsRat(n)* Observao do rateio Observaes:

* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

Retorno: "OK"

2.5.5 MOVIMENTAR ESTOQUE

Ao: SID.Est.Movimentar (SECE) Parmetros obrigatrios: CodPro Cdigo do produto movimentado CodDer Cdigo da derivao do produto movimentado CodTns Cdigo da transao de movimento do estoque CodDep Cdigo do depsito movimentado QtdMov Quantidade do movimento VlrMov* Valor do movimento *(obrigatrio quando a transao exigir) Parmetros opcionais: DatMov Data da movimentao do estoque ProTrf Cdigo do produto transferido (para movimentos de transferncia) DerTrf Cdigo da derivao do produto transferido (p/ movimentos de transferncia) DepTrf Cdigo do depsito transferido (para movimentos de transferncia) CodCli Cdigo do cliente para os movimentos consignados CodFor Cdigo do forencedor para os movimentos consignados NumDoc Nmero de documento base da movimentao CodLot Cdigo do lote de fabricao para estocagem CodCcu Cdigo do centro de custo do usurio responsvel DatVlt Data de validade do produto no depsito CtaRed Cdigo da conta contbil reduzida NumSep Cdigo da srie do produto Retorno: <SeqMov> Seqncia do movimento

Observao: Esta ao aceita campos de usurio.

2.5.6 EXCLUIR MOVIMENTO DE ESTOQUE

Ao: SID.Est.ExcluirMovimento (SECE) Parmetros obrigatrios: CodPro Cdigo do produto movimentado CodDer Cdigo da derivao do produto movimentado CodDep Cdigo do depsito movimentado DatMov Data da movimentao do estoque SeqMov Seqncia do movimento Retorno: "OK"

2.5.7 LISTAR ITENS DA EMBALAGEM

Ao: SID.Est.ListarItensEmbalagem (SECE) Parmetros obrigatrios: CodEmp Cdigo da empresa NumEmb Nmero da embalagem Retorno: Xml contendo os itens da embalagem, conforme exemplo: <?xml version="1.0"?>

<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 CONFERNCIA DA EMBALAGEM

Ao: SID.Est.ConfirmarConferEmb (SECE) Parmetros obrigatrios: CodEmp Cdigo da empresa NumEmb Nmero da embalagem Retorno: "OK"

2.5.9 GRAVAR SOLICITAO DE COMPRA (INCLUIR/ALTERAR)

Ao: SID.Est.GravarSolCompra (SCSC) Parmetros obrigatrios: CodPro1 Cdigo do produto movimentado CodDer1 Cdigo da derivao do produto movimentado CodSer2 Cdigo do Servio QtdSol Quantidade para solicitao de compras DatPrv2 Data previso para entrega do servio
1 Pode-se no informar o campo CodPro, e conseqentemente o campo CodDer. Neste caso os campos CplPro, UniMed e PreSol tornam-se obrigatrios. 2 Os campos CodSer e DatPrv so obrigatrios no caso de ser uma solicitao de servio, caso seja uma solicitao de produto estes no devem ser informados.

Parmetros opcionais: NumSol Nmero do documento da solicitao SeqSol Seqncia do item na solicitao de compra CplPro Complemento da descrio do produto CodTns Cdigo da transao da solicitao de compras UniMed3 Unidade de medida PreSol3 Preo da solicitao CodDep4 Cdigo do depsito movimentado DatPrv Data prevista de entrega do produto CtaFin Conta financeira reduzida CtaRed Conta contbil reduzida UsuSol Usurio responsvel pela solicitao do produto UsuRes Usurio responsvel pela aplicao do produto solicitado CcuRes Centro de custo responsvel pela aplicao do produto CodBem Cdigo do bem SolInt Cdigo da solicitao no sistema integrado ObsSol Observao da solicitao de compra CtaFin(n)5 6 Conta financeira CtaRed(n) 5 6 Conta contbil reduzida CodCcu(n) 5 Cdigo do centro de custo PerCta(n) 5 7 Percentual do rateio da conta VlrCta(n) 5 7 Valor do rateio da conta PerRat(n) 5 7 Percentual do rateio VlrRat(n) 5 7 Valor do rateio NumPrj(n) 5 Nmero interno do projeto CodFpj(n) 5 Cdigo da fase do projeto ObsRat(n) 5 Observao do rateio

Os campos UniMed e PreSol somente sero considerados se no for informado o campo CodPro. O campo CodDep s ser considerado se for informado o campo CodPro. 5 Campos para informao do rateio, onde: * (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. 6 Depende da parametrizao. 7 Informar apenas o percentual ou apenas o valor.
3 4

Retorno: "OK"

2.5.10

EXCLUIR SOLICITAO DE COMPRA

Ao: SID.Est.ExcluirSolCompra (SCSC) Parmetros obrigatrios: NumSol Nmero do documento da solicitao SeqSol Seqncia do item na solicitao de compra Retorno: "OK"

2.5.11

BUSCAR ESTOQUE DISPONVEL

Ao: SID.Est.BuscarEstoqueDisp (SECE) Parmetros obrigatrios: CodPro Cdigo do produto CodDer Cdigo da derivao do produto (quando existir) CodDep Cdigo do depsito Parmetros opcionais: ConPed1 Consulta estoque disponvel em rotinas de pedido ("S"-Sim ou "N"-No) CriFed Critrio para formao do estoque (atendimento faturamento/baixas estoque em geral) Observao: 1 O clculo do estoque disponvel com o identificador de regra (VEN-120DISPO01) somente ser acessado quando o campo "ConPed" for igual a "S" e o identificador estiver ativo. Caso contrrio, ser calculado conforme o critrio para formao do estoque informado no cadastro da filial. Maiores detalhes sobre a funcionalidade do identificador VEN-120DISPO01 podem ser acessados na documentao do Sapiens. Retorno: <QtdDis> Quantidade disponvel em estoque

2.5.12

BUSCAR PREO MDIO

Ao: SID.Est.BuscarPrecoMedio (SECE) Parmetros obrigatrios: CodPro(n)* Cdigo do produto CodDer(n)* Cdigo da derivao do produto (quando existir)
* (n) = Seqncia incremental dos produtos, iniciando sempre em 1 (um) No utilizar os parnteses.

Retorno: Xml contendo o cdigo do produto, derivao e preo mdio, 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

Ao SID.EST. BUSCARESTOQUEGRADE (SECE) Permite buscar a consulta de estoque em grade, por embalagem avulso ou ambos. O resultado o mesmo da tela do Comercial\Estoques\Consultas\Posio dos Estoques\Embalagem/Grade

Parmetros obrigatrios: CodFxa Cdigo da faixa de grades Parmetros opcionais: CodClc Filtro de colees do produto (abrangncia) CodMod Filtro de modelo de produo do produto (abrangncia) CodFam Filtro de famlia do produto (abrangncia) CodPro Filtro de produto (abrangncia) CodDep Filtro por depsito (abrangncia) CodPgr Proporcionalidade (sem abrangncia) CodMar Filtro da marca de produto (abrangncia) CodAge Filtro por cdigo de agrupamento de estoque (abrangncia) CodEmb Filtro por tipo de embalagem (sem abrangncia) ModCon Modo de consulta: 0 Ambos; 1 Embalagens; 2 Avulsos TipAgp Agrupa ou no depsitos: 0 no agrupa; 1 agrupa depsitos 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 descrio de cada delimitador e sua funcionalidade est a seguir <produtos></produto> Delimitadores onde esto internamente todos os produtos lidos da consulta <linha></linha> Delimitadores onde existe um para cada conjunto produto/embalagem/depsito/faixa/proporcionalidade retornado da consulta. O que est delimitado dentro de uma linha so todos os campos e valores a seguir: <numlin></numlim> Dentro desses delimitadores est apenas como informativo o nmero de cada linha da consulta <codmod></codmod> Dentro desses delimitadores est o cdigo do modelo do produto <codpro></codpro> Dentro desses delimitadores est o cdigo do produto <despro></despro> Dentro desses delimitadores est a descrio do produto, formada pela descrio e complemento do cadastro do produto <qtdemb></qtdemb> Dentro desses delimitadores est a quantidade de embalagens, se no estiver exibindo o estoque avulso do produto (sem embalagens) <derivacoes></derivacoes>

Dentro desses delimitadores esto aninhadas as derivaes do produto, com sua quantidade em estoque, estando esses campos 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 cdigo da derivao do produto <qtdder></qtddder> Dentro desses delimitadores est a quantidade da derivao 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 derivaes da linha de produto. <codemb></codemb> Dentro desses delimitadores est o cdigo da embalagem do produto. Se for uma linha de estoque avulso, no h valor nesse delimitador. <coddep></coddep> Dentro desses delimitadores est o cdigo da depsito consultado do produto. Se a consulta agrupar depsitos, com o parmetro TIPAGP = 1, o mesmo no apresenta valor. <codclc></codclc> Dentro desses delimitadores est o cdigo da coleo do produto. <codage></codage> Dentro desses delimitadores est o cdigo de agrupamento de estoque do produto <codpgr></codpgr> Dentro desses delimitadores est o cdigo da proporcionalidade da embalagem do produto. Se a linha estiver exibindo estoque avulso, no h valor neste delimitador. <codfxa></codfxa> Dentro desses delimitadores est o cdigo da faixa consultada do produto. <codmar></codmar> Dentro desses delimitadores est o cdigo da marca do produto. <codfam></codfam> Dentro desses delimitadores est o cdigo da famlia do produto.

2.5.14

ESTOQUE PAF/ECF (VAREJO)

Ao SID.EST.PAFECFESTOQUEVAREJO (IVME) Gera o arquivo eletrnico de estoque conforme especificado no ATO COTEPE ICMS 14/11 - ANEXO IV. Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial TipEst Tipo do saldo de estoque (0 - Total; 1 - Parcial) ArqLoc Caminho e nome do arquivo onde ser gerado o arquivo eletrnico do estoque. Ex.: C:\Estoque.txt Parmetros opcionais: DatEst Data do saldo do estoque. Se a data no for informada ou for maior ou igual a data atual, ser processada a data do saldo do dia anterior ao atual (ontem). CodPdv[x] Cdigo do produto no PDV. Utilizado apenas para saldo de estoque parcial. Ex.: CodPdv1=1101 CodPdv2=2202 CodPdv3=3303 Retorno: "OK" Observao: Caso o campo TipEst for informado como 1, ser obrigatrio que pelo menos um CodPdv seja informado.

2.6 MERCADO NOTA FISCAL TRANSFERNCIA

2.6.1 MARCAR EMBALAGEM/PRODUTO PARA TRANSFERNCIA
Ao: SID.Nft.MarcarEPT (RFNF)

Parmetros obrigatrios: FilOri Cdigo da filial de origem FilDes Cdigo da filial de destino PlaVei Placa do veculo NumEmb 1 Nmero da embalagem CodPro 1 Cdigo do produto CodDer 1 Cdigo da derivao do produto CodBar 1 Cdigo de barras do produto QtdPro 2 Quantidade do produto Observao: 1 Deve ser informado o campo NumEmb, ou o campo CodBar, ou os campos CodPro e CodDer, sendo usado o primeiro, na ordem em que esto listados, que contenha um valor. 2 O campo QtdPro desconsiderado caso seja informado NumEmb, assumindo automaticamente valor 1. Parmetros opcionais: EmpOri Cdigo da empresa de origem EmpDes Cdigo da empresa de destino Retorno: "OK"

2.6.2 BUSCAR ITENS DA NOTA FISCAL DE TRANSFERNCIA

Ao: SID.Nft.BuscarItensNFT (RFNF) Parmetros obrigatrios: FilOri Cdigo da filial de origem FilDes Cdigo da filial de destino CodSnf Srie da nota fiscal NumNfv Nmero da nota fiscal Parmetros opcionais: EmpOri Cdigo da empresa de origem EmpDes Cdigo da empresa de destino Retorno: XML contendo os itens da nota fiscal de transferncia, 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 CONFERNCIA DOS ITENS DA NFT

Ao: SID.Nft.ConfirmarConferencia (RFNF) Parmetros obrigatrios: FilOri Cdigo da filial de origem FilDes Cdigo da filial de destino CodSnf Srie da nota fiscal

NumNfv CodDep

Nmero da nota fiscal Cdigo do depsito

Parmetros opcionais: EmpOri Cdigo da empresa de origem EmpDes Cdigo da empresa de destino SnfNfc Srie da nota fiscal de entrada (gerada no processo) Retorno: "OK"

2.7 MERCADO PR-FATURAS

2.7.1 CRIAR EMBALAGEM PARA PR-FATURA
Ao: SID.Pfa.CriarEmbalagem (RFEX) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial NumAne Nmero da anlise de embarque NumPfa Nmero da pr-fatura CodEmb Cdigo da embalagem NumEmb Nmeros das embalagens Parmetros opcionais: QtdEmb Quantidade de embalagens NumNiv Nvel da Embalagem VolOcu Volume j ocupado da embalagem PesBru Peso bruto das embalagens e produtos PesLiq Peso lquido dos produtos ObsEmb Texto da observao das embalagens Retorno: <SeqEmb> Seqncia da Embalagem Criada

2.7.2 INCLUIR OS CONTEDOS DAS EMBALAGEM DA PR-FATURA

Ao: SID.Pfa.IncluirConteudoEmb (RFEX) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial NumAne Nmero da anlise de embarque NumPfa Nmero da pr-fatura SeqEmb Seqncia de embalagem NumSep1 Nmero de Srie CodBar1 Cdigo de Barras CodPro1 Cdigo do Produto CodDer1 Cdigo de Derivao Parmetros opcionais: QtdPro2 Quantidade do produto na embalagem VolIpd Volume calculado do produto PesBru Peso bruto do produto PesLiq Peso lquido do produto ObsPro Texto da observao do produto na embalagem Observao: 1. Estes campos definem o que ser includo no contedo, ser for informado um nmero de srie o sistema ir procurar por este nmero, se for informado o cdigo de barras o sistema ir procurar o cdigo EAN e se no achar pelo cdigo de barras livre do produto e se for informado produto/derivao ser procurado este produto especfico. 2. Sempre que no for informado o campo QTDPRO o default ser 1(um) no caso da srie este campo ignorado e sempre assumido 1(um) Retorno: "OK"

2.7.3 EXCLUIR EMBALAGEM DA PR-FATURA

Ao: SID.Pfa.ExcluirEmbalagem (RFEX)

Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial NumAne Nmero da anlise de embarque NumPfa Nmero da pr-fatura SeqEmb1 Seqncia de embalagem NumEmb1 Nmeros das embalagens Observao: 1. Se for informado SeqEmb no e necessrio informar NumEmb e vice-versa. Retorno: "OK"

2.8 CADASTROS CLIENTES

2.8.1 GRAVAR CLIENTE (INCLUIR/ALTERAR)
Ao: SID.Cli.Gravar Parmetros obrigatrios: NomCli Nome do cliente ApeCli Nome fantasia do cliente SigUfs Sigla do estado do cliente CodCli Cdigo do cliente (obrig. p/alterao) CgcCpf Nmero do CNPJ ou CPF do cliente EndCli Endereo do cliente (rua, n., etc.) Parmetros opcionais: CodCli Cdigo do cliente MarCli Marca do cliente SenCli Senha do cliente NenCli Nmero do endereo do cliente TipCli Tipo do cliente (Padro=F) TipMer Tipo de mercado do cliente (Padro=I) TipEmc Tipo Empresa do cliente para gerao de ttulo de COFINS CliCon Indicativo se o cliente contribuinte de ICMS (Padro=N) CodRam Cdigo do ramo de atividade do cliente InsEst Inscrio estadual do cliente InsMun Inscrio municipal do cliente CodGre Cdigo do grupo de empresas ZonFra Indicativo de qual o benefcio fiscal do cliente CodSuf Nmero do cliente junto Suframa DatSuf Data de validade do registro do SUFRAMA CplEnd Complemento do endereo do cliente (sala, andar, etc.) CliPrx Ponto de referncia ou proximidade do cliente ZipCod Cdigo da cidade do cliente externo - ZIP CODE EenCli Cdigo do endereo do cliente CepCli CEP do cliente CepIni Faixa inicial do CEP da cidade do cliente BaiCli Bairro do cliente CidCli Cidade do cliente CodPai Cdigo do pas do cliente TemEnt Indicativo se o cliente tem endereos de entrega diferentes (Padro=N) EndEnt Endereo de entrega do cliente NenEnt Nmero do endereo de entrega CplEnt Complemento do endereo de entrega do cliente EenEnt Cdigo do endereo de entrega do cliente CepEnt CEP do endereo de entrega do cliente IniEnt Faixa inicial do CEP do endereo de entrega do cliente CidEnt Cidade do endereo de entrega do cliente EstEnt Estado do endereo de entrega do cliente InsEnt Inscrio estadual do endereo de entrega CgcEnt Nmero do CNPJ de Entrega BaiEnt Bairro de Entrega do cliente TemCob Indicativo se o cliente tem endereos de cobrana diferentes (Padro=N) EndCob Endereo de cobrana do cliente NenCob Nmero do endereo de cobrana CplCob Complemento do endereo de cobrana do cliente EenCob Cdigo do endereo de cobrana do cliente CepCob CEP do endereo de cobrana do cliente IniCob Faixa inicial do CEP do endereo de cobrana do cliente

CidCob EstCob CgcCob EntCor BaiCob FonCli FonCl2 FonCl3 FaxCli CxaPst IntNet CodFor CliRep CliTra SitCli CodMot BloCre ObsMot TriIcm TriIpi TriPis TriCof CodPdv IdeCli Retorno: <CodCli>

Cidade do endereo de cobrana do cliente Estado do endereo de cobrana do cliente Nmero do CNPJ de cobrana Indicativo do endereo de entrega de correspondncias Bairro de Cobrana do cliente Nmero do telefone - 1 Nmero do telefone - 2 Nmero do telefone - 3 Nmero do FAX do cliente Nmero da caixa postal do cliente Endereo eletrnico (E-Mail) Cdigo do cliente como fornecedor Cdigo do cliente como representante Cdigo do cliente como transportadora Situao do cliente (Padro=A) Cdigo do motivo da situao do cliente Indicativo se o motivo bloqueia crdito para o cliente (Faturamento) (Padro=N) Observao do motivo da situao do cliente Tributa ICMS (S/N) (Padro=S) Tributa IPI (S/N) (Padro=S) Tributa PIS (S/N) (Padro=S) Tributa COFINS (S/N) (Padro=S) Cdigo do cliente no PDV Cdigo de identificao do cliente Cdigo do cliente gerado

Observao: Esta ao aceita campos de usurio.

2.8.2 GRAVAR DEFINIES DO CLIENTE (INCLUIR/ALTERAR)

Ao: SID.Cli.GravarDefinicoes Parmetros obrigatrios: CodCli Cdigo do cliente CodRep Cdigo do representante padro para o cliente CodCpg Cdigo da condio de pagamento padro para o cliente Parmetros opcionais: SalDup Saldo devedor de duplicatas dos clientes SalOut Saldo devedor de outros ttulos dos clientes SalCre Saldo dos adiantamentos dos clientes DatLim Data da ltima atualizao do limite de crdito do cliente VlrLim Valor do limite de crdito do cliente LimApr Indicativo se o limite de crdito do cliente est ou no aprovado (Padro=N) VlrPfa Soma das pr-faturas DatMac Data da ocorrncia do maior acmulo de saldo devedor do cliente VlrMac Valor do maior acmulo de saldo devedor do cliente DatUpe Data do ltimo pedido do cliente VlrUpe Valor do ltimo pedido do cliente DatUfa Data do ltimo faturamento do cliente VlrUfa Valor do ltimo faturamento do cliente DatUpg Data do ltimo pagamento do cliente VlrUpg Valor do ltimo pagamento do cliente QtdPgt Quantidade total de pagamentos efetuados pelo cliente DatUpc Data do ltimo pagamento em cartrio do cliente VlrUpc Valor do ltimo pagamento em cartrio do cliente QtdTpc Quantidade total de pagamentos em cartrio do cliente DatMfa Data da ocorrncia da maior fatura do cliente VlrMfa Valor da maior fatura do cliente DatAtr Data da ocorrncia do maior atraso do cliente VlrAtr Valor de pagamento do maior atraso do cliente MaiAtr Quantidade de dias do maior atraso do cliente MedAtr Quantidade de dias de mdia de atraso do cliente AcePar Indicativo se o cliente aceita faturamento parcial de pedidos (Padro=S) QtdMfp Quantidade mxima de faturas por pedido aceito pelo cliente PerDs1 Percentual de desconto - 1 para o cliente PerDs2 Percentual de desconto - 2 para o cliente PerCom Percentual de comisso nas vendas para o cliente (+ ou -) CodCrp Cdigo de grupo do contas a receber CodRve Cdigo da regio de venda do cliente CodTpr Cdigo da tabela de preo padro para o cliente CodFpg Cdigo da forma de pagamento CodTra Cdigo da transportadora padro para o cliente

CodRed RecJmm RecTjr RecDtj RecMul RecDtm PerDsc TolDsc PorSi1 PorSi2 CodCrt PorNa1 PorNa2 CodIn1 CodIn2 CodBan CodAge CcbCli CtaRed CtaRcr CtaFdv CtaFcr CriEdv FveTns FveFpg FveCpg CifFob Retorno: "OK"

Cdigo da transportadora de redespacho padro para o cliente Percentual de juros de mora ms para o contas a receber Tipo de juros para contas a receber (Padro=S) Dias de tolerncia para clculo de juros de mora Percentual de multa para atraso contas a receber Dias de tolerncia para multa do contas a receber Percentual padro de desconto para os ttulos gerados Quantidade padro de dias de tolerncia para desconto Cdigo do primeiro portador aceito pelo cliente Cdigo do segundo portador aceito pelo cliente Cdigo da carteira padro para o cliente Cdigo do primeiro portador no aceito pelo cliente Cdigo do segundo portador no aceito pelo cliente Cdigo da primeira instruo bancria Cdigo da segunda instruo bancria Cdigo do banco onde o cliente mantm conta corrente Cdigo da agncia bancria onde o cliente mantm conta corrente Nmero da conta corrente bancria do cliente Conta contbil reduzida - 1 Conta contbil reduzida - 2 Conta contbil reduzida - 3 Conta contbil reduzida 4 Critrio para escolha do dia de vencimento (A, S, N, U) Hierarquia de forma de venda transao Hierarquia de forma de venda forma de pagamento Hierarquia de forma de venda condio de pagamento Indicativo se o frete para o cliente CIF (C) ou FOB (F)

Observao: Esta ao aceita campos de usurio.

2.8.3 EXCLUIR CLIENTE

Ao: SID.Cli.Excluir Parmetros obrigatrios: CodCli Cdigo do cliente CodEmp Cdigo da empresa Retorno: "OK"

2.8.4 EXCLUIR DEFINIES DO CLIENTE

Ao: SID.Cli.ExcluirDefinicoes Parmetros obrigatrios: CodCli Cdigo do cliente Retorno: "OK"

2.8.5 GRAVAR DADOS PESSOA JURDICA (INCLUIR/ALTERAR)

Ao: SID.Cli.GravarPesJuridica Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: DatFdc Data de fundao da empresa NomSo1 Nome do scio 1 CpfSo1 CNPJ/CPF do scio 1 FunSo1 Funo do scio 1 NomSo2 Nome do scio 2 CpfSo2 CNPJ/CPF do scio 2 FunSo2 Funo do scio 2 NomSo3 Nome do scio 3 CpfSo3 CNPJ/CPF do scio 3 FunSo3 Funo do scio 3

QtdFun VlrFat AnoFat Retorno: "OK"

Quantidade de funcionrios Valor do faturamento anual em dlares (US$) Ano base do faturamento anual

Observao: Esta ao aceita campos de usurio.

2.8.6 EXCLUIR DADOS PESSOA JURDICA

Ao: SID.Cli.ExcluirPesJuridica Parmetros obrigatrios: CodCli Cdigo do cliente Retorno: "OK"

2.8.7 GRAVAR DADOS PESSOA FSICA (INCLUIR/ALTERAR)

Ao: SID.Cli.GravarPesFisica Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: EstCiv Estado civil do cliente RegCas Regime de casamento CodSex Cdigo do sexo DatNas Data do nascimento do cliente CidNat Nome da cidade de naturalidade CodPai Nome do pas de nacionalidade do cliente NroDep Quantidade de dependentes NumRge Nmero do RG (Identidade) OrgRge rgo emissor do RG DatRge Data de emisso do RG NumPte Nmero do passaporte DatEpt Data de emisso do passaporte DatVpt Data de vencimento do passaporte NomPai Nome do pai do cliente NomMae Nome da me do cliente EmpTra Nome da empresa onde trabalha TipOcu Tipo de ocupao TipTra Tipo da empresa onde trabalha o cliente AdmTra Data de admisso do cliente/scio EndTra Endereo da empresa onde trabalha o cliente BaiTra Bairro da empresa onde trabalha o cliente EenTra Cdigo do endereo da empresa onde trabalha o cliente CepTra CEP da empresa onde trabalha o cliente CidTra Cidade da empresa onde trabalha o cliente EstTra Estado da empresa onde trabalha o cliente FonTra Nmero do telefone da empresa onde trabalha o cliente RamTra Ramal do telefone onde trabalha o cliente CrtTra Dados da carteira profissional do cliente CarTra Cargo exercido na empresa pelo cliente SalTra Salrio do cliente na empresa onde trabalha OriOut Origem de outros rendimentos do cliente VlrOut Valor de outros rendimentos do cliente NomCng Nome do cnjuge NasCng Data de nascimento do cnjuge CpfCng Nmero do CPF do cnjuge RgeCng Nmero do RG do cnjuge OrgCng rgo emissor do RG do cnjuge DatCng Data de emisso do RG do cnjuge EmpCng Empresa onde trabalha o cnjuge AdmCng Data de admisso do cnjuge EndCng Endereo da empresa onde trabalha o cnjuge do cliente BaiCng Bairro onde trabalha o cnjuge do cliente EenCng Cdigo do endereo onde trabalha o cnjuge do cliente CepCng CEP onde trabalha o cnjuge do cliente CidCng Cidade onde trabalha o cnjuge do cliente

EstCng FonCng RamCng CrtCng CarCng SalCng TipMor TpoMor VlrAlu RefCm1 RefCm2 RefPe1 RefPe2 RefBc1 RefBc2 UltCpr UltFin DatSpc CidSpc InfSpc NomInv CarCre NumCre ValCre VctCre NomCre DepCre NasCre GraCre EmpAnt TemAnt FonAnt RamAnt ResAnt NomAva CpfAva EndAva EenAva CepAva CidAva EstAva FonAva Retorno: "OK"

Estado onde trabalha o cnjuge do cliente Nmero do telefone da empresa onde trabalha o cnjuge Ramal do fone onde trabalha o cnjuge do cliente Dados da carteira profissional do cnjuge Cargo exercido na empresa pelo cnjuge Salrio do cnjuge na empresa onde trabalha Tipo de moradia do cliente Ms e ano da mudana para a moradia atual (reside desde) Valor das despesas com moradia Referncia comercial - 1 Referncia comercial - 2 Referncia pessoal - 1 Referncia pessoal - 2 Referncia bancria - 1 Referncia bancria - 2 Nome da loja onde efetuou a ltima compra a crdito Nome do banco ou financeira onde j fez emprstimo Data da ltima consulta do SPC Cidades de pesquisa e de Intercmbio do SPC Informao levantada junto ao SPC Nome invertido do cliente Nome do carto de crdito que possui Nmero do carto de crdito Data de validade do carto de crdito Dia do vencimento do carto de crdito Nome do cliente no carto de crdito Nome do dependente no carto de crdito Data de Nascimento do dependente do carto de crdito Grau de parentesco do dependente do carto de crdito Nome da empresa anterior onde o cliente trabalhou Tempo de trabalho na empresa anterior (em anos) Nmero do telefone da empresa anterior Nmero do ramal do telefone da empresa anterior Residncia anterior do cliente Nome do avalista do cliente Nmero do CPF do avalista do cliente Endereo do avalista do cliente Cdigo do endereo do avalista do cliente CEP do avalista do cliente Nome da cidade do avalista do cliente Estado do avalista do cliente Nmero do telefone do avalista do cliente

Observao: Esta ao aceita campos de usurio.

2.8.8 EXCLUIR DADOS PESSOA FSICA

Ao: SID.Cli.ExcluirPesFisica Parmetros obrigatrios: CodCli Cdigo do cliente Retorno: "OK"

2.8.9 GRAVAR CONTATO DO CLIENTE (INCLUIR/ALTERAR)

Ao: SID.Cli.GravarContato Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: SeqCto Seqncia do contato NomCto Nome do contato DatNas Data de nascimento CodNiv Cdigo Nvel do contato SetCto Setor do contato CarCto Cargo do contato FonCto Telefone do contato - 1

RamCto FonCt2 RamCt2 FonCt3 RamCt3 FaxCto IntNet HobCon TimCon SitCto Retorno: <SeqCto>

Ramal do contato - 1 Telefone do contato - 2 Ramal do contato - 2 Telefone do contato - 3 Ramal do contato - 3 Fax do contato Endereo eletrnico (e-mail) Hobby do contato Time do contato Situao do registro de contato

Observao: Esta ao aceita campos de usurio.

2.8.10

EXCLUIR CONTATO DO CLIENTE

Ao: SID.Cli.ExcluirContato Parmetros obrigatrios: CodCli Cdigo do cliente SeqCto Seqncia do contato Retorno: "OK"

2.8.11

GRAVAR ENDEREO DE ENTREGA

Ao: SID.Cli.GravarEndEntrega Parmetros obrigatrios: CodCli Cdigo do cliente CepEnt CEP do endereo de entrega EndEnt Endereo de entrega Parmetros opcionais: SeqEnt Seqncia do endereo de entrega NomCli Nome do cliente de entrega EenEnt Cdigo do endereo de entrega do cliente NenEnt Nmero do endereo de entrega CplEnt Complemento do endereo de entrega BaiEnt Bairro do endereo de entrega CidEnt Cidade do endereo de entrega EstEnt Estado do endereo de entrega InsEnt Inscrio estadual do endereo CgcEnt Nmero do CNPJ/CPF de entrega PrxEnt Ponto de referncia ou proximidade do endereo de entrega CodRoe Cdigo da rota SeqRoe Seqncia da rota CodSro Cdigo da sub-rota SitReg Situao do endereo de entrega Retorno: <SeqEnt> Observao: Esta ao aceita campos de usurio.

2.8.12

EXCLUIR ENDEREO DE ENTREGA

Ao: SID.Cli.ExcluirEndEntrega Parmetros obrigatrios: CodCli Cdigo do cliente SeqEnt Seqncia do endereo de entrega Retorno: "OK"

2.8.13

GRAVAR ENDEREO DE COBRANA

Ao: SID.Cli.GravarEndCobranca Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: SeqCob Seqncia do endereo de cobrana EenCob Cdigo do endereo de cobrana do cliente CepCob CEP do endereo de cobrana EndCob Endereo de cobrana NenCob Nmero do endereo de cobrana CplCob Complemento do endereo de cobrana BaiCob Bairro do endereo de cobrana CidCob Cidade do endereo de cobrana EstCob Estado do endereo de cobrana CgcCob Nmero do CNPJ/CPF de cobrana SitReg Situao do endereo de cobrana Retorno: <SeqCob>

2.8.14

EXCLUIR ENDEREO DE COBRANA

Ao: SID.Cli.ExcluirEndCobranca Parmetros obrigatrios: CodCli Cdigo do cliente SeqCob Seqncia do endereo de cobrana Retorno: "OK"

2.9 CADASTROS REPRESENTANTES

2.9.1 GRAVAR REPRESENTANTE (INCLUIR/ALTERAR)
Ao: SID.Rep.Gravar Parmetros obrigatrios: CodRep Cdigo do representante NomRep Nome do representante ApeRep Nome fantasia do representante TipRep Tipo do representante EndRep Endereo do representante (rua, n, etc.) SitRep Situao do representante SigUfs Estado do representante GerTit Gera ttulo pag. comisso do representante (T - Ttulo, C - Cheque, O - Ordem Compra) EenRep Cdigo do endereo do representante InsEst Inscrio estadual do representante Parmetros opcionais: SenRep Senha do Representante InsMun Nmero da Inscrio Municipal CgcCpf Nmero do CNPJ ou CPF do representante CplEnd Complemento do endereo (sala, andar, etc.) ZipCod Cdigo da cidade do representante externo - ZIP CODE CepRep CEP do endereo do representante BaiRep Bairro do representante CidRep Cidade do representante FonRep Nmero do telefone - 1 FonRe2 Nmero do telefone - 2 FonRe3 Nmero do telefone - 3 FaxRep Nmero do FAX do representante CxaPst Nmero da caixa postal do representante IntNet Endereo eletrnico (E-Mail) DatCad Data do cadastramento do representante DatAtu Data da ltima alterao do representante

QtdDep CalIrf CalIss CalIns CodMot ObsMot UsuMot DatMot HorMot DatNas NumRge OrgRge DatRge RepCli RepFor CodCdi NenRep Retorno: <CodRep>

Quantidade de dependentes para imposto de renda Indicativo se o clculo de IRRF por empresa Indicativo se o clculo de ISS por empresa Indicativo se o clculo de INSS por empresa Cdigo do motivo da situao do representante Observao do motivo da situao do representante Usurio responsvel pelo motivo da situao do representante Data do motivo da situao do representante Hora do motivo da situao do representante Data do nascimento Nmero do RG rgo emissor do RG Data de emisso do RG Cdigo do representante como cliente Cdigo do representante como fornecedor Cdigo do canal de distribuio padro do representante Nmero do Endereo do Representante Cdigo do cliente gerado

Observao: Esta ao aceita campos de usurio.

2.9.2 GRAVAR DEFINIES DO REPRESENTANTE (INCLUIR/ALTERAR)

Ao: SID.Rep.GravarDefinicoes Parmetros obrigatrios: CodRep Cdigo do representante CodEmp Cdigo da empresa CodRve Cdigo da regio de venda do representante IpiCom Indicativo se o IPI est ou no na base de comisso IcmCom Indicativo se o ICMS est ou no na base de comisso SubCom Indicativo se o ICMS substitudo est ou no na base de comisso FreCom Indicativo se o frete est ou no na base de comisso SegCom Indicativo se o seguro est ou no na base de comisso EmbCom Indicativo se o valor das embalagens est ou no na base de comisso EncCom Indicativo se o valor dos encargos est ou no na base de comisso OutCom Indicativo se o valor das outras despesas est ou no na base de comisso DarCom Indicativo se o valor do arredondamento est ou no na base de comisso ComPri Indicativo se a comisso paga totalmente na primeira parcela CriRat Critrio utilizado para rateio ConEst Indicativo se o representante deve contar estoque do cliente CatRep Categoria do Representante CslCom Indicativo se a CSLL Retido est na base de comisso dos pedidos, pr-faturas e notas fiscais InsCom Indicativo se o INSS est na base de comisso dos pedidos, pr-faturas e notas fiscais IssCom Indicativo se o ISS est na base de comisso dos pedidos, pr-faturas e notas fiscais CofCom Indicativo se o COFINS Retido est na base de comisso dos pedidos, pr-faturas e notas fiscais PisCom Indicativo se o PIS Retido est na base de comisso dos pedidos, pr-faturas e notas fiscais IrfCom Indicativo se o IRRF est na base de comisso dos pedidos, pr-faturas e notas fiscais fiscais fiscais OurCom PifCom CffCom RecAdc RecAoc RecPcj RecPcm RecPcc RecPce RecPco Indicativo se as outras retenes esto na base de comisso dos pedidos, pr-faturas e notas Indicativo se o PIS Faturamento est na base de comisso dos pedidos, pr-faturas e notas fiscais Indicativo se o COFINS Faturamento est na base de comisso dos pedidos, pr-faturas e notas Indicativo Indicativo Indicativo Indicativo Indicativo Indicativo Indicativo se se se se se se se abate os descontos concedidos da comisso abate os outros descontos da comisso recebe comisso sobre juros cobrados recebe comisso sobre multas cobradas recebe comisso sobre a correo monetria recebe comisso sobre os encargos financeiros recebe comisso sobre outros acrscimos

Parmetros opcionais: PerCom Percentual de comisso padro para produtos do representante PerCos Percentual de comisso padro para servios do representante ComFat Percentual da comisso pago ao representante no faturamento ComRec Percentual da comisso pago ao representante no recebimento dos ttulos PerIrf Percentual do IRRF para o clculo das comisses PerIss Percentual do ISS para o clculo das comisses PerIns Percentual do INSS para o clculo das comisses RepSup Cdigo do representante superior do representante ComSup Percentual da comisso pago ao representante superior CodBan Cdigo do banco da conta corrente do representante

CodAge CcbRep TipCol NumCad VenVmp RecVmt PerCqt PerCvl CtaRed CtaRcr CtaFdv CtaFcr Retorno: "OK"

Cdigo da agncia do banco da conta corrente do representante Nmero da conta corrente do representante Tipo de Colaborador Nmero do Cadastro do Representante como Colaborador Valor mnimo aceito para pedidos Valor mnimo aceito para ttulos do contas a receber Percentual das cotas sobre as quantidades de venda Percentual das cotas sobre os valores de venda Conta contbil reduzida - 1 Conta contbil reduzida - 2 Conta contbil reduzida - 3 Conta contbil reduzida - 4

Observao: Esta ao aceita campos de usurio.

2.9.3 EXCLUIR REPRESENTANTE

Ao: SID.Rep.Excluir Parmetros obrigatrios: CodRep Cdigo do representante Retorno: "OK"

2.9.4 EXCLUIR DEFINIES DO REPRESENTANTE

Ao: SID.Rep.ExcluirDefinicoes Parmetros obrigatrios: CodRep Cdigo do representante Retorno: "OK"

2.10 CADASTROS FORNECEDORES

2.10.1 GRAVAR FORNECEDOR (INCLUIR/ALTERAR)

Ao: SID.For.Gravar Parmetros obrigatrios: NomFor Nome do fornecedor ApeFor Nome fantasia do fornecedor SigUfs Estado do fornecedor CodFor Cdigo do fornecedor (obrig. p/ alterao) CgcCpf Nmero do CNPJ ou CPF do fornecedor EndFor Endereo do fornecedor (rua, n., etc.) Parmetros opcionais: CodFor Cdigo do fornecedor MarFor Marca do fornecedor SenFor Senha do Fornecedor TipFor Tipo de Fornecedor (Padro=F) TipMer Tipo de Mercado do fornecedor (Padro=I) CodRam Cdigo do ramo de atividade InsEst Inscrio estadual ou RG do fornecedor InsMun Inscrio municipal do fornecedor CodGre Cdigo do grupo de empresas CodSuf Cdigo na suframa CplEnd Complemento do endereo do fornecedor (sala, andar, etc.) BaiFor Bairro do fornecedor ZipCod Cdigo da cidade do fornecedor externo - ZIP CODE EenFor Cdigo do endereo do fornecedor CepFor CEP do fornecedor CidFor Cidade do fornecedor

CodPai FonFor FaxFor CxaPst IntNet ForRep ForTra SitFor CodMot CliFor CodCli RecPis RecIpi RecIcm CodTri IdeFor Retorno: <CodFor>

Cdigo do pas Nmero do telefone - 1 Nmero do FAX do fornecedor Caixa postal do fornecedor Endereo eletrnico (E-Mail) Cdigo do fornecedor como representante Cdigo do fornecedor como transportadora Situao do fornecedor (Padro=A) Cdigo do motivo da situao do fornecedor Indicativo se o registro representa um cliente ou um fornecedor ou ambos (Padro=A) Cdigo do fornecedor como cliente (cria o cliente se no existir, e liga ambos) Indicativo se as notas fiscais do fornecedor podero ter recuperao de PIS (Padro=N) Indicativo se as notas fiscais podero ter recuperao de IPI (Padro=S) Indicativo se as notas fiscais podero ter recuperao de ICMS (Padro=S) Cdigo de tributao para emisso de DARF/DIRF Identificao do fornecedor Cdigo do fornecedor gerado

Observao: Esta ao aceita campos de usurio.

2.10.2

GRAVAR DEFINIES DO FORNECEDOR (INCLUIR/ALTERAR)

Ao: SID.For.GravarDefinicoes Parmetros obrigatrios: CodFor Cdigo do fornecedor CodCpg Cdigo da condio de pagamento padro Parmetros opcionais: SalDup Saldo devedor de duplicatas aos fornecedores SalOut Saldo devedor de outros ttulos aos fornecedores SalCre Saldo adiantamentos a fornecedores DatAtr Data do maior atraso VlrAtr Valor do maior atraso MaiAtr Quantidade de dias do maior atraso MedAtr Quantidade de dias de atraso mdio PrzEnt Quantidade de dias de prazo de entrega do fornecedor CodTpr Cdigo da tabela de preo padro CodFpg Cdigo da forma de pagamento CodTra Cdigo da transportadora padro CodPor Cdigo do portador padro CodCrt Cdigo da carteira padro CodBan Cdigo do banco da conta corrente do fornecedor CodAge Cdigo da agncia do banco da conta corrente do fornecedor CcbFor Nmero da conta corrente do fornecedor no banco CodCrp Cdigo do grupo de contas a pagar PagJmm Percentual de juros de mora ms para o contas a pagar PagTir Tipo de juros para o contas a pagar (Padro=S) PagDtj Dias de tolerncia para clculo de juros de mora do contas a pagar PagMul Percentual de multa para atraso do contas a pagar PagDtm Dias de tolerncia para multa do conta a pagar PerDsc Percentual padro de desconto para os ttulos gerados TolDsc Quantidade padro de dias de tolerncia para desconto PerDs1 Percentual de desconto - 1 para fornecedor PerDs2 Percentual de desconto - 2 para fornecedor PerFun Percentual do Funrural ou INSS para Produto PerIns Percentual do INSS para o Servio PerIss Percentual do ISS para servios do fornecedor IndInd Indicativo se o fornecedor indstria para IPI presumido (Padro=N) CtaRed Conta contbil reduzida - 1 CtaRcr Conta contbil reduzida - 2 CtaFdv Conta contbil reduzida - 3 CtaFcr Conta contbil reduzida - 4 CriEdv Critrio para escolha do dia de vencimento (A, S, N, U) Retorno: "OK" Observao: Esta ao aceita campos de usurio.

2.10.3

EXCLUIR FORNECEDOR

Ao: SID.For.Excluir Parmetros obrigatrios: CodFor Cdigo do fornecedor Retorno: "OK" Observao: Esta ao aceita campos de usurio.

2.10.4

EXCLUIR DEFINIES DO FORNECEDOR

Ao: SID.For.ExcluirDefinicoes Parmetros obrigatrios: CodFor Cdigo do fornecedor Retorno: "OK"

2.11 CADASTROS PRODUTOS

2.11.1 GRAVAR PRODUTO (INCLUIR/ALTERAR)

Ao: SID.Pro.Gravar Parmetros obrigatrios: CodPro Cdigo do produto DesPro Descrio usual do produto CodFam Cdigo da famlia do produto Parmetros opcionais: UniMed Cdigo da unidade de medida do produto TipPro Tipo do produto CodOri Cdigo de origem do produto RecIpi Indicativo se o produto recupera ou no IPI TemIcm Indicativo se o produto tem ou no ICMS RecIcm Indicativo se o produto recupera ou no ICMS BxaOrp Se for componente de alguma OP, indica se o mesmo baixado SitPro Situao do produto IndMis Indicativo que o produto produzido mas tambm pode ser comprado (misto) IndVen Indicativo se o produto pode ser vendido/faturado IndCpr Indicativo se o produto pode ser comprado IndReq Indicativo se o produto pode ser requisitado IndKit Indicativo que o produto produzido um "Kit" com vrios produtos agregados para venda MatDir Indicativo se o material direto ClaPro Classe do produto IndFpr Indicativo se a ligao de produto X fornecedor usada para obter parmetros fiscais CtrVld Indicativo da forma de controle da data de validade nos estoques CodClf Cdigo interno da classificao fiscal CodStr Cdigo da situao tributria do produto DepPad Depsito padro para o produto RecPis Indicativo se o produto recolhe ou no PIS RecCof Indicativo se as notas fiscais podero ter recuperao de Cofins CplPro Descrio complementar do produto ProImp Indicativo do Tipo de Produto para Impostos DesNfv Descrio Nota Fiscal CodAgf Cdigo de agrupamento de materiais/produtos para Impostos. Retorno: "OK" Observao: Esta ao aceita campos de usurio.

2.11.2

EXCLUIR PRODUTO

Ao:

SID.Pro.Excluir Parmetros obrigatrios: CodPro Cdigo do produto Retorno: "OK"

2.11.3

GRAVAR DERIVAO (INCLUIR/ALTERAR)

Ao: SID.Pro.GravarDerivacao Parmetros obrigatrios: CodPro Cdigo do produto CodDer Cdigo da derivao do produto Parmetros opcionais: DesDer Descrio da derivao no componente da mscara CodBar Cdigo de barras EAN13 CodAgr Cdigo de agrupamento para derivao PesBru Peso bruto do produto PesLiq Peso lquido do produto VolDer Volume do produto BxaOrp Se for componente de alguma OP, indica se o mesmo baixado SitDer Situao da derivao CtrVld Indicativo da forma de controle da data de validade nos estoques IndKan Indicativo se usa controle de critrio Kanban na gerao de OPs CodBa2 Cdigo de barras livre DiaVlt Quantidade de dias para clculo da validade do lote de fabricao DepPad Depsito padro para a derivao PreCus * Preo de custo DatCus* Data base do preo de custo HorCus* Hora de atualizao do Custo * Campos disponveis na verso 5.5.2.2 Retorno: "OK" Observao: Esta ao aceita campos de usurio.

2.11.4

EXCLUIR DERIVAO

Ao: SID.Pro.ExcluirDerivacao Parmetros obrigatrios: CodPro Cdigo do produto CodDer Cdigo da derivao do produto Retorno: "OK"

2.12 FINANAS CONTAS A RECEBER

2.12.1 GRAVAR TTULO CR

Ao: SID.Tcr.Gravar (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo a receber CodTpt Cdigo do tipo de ttulo a receber CodTns Cdigo da transao que gerou o ttulo a receber SitTit Situao do ttulo DatEnt Data de entrada do ttulo a receber DatEmi Data de emisso do ttulo a receber CodCli Cdigo do cliente do ttulo a receber CodRep Cdigo do representante do ttulo a receber VctOri Data do vencimento/Valor original do ttulo a receber VlrOri Valor original do ttulo a receber CodPor Cdigo do portador do ttulo

CodCrt ProJrs CodFpg*

*Depende da parametrizao.

Cdigo da carteira do ttulo a receber Indicativo se o vencimento prorrogado com ou sem juros Cdigo da forma de pagamento

Parmetros opcionais: CodMoe CodNtg CodSac CodCrp ObsTcr CodMpt DatPpt VlrBco VlrCom PerCom ComRec DatDsc TolDsc PerDsc VlrDsc PerJrs TipJrs JrsDia TolJrs PerMul TolMul CheBan CheAge CheCta CheNum DatNeg TitBan NumArb CodOcr CodIn1 CodIn2 JrsNeg MulNeg DscNeg OutNeg CpgNeg TaxNeg CtaFin CtaRed CodCcu NumPrj CodFpj CodBar CtaFinCap(n)* CtaRedCap(n)* PerCtaCap(n)* CodCcuCap(n)* PerRatCap(n)*

Cdigo da moeda do ttulo a receber Cdigo da natureza de gasto Cdigo do sacado Cdigo do grupo de contas a receber Observao para o ttulo Cdigo do motivo de prorrogao do titulo Data do provvel pagamento do ttulo Valor base/Valor da comisso do ttulo** Valor comisso** Percentual comisso** Percentual de comisso pago no recebimento** Data/Tolerncia vlidas para desconto do ttulo Dias de tolerncia para desconto Percentual/Valor do desconto do ttulo Valor do desconto a ser concedido ao ttulo a receber Percentual de juros de mora ao mes do ttulo a receber Indicativo se os juros de mora simples ou composto Valor de juros de mora ao dia do ttulo a receber Dias de tolerncia para os juros de mora do ttulo a receber Percentual de multa prevista para o ttulo a receber Dias de tolerncia para a multa prevista para o ttulo a receber Nmero do banco na FEBRABAN do cheque Nmero da agncia do banco do cheque Numero da conta no banco do cheque Nmero do cheque no banco Data base dos juros negociados data at Nmero do ttulo no banco nosso nmero Nmero de arquivo de remessa para banco Cdigo da ocorrncia de remessa para banco Cdigo da primeira instruo bancria Cdigo da segunda instruo bancria Valor dos juros negociados Valor da multa negociada Valor dos descontos negociados Valor de outros valores negociados Cdigo da condio de pagamento negociada Taxa negociada Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Nmero interno do projeto Cdigo da fase do projeto Cdigo de barras do Ttulo Conta financeira do rateio da comisso Conta contbil reduzida do rateio da comisso Percentual do rateio da conta da comisso Cdigo do centro de custo do rateio da comisso Percentual do rateio da comisso

* (n) = Seqncia incremental da linha do rateio, iniciando em 1 (um) No utilizar os parnteses. ** Os campos podem ser recalculados conforme a combinao utilizada

Retorno: "OK" Observao: Esta ao aceita campos de usurio.

2.12.2

BAIXAR TTULO CR

Ao: SID.Tcr.Baixar (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo a receber CodTpt Cdigo do tipo de ttulo a receber CodTns Cdigo da transao de movimento DatMov Data de movimento do ttulo a receber DatPgt Data de pagamento NumCco* Nmero da conta interna financeira VlrMov Valor do movimento
*Depende da parametrizao

Parmetros opcionais: TipRet DatLib DiaAtr DiaJrs VlrDsc VlrJrs VlrMul VlrCom VlrBco VlrEnc VlrCor VlrOac VlrOde CotMcr FilRlc NumRlc TptRlc SeqRlc CodFpg NumDoc TnsBxa SemJrs CtaFinCap(n)* CtaRedCap(n)* PerCtaCap(n)* CodCcuCap(n)* PerRatCap(n)*

Tipo de retorno da ao, quando bem sucedida (ver Retorno para mais detalhes) Data de liberao Dia de atrasos Dia de juros Valor de descontos Valor de juros Valor de multa Valor da comisso Valor base da comisso Valor de encargos Valor das correes Valor de outros acrscimos Valor de outros descontos Cotao da movimentao do contas a receber Cdigo da filial do ttulo relacionado gerado ou aproveitado Nmero do ttulo relacionado gerado ou aproveitado Tipo do ttulo relacionado gerado ou aproveitado Seqncia do movimento relacionado gerado ou aproveitado Cdigo da forma de pagamento Nmero do documento para movimento da tesouraria Transao de movimentao na tesouraria Ignora clculo de juros, multa e desconto (0=no*, 1=sim) *Valor padro Conta financeira do rateio da comisso Conta contbil reduzida do rateio da comisso Percentual do rateio da conta da comisso Cdigo do centro de custo do rateio da comisso Percentual do rateio da comisso

* (n) = Seqncia incremental da linha do rateio, iniciando sem 1 (um) No utilizar os parnteses.

Retorno: Se o parmetro TipRet (tipo de retorno da ao) for: - 0 (padro): "OK" - 1: <SeqMov> (Seqncia do movimento gerado)

2.12.3

GRAVAR RATEIO TTULO CR

Ao: SID.Tcr.GravarRateio (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo CtaFin(n)* Conta financeira** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custo 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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto Parmetros opcionais: ObsRat(n)* Observao do rateio Retorno: "OK" Observaes:
* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

2.12.4

EXCLUIR TTULO CR

Ao: SID.Tcr.ExcluirTitulo (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo Parmetros opcionais: TroPor Indicativo para trocar o portador (c/ o anterior) antes de excluir o ttulo (0=no*, 1=sim)
* Valor padro

Retorno: "OK"

2.12.5

EXCLUIR BAIXA CR

Ao: SID.Tcr.ExcluirBaixa (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo SeqMov Seqncia do movimento Retorno: "OK"

2.12.6

ALTERAR TTULO CR (SOMENTE DATA DE VENCIMENTO)

Ao: SID.Tcr.Alterar (FRCR) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo VctPro Vencimento prorrogado Parmetros opcionais: ProJrs Indicativo se o vencimento da prorrogao possui juros (S/N) CodMpt Cdigo do motivo de prorrogao do ttulo Retorno: "OK"

2.12.7

SELECIONAR TTULO CR

Esta ao SID exclusiva da integrao Sapiens Varejo e requer que a soluo esteja corretamente implantada para utilizao. Ao: SID.Tcr. SelecionarTitulosEmAbertoCliente (FRCR) Parmetros obrigatrios: CodCli Cdigo do cliente Parmetros opcionais: NumTit CodTpt CodTns DatPgt ConJrs* ConMul* ConDsc* * Valor padro Nmero do ttulo a receber Cdigo do tipo de ttulo a receber Cdigo da transao do ttulo Data de previso de pagamento Considerar juros (S=sim*/N=no) Considerar multa (S=sim*/N=no) Considerar desconto (S=sim*/N=no)

Retorno: <NomeColuna1>;<NomeColuna2>;<NomeColuna3>;... + LF <ValorColuna1>;<ValorColuna2>;<ValorColuna3>;... + LF Campos de retorno: CodEmp CodFil NumTit CodTpt CodCli NomCli TitBan CodTns DatEmi NumCco VlrOri VlrAbe VlrDsc VlrJrs VlrMul VlrEnc Cdigo da empresa Cdigo da filial Nmero do ttulo Cdigo do tipo do ttulo Cdigo do cliente Nome do cliente Nmero do ttulo no banco Cdigo da transao Data da emisso do ttulo Nmero da conta interna Valor original do ttulo Valor em aberto do ttulo Valor do desconto Valor dos juros Valor da multa Valor dos encargos

VlrCor VlrOac VlrOde VlrMov CodFpg DiaAtr DiaJrs VctOri

Valor da correo monetria do ttulo Valor de outros acrscimos do ttulo Valor de outros descontos do ttulo Valor do movimento j calculado com juros, multa, desconto, etc. Cdigo da forma de pagamento Nmero de dias de atraso Nmero de dias de juros calculados Vencimento original / prorrogado

2.12.8

PROCESSAR BAIXAS AUTOMTICAS

Ao: SID.Tcr.ProcessarBaixasAutomaticas (FRCR) Parmetros obrigatrios: DatMov Data da baixa CodTns Cdigo da transao (recebimento) DatCxb Data de movimento (tesouraria) NumCco Cdigo da conta interna TnsCxb Cdigo da transao (tesouraria) LiqCre Total lquido CodTpt Tipo de ttulo a processar NumTit(n)* Ttulos a processar
* (n) = Seqncia incremental do ttulo, iniciando sempre em 1 (um) No utilizar os parnteses.

Parmetros opcionais: NroDoc Nmero do documento TipVct Tipo de vencimento (1=provvel pagamento*, 2=vencimento normal) *Padro CodFpg Cdigo da forma de pagamento VlrPgt(n)* Valor da baixa (informar somente quando for parcial) o valor de Opcao Proceder baixa portador diferente de portador empresa(N=Bloqueia, S=Procede)
* (n) = Seqncia incremental do ttulo, deve coincidir com a seqncia do respectivo ttulo

Retorno: "OK" Observao: Todos os rateios deste processo devem ser pr-definidos sem confirmao (ou sem rateio). Os lanamentos na tesouraria sero processados sempre com o valor da baixa (no h possibilidades de dividir os movimentos).

2.13 FINANAS CONTAS A PAGAR

2.13.1 GRAVAR TTULO CP

Ao: SID.Tcp.Gravar (FPCP) Parmetros obrigatrios: NumTit Nmero do ttulo a pagar CodTpt Cdigo do tipo do ttulo a pagar CodFor Cdigo do fornecedor do ttulo a pagar CodTns Cdigo da transao origem do ttulo a pagar DatEnt Data da entrada do ttulo a pagar DatEmi Data de emisso do ttulo a pagar VctOri Data do vencimento original do ttulo a pagar VlrOri Valor original do ttulo a pagar VctPro Data do vencimento atual do ttulo a pagar CodMoe Cdigo da moeda base do ttulo a pagar CodPor Cdigo do portador do ttulo a pagar CodCrt Cdigo da carteira do ttulo a pagar Parmetros opcionais: CodCrp Cdigo do grupo de contas a pagar CodNtg Cdigo da natureza de gasto CodTri Cdigo de tributao para emisso da DARF ObsTcp Observao para o ttulo CodMpt Cdigo do motivo de prorrogao do titulo CotEmi Valor da cotao da moeda na data de emisso do ttulo DatDsc Data/Tolerncia vlidas para desconto do ttulo TolDsc Dias de tolerncia para desconto PerDsc Percentual de desconto a ser concedido ao ttulo a pagar VlrDsc Valor do desconto a ser concedido ao ttulo a pagar PerJrs Percentual de juros de mora previsto para o ttulo a pagar TipJrs Indicativo se o juros de mora simples ou composto JrsDia Valor dos juros de mora ao dia a serem pagos no ttulo a pagar

TolJrs PerMul TolMul DatNeg JrsNeg MulNeg OutNeg TitBan CodFpg CodUsu DatApr VlrApr PgtApr CotApr DscApr OdeApr JrsApr MulApr EncApr CorApr OacApr EmpApr CtaApr SeqApr LibApr CodBan CodAge CcbFor PorAnt CtaFin CtaRed CodCcu FpgApr CodBar UsuSit NumArb NumPrj CodFpj DatPpt CodFav Retorno: "OK"

Quantidade de dias de tolerncia para os juros de mora Percentual de multa prevista para o ttulo a pagar Quantidade de dias de tolerncia para a multa do ttulo a pagar Data base dos juros negociados data at Valor dos juros negociados Valor da multa negociada Valor de outros valores negociados Nmero do ttulo a pagar no banco Cdigo da forma de pagamento Cdigo do Usurio Responsvel pela Aprovao do Pagamento Data da aprovao para o pagamento Valor base do ttulo aprovado para o pagamento Data de aprovao para o pagamento Valor da cotao da moeda na data de aprovao para pagamento Valor dos descontos aprovado Valor de outros descontos aprovado Valor dos juros de mora aprovado Valor da multa aprovado Valor dos encargos aprovado Valor da correo monetria aprovada Valor de outros acrscimos aprovado Cdigo da empresa da conta aprovada Nmero da conta interna aprovada para pagamento do titulo Seqncia de juno de ttulos pagos com mesmo cheque Data da liberao do cheque aprovado para pagamento Cdigo do banco da conta corrente do fornecedor Cdigo da agncia do banco da conta corrente do fornecedor Nmero da conta corrente do fornecedor no banco Cdigo do portador anterior Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Cdigo da forma de pagamento aprovada Cdigo de barra para pagamento eletrnico Usurio responsvel pela alterao da situao do ttulo Nmero de arquivo de remessa para banco Nmero interno do projeto Cdigo da fase do projeto Data do provvel pagamento do ttulo Nmero do CNPJ ou CPF do favorecido

Observao: Esta ao aceita campos de usurio

2.13.2

BAIXAR TTULO CP

Ao: SID.Tcp.Baixar (FPCP) Parmetros obrigatrios: NumTit Nmero do ttulo a pagar CodTpt Cdigo do tipo de ttulo a pagar CodFor Cdigo do fornecedor CodTns Cdigo da transao de movimento TnsCxb* Transao gerada no caixa e bancos NumCco* Nmero da conta interna financeira SeqChe* Seq. controle juno de pagtos mesmo cheque. (identificador TES- 600SEQCH01) VlrMov Valor do movimento
*Depende da parametrizao

Parmetros opcionais: TipRet Tipo de retorno da ao, quando bem sucedida (ver Retorno para mais detalhes) DatMov Data do movimento do ttulo a pagar (Se estiver zerada recebe data atual) DatPgt Data do pagamento do ttulo a pagar (Se estiver zerada recebe data atual) NumDoc Nmero do documento do movimento do ttulo a pagar ObsMcp Observao do movimento do contas a pagar CodFpg Cdigo da forma de pagamento CotMcp Valor da cotao da moeda na data base do movimento DatLib Data de liberao do cheque (Se estiver zerada recebe data atual) VlrDsc Valor do desconto concedido ao pagamento do ttulo VlrOde Valor de outros descontos do ttulo VlrJrs Valor dos juros de mora pago VlrMul Valor da multa pago VlrEnc Valor dos encargos do ttulo

VlrCor VlrOac NumPrj CodFpj CtaFin CtaRed CodCcu TipPgt CodBan CodAge CcbFor AgrPre

* Valor padro

Valor da correo monetria do ttulo Valor de outros acrscimos do ttulo Nmero do projeto Cdigo da fase do projeto Conta financeira reduzida Conta contbil reduzida Cdigo do centro de custo Tipo de pagamento do ttulo Cdigo do banco da conta corrente do fornecedor Cdigo da agncia do banco da conta corrente do fornecedor Nmero da conta corrente do fornecedor no banco Indicativo para agrupar sequncia preparao de cheque (0=no*, 1=sim)

Retorno: Se o parmetro TipRet (tipo de retorno da ao) for: - 0 (padro): "OK" - 1: <SeqMov> (Seqncia do movimento gerado)

2.13.3

GRAVAR RATEIO TTULO CP

Ao: SID.Tcp.GravarRateio (FPCP) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo CodFor Cdigo do fornecedor CtaFin(n)* Conta financeira** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custo 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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto Parmetros opcionais: ObsRat(n)* Observao do rateio Retorno: "OK" Observaes:
* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

2.13.4

EXCLUIR TTULO CP

Ao: SID.Tcp.ExcluirTitulo (FPCP) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo CodFor Cdigo do fornecedor Retorno: "OK"

2.13.5

EXCLUIR BAIXA CP

Ao: SID.Tcp.ExcluirBaixa (FPCP) Parmetros obrigatrios: NumTit Nmero do ttulo CodTpt Tipo do ttulo CodFor Cdigo do fornecedor SeqMov Sequncia do movimento Retorno: "OK"

2.14 FINANAS TESOURARIA

2.14.1 GRAVAR MOVIMENTO (INCLUIR/ALTERAR)

Ao: SID.Tes.Gravar (FTCB) Parmetros obrigatrios: NumCco Conta interna CodTns Cdigo da transao VlrMov* Valor do movimento Parmetros opcionais: DatMov Data do movimento SeqMov Seqncia do movimento DatCtb* Data contbil do movimento DatLib* Data de liberao do movimento CodNtg Cdigo da natureza de gastos CodCcu Cdigo do centro de custos CodDoc Cdigo do tipo de documento para tesouraria DocMov* Nmero do documento do movimento CtaRed Conta contbil reduzida CtaFin Conta financeira reduzida HisMov Histrico do movimento NomRec* Nome do recebedor do cheque CplMov Complemento do histrico do movimento SitMcc Situao do movimento ObsMcc Observao do movimento NumPrj Cdigo do projeto CodFpj Cdigo da fase do projeto Retorno: <SeqMov> Observaes: Seqncia do movimento

* Campos disponveis somente na incluso

2.14.2

GRAVAR RATEIO DO MOVIMENTO

Ao: SID.Tes.GravarRateio (FTCB) Parmetros obrigatrios: NumCco Conta interna CodTns Cdigo da transao DatMov Data do movimento SeqMov Seqncia do movimento CtaFin(n)* Conta financeira** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custo 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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto

* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

Parmetros opcionais: ObsRat Observao do rateio Retorno: "OK"

2.14.3

PROCESSAR MOVIMENTO (CHEQUE)

Ao: SID.Tes.ProcessarMvto (FTCB) Parmetros obrigatrios: NumCco Conta interna DatIni Data de emisso inicial da abrangncia de movimentos a serem processados DatFim Data de emisso final da abrangncia de movimentos a serem processados

OriChe

Origem (valores vlidos: CP, CM, CA, FP, DR, DV)

Parmetros opcionais: PrxNro Prximo nmero TipSel Tipo de sida (0=Cheque, 1=Aviso dbito, 3=Outros) Retorno: OK Observao: Esta ao baseada na tela F600ECH (Tesouraria Gerao de movimentos e emisso de cheques e avisos)

2.15 FINANAS PROJETOS

2.15.1 GRAVAR LANAMENTO

Ao: SID.Prj.Gravar (FJCF) Parmetros obrigatrios: CodTns Cdigo da transao do lanamento manual VlrMan Valor do movimento do lanamento manual NumPrj Nmero do projeto do lanamento manual CodFpj Cdigo da fase do projeto do lanamento manual TipRec Tipo do recurso (1=Mater., 2=Serv., 3=Hum., 4=Patr., 5=Terc., 6=0utros, 7=Plano Fin.) Parmetros opcionais: DatGer Data da gerao do registro TipMan Indicativo do tipo de lanamento (P=Previsto, R=Realizado, A=Ambos) DebCre Movimento de Dbito ou Crdito SomSub Somar ou subtrair o valor no plano financeiro/centro de custos DatMan Data base do lanamento manual DesMan Descrio do lanamento manual ObsMan Observao do lanamento manual DocMan Nmero do documento do lanamento CodNtg Cdigo da natureza de gasto CodAgo Cdigo de agrupamento do lanamento QtdMan Quantidade do lanamento manual UniMan Cdigo da unidade de medida do lanamento manual PreUni Preo unitrio da movimentao SeqRcp Seqncia dos recursos previstos CtaFin Conta financeira reduzida do lanamento manual CtaRed Conta contbil reduzida do lanamento manual CodCcu Cdigo do centro de custos do lanamento manual UsuEnv Cdigo do usurio envolvido no projeto/fase CodDep Cdigo do depsito utilizado como recurso previsto CodPro Cdigo do produto utilizado CodDer Cdigo da derivao do produto utilizada CodSer Cdigo do servio utilizado CodFor Cdigo do fornecedor do produto/material ou servio CodBem Cdigo do bem utilizado SitMan Situao do lanamento manual NumLot Nmero do lote contbil CtaFin(n)* Conta financeira** CtaRed(n)* Conta contbil reduzida** CodCcu(n)* Cdigo do centro de custo 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)* Nmero interno do projeto CodFpj(n)* Cdigo da fase do projeto
* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses. ** Depende da parametrizao. *** Informar apenas o percentual ou valor.

Retorno: <SeqGer>

Seqncia de gerao do lanamento manual na data

2.15.2

EXCLUIR LANAMENTO

Ao: SID.Prj.Excluir (FJCF) Parmetros obrigatrios:

DatGer SeqGer Retorno: "OK"

Data da gerao do registro Seqncia de gerao do lanamento manual na data

2.16 CONTROLADORIA TRIBUTOS - REDUO Z

2.16.1 GRAVAR TOTALIZADORES DA REDUO Z

Ao: SID.Rez.GravarTotalizador (CIEC) Parmetros obrigatrios: CodEqu Cdigo do equipamento fiscal da reduo Z DatRef Data de referncia da reduo Z NumMar Nmero do mapa resumo NumRez Nmero da reduo Z Parmetros obrigatrios: VlrGtf Gran total do final do dia da reduo Z VlrBru Valor bruto da reduo Z VlrDsc Valor dos descontos da reduo Z VlrCan Valor dos cancelamentos da reduo Z VlrSer Valor dos servios da reduo Z VlrGti Gran total do incio do dia da reduo Z VlrAcr Valor dos acrscimos da reduo Z ConRei Valor acumulado no contador de reincio de operao Retorno: "OK"

2.16.2

GRAVAR MOVIMENTOS DA REDUO Z

Ao: SID.Rez.GravarMovimento (CIEC) Parmetros obrigatrios: CodEqu Cdigo do equipamento fiscal da reduo Z DatRef Data de referncia da reduo Z SigUfs Sigla do estado do movimento da reduo Z CodTns Cdigo da transao do movimento da reduo Z NumCfi Nmero do primeiro cupom fiscal de referncia da reduo Z NumCff Nmero do ltimo cupom fiscal de referncia da reduo Z CodSnf Cdigo da srie do movimento da reduo Z VlrCtb Valor contbil do movimento da reduo Z CodAgf Cdigo de agrupamento para escrita fiscal Parmetros opcionais: SitCfi Situao do movimento da reduo Z CliCon Indicativo se o cliente contribuinte CodEdc Espcie de documento da reduo Z para fins fiscais CodTrd Cdigo do tipo de ICMS reduzido do movimento da reduo Z PerIcm Percentual do ICMS do movimento da reduo Z VlrBic Valor base do ICMS do movimento da reduo Z VlrIcm Valor do ICMS do movimento da reduo Z VlrIic Valor isento ICMS do movimento da reduo Z VlrOic Valor outros ICMS do movimento da reduo Z PerIpi Percentual de IPI do movimento da reduo Z VlrBip Valor base do IPI do movimento da reduo Z VlrIpi Valor do IPI do movimento da reduo Z VlrIip Valor isento de IPI do movimento da reduo Z VlrOip Valor outros IPI do movimento da reduo Z PerIss Percentual do ISS do movimento da reduo Z VlrBis Valor base do ISS do movimento da reduo Z VlrIss Valor do ISS do movimento da reduo Z VlrDsc Valor do desconto do movimento da reduo Z VlrAcr Valor do acrscimo do movimento da reduo Z ObsRez Observao do movimento da reduo Z NumLot Nmero do lote contbil CtaRed Conta contbil reduzida SitTri Situao Tributria dos Itens do Cupom Fiscal CodFpg Cdigo da forma de pagamento PerPit Percentual do PIS faturamento VlrBpt Base de clculo do PIS faturamento

AliPif QtdBpf VlrPit PerCrt VlrBct AliCff QtdBcf VlrCrt CstPis CstCof

Alquota por Valor do PIS Quantidade da Base do PIS Valor do PIS faturamento Percentual do COFINS faturamento Base de clculo do COFINS faturamento Alquota por Valor do COFINS Quantidade da Base do COFINS Valor do COFINS faturamento Cdigo da Situao Tributria do PIS Cdigo da Situao Tributria do COFINS

Retorno: <SeqRez>

Seqncia de lanamento do movimento da reduo Z

2.16.3

GRAVAR RATEIOS DOS MOVIMENTOS DA REDUO Z

Ao: SID.Rez.GravarRateio (CIEC) Parmetros obrigatrios: CodEqu Cdigo do equipamento fiscal da reduo Z DatRef Data de referncia da reduo Z SeqRez Seqncia de lanamento do movimento da reduo Z CriRat Critrio utilizado para o Rateio Parmetros opcionais: SeqRat Seqncia do Rateio DatBas Data base contbil e financeira CtaRed Conta contbil reduzida PerCta Percentual rateado para a conta VlrCta Valor rateado para a conta CodCcu Cdigo do centro de custos PerRat Percentual rateado para o centro de custos VlrRat Valor rateado para o centro de custos ObsRat Observao do rateio Retorno: <SeqRat> Seqncia do Rateio

2.16.4

GRAVAR ITENS DA REDUO Z

Ao: SID.Rez.GravarItem (CIEC) Parmetros obrigatrios: CodEqu Cdigo do equipamento fiscal da reduo Z DatRef Data de referncia da reduo Z SeqRez Seqncia de lanamento do movimento da reduo Z NumCfi Nmero do cupom fiscal de referncia do item VlrCtb Valor contbil do item no movimento do cupom fiscal Parmetros opcionais: PerIcm Percentual do ICMS do item no movimento do cupom fiscal VlrBic Valor base do ICMS do item no movimento do cupom fiscal VlrIcm Valor do ICMS do item no movimento do cupom fiscal VlrIic Valor isento ICMS do item no movimento do cupom fiscal VlrOic Valor outros ICMS do item no movimento do cupom fiscal PerIpi Percentual de IPI do item no movimento do cupom fiscal VlrBip Valor base do IPI do item no movimento do cupom fiscal VlrIpi Valor do IPI do item no movimento do cupom fiscal VlrIip Valor isento de IPI do item no movimento do cupom fiscal VlrOip Valor outros IPI do item no movimento do cupom fiscal PerIss Percentual do ISS do item no movimento do cupom fiscal VlrBis Valor base do ISS do item no movimento do cupom fiscal VlrIss Valor do ISS do item no movimento do cupom fiscal VlrDsc Valor do desconto do item no movimento do cupom fiscal VlrAcr Valor do acrscimo do item no movimento do cupom fiscal ObsItr Observao do item no movimento do cupom fiscal CodPro Cdigo do Produto CodDer Cdigo da Derivao CodSer Cdigo do Servio QtdIte Quantidade do Item PerPit Percentual do PIS faturamento VlrBpt Base de clculo do PIS faturamento

AliPif QtdBpf VlrPit PerCrt VlrBct AliCff QtdBcf VlrCrt CstPis CstCof Retorno: <SeqIte>

Alquota por Valor do PIS Quantidade da Base do PIS Valor do PIS faturamento Percentual do COFINS faturamento Base de clculo do COFINS faturamento Alquota por Valor do COFINS Quantidade da Base do COFINS Valor do COFINS faturamento Cdigo da Situao Tributria do PIS Cdigo da Situao Tributria do COFINS Seqncia do item no movimento do cupom fiscal

2.17 CONTROLADORIA TRIBUTOS NOTA FISCAL COMPRA

2.17.1 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)

Ao: SID.Nic.Gravar (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de entrada CodTns Cdigo da transao de entrada CodAgf Cdigo do Agrupamento fiscal DatEmi Data de Emisso CodAgf Cdigo de agrupamento para escrita fiscal Parmetros opcionais: DatEnt Data de Entrada NopOpe Natureza de operao CodEdc Espcie de documento para fins fiscais ObsNfc Observao lanamento de ICMS ObsIpi Observao lanamento de IPI VlrCtb Valor contbil da nota fiscal VlrBic Valor base do ICMS PerIcm Percentual do ICMS VlrIcm Valor do ICMS VlrOic Valor outros ICMS VlrIic Valor isento ICMS VlrDai Diferena de Alquota Interestadual do ICMS VlrBip Valor base do IPI VlrIpi Valor do IPI VlrBid Valor base IPI destacado/presumido (50% compra no comrcio) VlrIpd Valor do IPI destacado/presumido (50% compra no comrcio) VlrOip Valor outros IPI VlrIip Valor isento IPI VlrBir Valor base do IRRF PerIrf Percentual do IRRF VlrIrf Valor do IRRF CtaRed Cdigo da conta contbil CodCpg Cdigo da condio de pagamento VlrBsi Valor base do ICMS substitudo VlrSic Valor do ICMS substitudo VlrBpr Base de clculo do PIS a recuperar VlrPir Valor do PIS a recuperar VlrBcr Base de clculo do COFINS a recuperar VlrCor Valor do COFINS a recuperar VlrDsc Valor do Desconto SitNfc Situao da nota fiscal PerCrt Percentual do COFINS Retido VlrBct Valor Base do COFINS Retido VlrCrt Valor do COFINS Retido PerPit Percentual do PIS Retido VlrBpt Valor Base do PIS Retido VlrPit Valor PIS Retido PerCsl Percentual da CSLL VlrBcl Valor Base da CSLL VlrCsl Valor da CSLL PerOur Percentual das Outras Retenes VlrBor Valor Base das Outras Retenes VlrOur Valor das Outras Retenes

PerIss VlrBis VlrIss PerIns VlrBin VlrIns VlrBpf VlrPif VlrBcf VlrCff VlrBsd VlrIsd VlrBsp VlrStp VlrBsc VlrStc VlrBfu PerFun VlrFun CodTri TipNfe VlrFre CifFob VlrSeg VlrDac CodCcu CodTra CodVia PlaVei PreImp CodTic CodTrd VlrBii VlrIim VlrBie VlrIem NumDoi VlrRis DatDoi CodSel CodSsl SeqOrm PesBru PesLiq PerIcf IcmFre SomFre CodMs1 CodMs2 CodMs3 CodMs4 ChvNel UfsCic EquRez DatRez CfiRez VlrFei VlrSei VlrOui QtdBip QtdBpi QtdBco QtdBpf QtdBcf VlrSub Retorno: "OK"

Percentual do ISS Valor Base do ISS Valor do Iss Percentual do INSS Valor Base do INSS Valor do INSS Valor Base do PIS Faturamento Valor do PIS Faturamento Valor Base do COFINS Faturamento Valor do COFINS Faturamento Valor base do ICMS substitudo destacado Valor do ICMS substitudo destacado Valor base da substituio do PIS Valor da substituio do PIS Valor base da substituio do COFINS Valor da substituio do COFINS Valor base do Funrural Percentual do Funrural Valor do Funrural Cdigo de tributao para emisso da DARF Tipo de nota fiscal de entrada Valor do frete da nota fiscal de entrada Indicativo se o valor do frete CIF ou FOB Valor do seguro da nota fiscal de entrada Valor das despesas acessrias Cdigo do centro de custo Cdigo da transportadora da nota fiscal de entrada Via de transporte da nota fiscal de entrada Placa do veculo de transporte das mercadorias da nota fiscal de entrada Nmero pr-impresso no formulrio da nota fiscal Cdigo do ICMS especial Cdigo de reduo de impostos Valor base do imposto de importao Valor do imposto de importao Valor base do INSS parte empresa Valor do INSS parte empresa Nmero do documento de importao Valor de reteno de ICMS substituto Data do registro do documento de importao Cdigo da srie legal da nota fiscal de entrada Cdigo da sub-srie legal da nota fiscal de entrada Seqncia do endereo de origem da mercadoria Peso bruto da nota fiscal de entrada Peso liquido da nota fiscal de entrada Percentual de ICMS sobre o frete Valor de ICMS sobre o frete Somar o valor do frete no valor da nota fiscal Cdigo da mensagem 1 Cdigo da mensagem 2 Cdigo da mensagem 3 Cdigo da mensagem 4 Chave de acesso da nota fiscal eletrnica Sigla do estado base para o clculo do ICMS Cdigo do equipamento fiscal da reduo Z devolvida Data de referncia da reduo Z devolvida Nmero do cupom fiscal de referncia da reduo Z devolvida Valor de frete de importao Valor do seguro de importao Valor de outras despesas de importao Quantidade da Base do IPI Quantidade da Base do PIS a recuperar Quantidade da Base do COFINS a recuperar Quantidade da Base do PIS por faturamento (Estorno devoluo) Quantidade da Base do COFINS por faturamento (Estorno devoluo) Valor Subsdio

2.17.2

GRAVAR RATEIOS DOS DADOS GERAIS

Ao: SID.Nic.GravarRateio (CIEC) Parmetros obrigatrios: CodFor Cdigo do Fornecedor NumNfi Nmero inicial da nota fiscal de entrada

NumNff CodSnf CodTns CriRat

Seqencial de lanamento da nota fiscal Cdigo da srie da nota fiscal sada Transao Critrio utilizado para rateio

Parmetros opcionais: SeqRat Seqncia do rateio DatBas Data base contbil e financeira CtaRed Conta contbil reduzida PerCta Percentual rateado para a conta VlrCta Valor rateado para a conta CodCcu Cdigo do centro de custos PerRat Percentual rateado para o centro de custos VlrRat Valor rateado para o centro de custos ObsRat Observao do rateio Retorno: <SeqRat> Seqncia do Rateio

2.17.3

GRAVAR ITEM (INCLUIR/ALTERAR)

Ao: SID.Nic.GravarItem (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de entrada CodTns Cdigo da transao de entrada SeqInc* Seqncia de lanamento do item
* Opcional na incluso

Parmetros opcionais: CodPro Cdigo do produto CodDer Cdigo da derivao do produto CplPro Descrio complementar do produto ou servio CodClf Cdigo interno da classificao fiscal ClaFis Cdigo da classificao fiscal - NCM QtdEnt Quantidade de entrada do produto UniMed Unidade de medida da quantidade do produto PreUni Preo unitrio do item da nota fiscal de entrada VlrBic Valor base do ICMS PerIcm Percentual do ICMS VlrIcm Valor do ICMS VlrIic Valor isentas ICMS VlrOic Valor outras ICMS VlrBip Valor base do IPI PerIpi Percentual de IPI VlrIpi Valor do IPI VlrIip Valor isentas IPI VlrOip Valor outras IPI VlrBid Valor base do IPI presumido VlrIpd Valor do IPI presumido VlrBsi Valor base do ICMS substitudo VlrCip Valor do ICMS no creditado no CIAP SitCip Situao do CIAP DatIna Data da inativao do item para o clculo do CIAP ObsIna Observao ou motivo da inativao do item para o clculo do CIAP SeqIpc Seqncia do item na nota fiscal de entrada VlrDsc Valor do desconto do item CodStr Situao tributria do item da nota fiscal de entrada CodTrd Cdigo de reduo do ICMS CodSer Cdigo do item de servio da nota fiscal de entrada VlrCtb Valor contbil do item da nota fiscal CtaRed Conta contbil reduzida FilNfv Cdigo da filial da nota fiscal de sada NumNfv Nmero da nota fiscal de sada SnfNfv Srie da nota fiscal de sada SeqIpv Seqncia do item da nota fiscal de sada VlrDac Valor das despesas acessrias (embalagem, encargos, outras despesas) CodTst Cdigo do ICMS substitudo PerIim Percentual de imposto de importao do item da nota fiscal de entrada VlrBii Valor base imposto de importao VlrIim Valor do imposto de importao do item da nota fiscal de entrada VlrRis Valor de reteno de ICMS Substituto

CodBem PesEnt DifPes BasDif NfiPro VlrBsi VlrSic PerIrf VlrBir VlrIrf PerCrt VlrBct VlrCrt PerPit VlrBpt VlrPit PerCsl VlrBcl VlrCsl PerOur VlrBor VlrOur PerIss VlrBis VlrIss PerIns VlrBin VlrIns VlrBpr VlrPir VlrBcr VlrCor CstIpi CstPis CstCof CodCcu CodCli TnsNfv NffNfv VlrDai VlrBsd VlrIsd VlrBsp VlrStp VlrBsc VlrStc VlrBfu PerFun VlrFun VlrSeg VlrFre VlrBpr VlrPir VlrBcr VlrCor VlrBie VlrIem PerPif VlrBpf VlrPif PerCff VlrBcf VlrCff CodDfs VlrAjs VlrFei VlrSei VlrOui QtdBip AliIpi QtdBpi AliPis QtdBco AliCof QtdBpf AliPif QtdBcf

Cdigo do bem Peso na entrada Diferena de peso Base de clculo de ICMS da diferena de peso Nota fiscal do produtor Valor base do ICMS substitudo Valor do ICMS substitudo Percentual do IRRF Valor Base do IRRF Valor do IRRF Percentual do COFINS Retido Valor Base do COFINS Retido Valor do COFINS Retido Percentual do PIS Retido Valor Base do PIS Retido Valor do PIS Retido Percentual da CSLL Valor Base da CSLL Valor da CSLL Percentual das Outras Retenes Valor Base da Outras Retenes Valor das Outras Retenes Percentual do ISS Valor Base do ISS Valor do ISS Percentual do INSS Valor Base do INSS Valor do INSS Valor Base do PIS a Recuperar Valor do PIS a Recuperar Valor Base do COFINS a Recuperar Valor do COFINS a Recuperar Cdigo da Situao Tributria IPI Cdigo da Situao Tributria PIS Cdigo da Situao Tributria COFINS Cdigo do centro de custo Cdigo do cliente Cdigo da transao Seqencial de lanamento da nota fiscal Diferena de alquota interestadual do ICMS Valor base do ICMS substitudo destacado Valor do ICMS substitudo destacado Valor base para clculo da substituio do PIS Valor da substituio do PIS Valor base da substituio do COFINS Valor da substituio do COFINS Valor base do Funrural Percentual do Funrural Valor do Funrural Valor do seguro Valor do frete Base de clculo do PIS a recuperar Valor do PIS a recuperar Base de clculo do COFINS a recuperar Valor do COFINS a recuperar Valor base do INSS parte empresa Valor do INSS parte empresa Percentual do PIS Faturamento Valor base do PIS Faturamento Valor do PIS Faturamento Percentual do COFINS faturamento Valor base do COFINS faturamento Valor do COFINS faturamento Cdigo do dispositivo fiscal Valor do ajuste do item referente ao dispositivo fiscal Valor de frete de importao Valor do seguro de importao Valor de outras despesas de importao Quantidade da Base do IPI Alquota por Valor do IPI Quantidade da Base do PIS a recuperar Alquota por Valor do PIS a recuperar Quantidade da Base do COFINS a recuperar Alquota por Valor do COFINS a recuperar Quantidade da Base do PIS por faturamento (Estorno devoluo) Alquota por Valor do PIS por faturamento (Estorno devoluo) Quantidade da Base do COFINS por faturamento (Estorno devoluo)

AliCff VlrSub Retorno: <SeqInc>

Alquota por Valor do COFINS por faturamento (Estorno devoluo) Valor Subsdio

2.17.4

EXCLUIR ITEM

Ao: SID.Nic.ExcluirItem (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de entrada CodTns Cdigo da transao de entrada SeqInc Seqncia de lanamento do item Retorno: "OK"

2.17.5

GRAVAR PARCELA COMPRA (INCLUIR/ALTERAR)

Ao: SID.Nic.GravarParcelaCompra (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada VctPar Data de Vencimento da Parcela da Nota Fiscal de entrada VlrPar Valor da Parcela da Nota Fiscal de entrada Parmetros Opcionais: CodPar Seqncia de parcelas da Nota Fiscal de entrada NumTit Nmero do ttulo a ser gerado no Contas a Pagar CodTpt Cdigo do tipo de ttulo a ser gerado no Contas a Pagar ObsPar Texto da observao Retorno: <CodPar>

2.17.6

EXCLUIR PARCELA COMPRA

Ao: SID.Nic.ExcluirParcelaCompra (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada CodPar Seqncia de parcelas da Nota Fiscal de entrada Retorno: OK

2.17.7

GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (INCLUIR/ALTERAR)

Ao: SID.Nic.GravarEntardaVencimentoLoteSerie (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada SeqIpc Seqncia do item da Nota Fiscal de Entrada Parmetros Opcionais: SeqDls Seqncia de movimento de item CodDep Cdigo do Depsito DatEnt Data da Entrada do Produto no depsito DatFab Data de Fabricao do lote DatVlt Data de Validade do produto no depsito CodLot Cdigo do Lote de fabricao para estocagem

NumSeq QtdEst ObsDls Retorno: <SeqDls>

Nmero de srie do produto Quantidade a ser movimentada do estoque Texto da observao

2.17.8

EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE

Ao: SID.Nic.ExcluirEntardaVencimentoLoteSerie (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada SeqIpc Seqncia do item da Nota Fiscal de Entrada SeqDls Seqncia de movimento de item Retorno: OK

2.17.9

GRAVAR LIGAO ENTRE ITENS (INCLUIR/ALTERAR)

Ao: SID.Nic.GravarLigacaoItens (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada SeqIpc Seqncia do item da Nota Fiscal de Entrada EmpRlc Empresa da Nota Fiscal relacionada FilRlc Filial da Nota Fiscal relacionada ForRlc Cdigo do Fornecedor da Nota Fiscal de entrada relacionada SnfRlc Srie da Nota Fiscal relacionada NfcRlc Nmero da Nota Fiscal de entrada relacionada Incrlc Seqncia do item de produto relacionado Parmetros Opcionais SeqLni Seqncia de ligao Retorno: <SeqLni>

2.17.10 EXCLUIR LIGAO ENTRE ITENS

Ao: SID.Nic.ExcluirLigacaoItens (CIEC) Parmetros obrigatrios: CodFor Cdigo do fornecedor da nota fiscal de entrada CodSnf Cdigo da srie da nota fiscal de entrada NumNfi Nmero inicial da nota fiscal de entrada SeqIpc Seqncia do item da Nota Fiscal de Entrada SeqLni Seqncia de ligao Retorno: OK

2.18 CONTROLADORIA TRIBUTOS NOTA FISCAL VENDA

2.18.1 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)

Ao: SID.Niv.Gravar (CIEC) Parmetros obrigatrios: CodCli Cdigo do cliente da nota fiscal de sada NumNfi Nmero inicial da nota fiscal de sada NumNff Seqencial de lanamento da nota fiscal

CodSnf CodTns CodAgf DatEmi CodAgf

Cdigo da srie da nota fiscal de sada Cdigo da transao de sada Cdigo do Agrupamento Fiscal Data de emisso da nota fiscal de sada Cdigo de agrupamento para escrita fiscal

Parmetros opcionais: NopOpe Natureza de operao de sada ObsNfv Observao lanamento de ICMS ObsIpi Observao lanamento de IPI DatSai Data da sada da nota fiscal de sada CodEdc Espcie de documento para fins fiscais VlrCtb Valor contbil da nota fiscal VlrBic Valor base do ICMS PerIcm Percentual do ICMS VlrIcm Valor do ICMS VlrOic Valor outros ICMS VlrIic Valor isento ICMS VlrBip Valor base do IPI VlrIpi Valor do IPI VlrOip Valor outros IPI VlrIip Valor isento IPI VlrBsi Valor base do ICMS Substitudo VlrSic Valor do ICMS Substitudo VlrBsd Valor base ICMS substitudo destacado VlrIsd Valor ICMS substitudo destacado VlrBis Valor base do ISS PerIss Percentual do ISS VlrIss Valor do ISS VlrBir Valor base do IRRF PerIrf Percentual do IRRF VlrIrf Valor do IRRF VlrBin Valor base do INSS PerIns Percentual do INSS VlrIns Valor do INSS CtaRed Cdigo da conta contbil CodCpg Cdigo da condio de pagamento VlrBpr Base de clculo do PIS a recuperar (estorno por devoluo) VlrPir Valor do PIS a recuperar (estorno por devoluo) VlrBcr Base de clculo do COFINS a recuperar (estorno por devoluo) VlrCor Valor do COFINS a recuperar (estorno por devoluo) VlrDsc Valor do Desconto SitNfv Situao da nota fiscal PerCrt Percentual do COFINS Retido VlrBct Valor Base do COFINS Retido VlrCrt Valor do COFINS Retido PerPit Percentual do PIS Retido VlrBpt Valor Base do PIS Retido VlrPit Valor do PIS Retido PerCsl Percentual da CSLL VlrBcl Valor Base da CSLL VlrCsl Valor da CSLL PerOur Percentual das Outras Retenes VlrBor Valor Base das Outras Retenes VlrOur Valor das Outras Retenes VlrBpf Valor Base do PIS Faturamento VlrPif Valor do PIS Faturamento VlrBcf Valor Base do COFINS Faturamento VlrCff Valor do COFINS Faturamento CodRai Cdigo da cidade para recolhimento do ISS VlrDai Valor da diferena de alquota interestadual do ICMS VlrBid Valor base IPI destacado / presumido VlrIpd Valor do IPI destacado / presumido VlrBsp Valor base da substituio do PIS VlrStp Valor da substituio do PIS VlrBsc Valor base da substituio do COFINS VlrStc Valor da substituio do COFINS VlrBfu Valor base do Funrural PerFun Percentual do Funrural VlrFun Valor do Funrural CodTri Cdigo de tributao para emisso da DARF PerIcf Percentual do ICMS sobre o frete IcmFre Valor do ICMS sobre o frete TipNfs Tipo da nota fiscal de sada VlrFre Valor do frete CifFob Indicativo se o valor do frete CIF ou FOB VlrSeg Valor do seguro

VlrDac CodCcu RemDes TipRde CgcRde InsRde EstRde MunRde CodTra CodVia PlaVei UfsVei kmtDis ForCal PreImp SelFis CodCl1 CodCl2 CodTic CodTrd VlrBii VlrIim VlrRis NumRde PesBru PesLiq DatCex NumNsu DatNsu HorNsu SisMex SomFre CodMs1 CodMs2 CodMs3 CodMs4 SeqEnt CodFpg SeqPco SeqPen EquRez DatRez CfiRez TotCid QtdBip QtdBpf QtdBcf QtdBpi QtdBco QtdEmb HorSai VlrSub Retorno: "OK"

Valor das despesas acessrias Cdigo do centro de custo Indicativo se o cliente da transportadora remetente, destinatrio ou consignatrio Indicativo do tipo de pessoa do remetente/destinatrio Nmero do CNPJ/CPF do remetente/destinatrio Inscrio estadual do remetente/destinatrio Sigla do estado do remetente/destinatrio Cidade do remetente/destinatrio Cdigo da transportadora da nota fiscal de sada Via de transporte da nota fiscal de sada Placa do veculo de transporte das mercadorias Sigla do estado do veculo de transporte das mercadorias Distncia em quilmetros a percorrer com o veculo de transporte das mercadorias Indicativo da forma de clculo do valor do frete Nmero pr-impresso no formulrio da nota fiscal Nmero do selo fiscal de segurana Cdigo do cliente 1 Cdigo do cliente 2 Cdigo do ICMS especial Cdigo de reduo de impostos Valor base de imposto de importao Valor do imposto de importao Valor de reteno de ICMS substituto Nmero do registro de exportao Peso bruto Peso lquido Data do comprovante de exportao Nmero seqencial nico Data de gerao do nmero seqencial nico Hora de gerao do nmero seqencial nico Tipo do siscomex Somar o valor do frete no valor da nota fiscal Cdigo da mensagem 1 Cdigo da mensagem 2 Cdigo da mensagem 3 Cdigo da mensagem 4 Seqncia do endereo de entrega do cliente Cdigo da forma de pagamento Seqncia do endereo do participante da coleta Seqncia do endereo do participante da entrega Cdigo do equipamento fiscal da reduo Z Data de referncia da reduo Z Nmero do cupom fiscal de referncia da reduo Z Total do Imposto CIDE Quantidade da Base do IPI Quantidade da Base do PIS por faturamento Quantidade da Base do COFINS por faturamento Quantidade da Base do PIS a recuperar (Estorno devoluo) Quantidade da Base do COFINS a recuperar (Estorno devoluo) Quantidade de embalagens da nota fiscal Hora da sada das mercadorias da nota fiscal de sada Valor Subsdio

2.18.2

GRAVAR RATEIOS DOS DADOS GERAIS

Ao: SID.Niv.GravarRateio (CIEC) Parmetros obrigatrios: CodCli Cdigo do Cliente NumNfi Nmero inicial da nota fiscal de entrada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal sada CodTns Transao CriRat Critrio utilizado para rateio Parmetros opcionais: SeqRat Seqncia do rateio DatBas Data base contbil e financeira CtaRed Conta contbil reduzida PerCta Percentual rateado para a conta VlrCta Valor rateado para a conta CodCcu Cdigo do centro de custos PerRat Percentual rateado para o centro de custos VlrRat Valor rateado para o centro de custos

ObsRat Retorno: <SeqRat>

Observao do rateio Seqncia do Rateio

2.18.3

GRAVAR ITEM (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarItem (CIEC) Parmetros obrigatrios: CodCli Cdigo do cliente da nota fiscal de sada NumNfi Nmero inicial da nota fiscal de sada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de sada CodTns Cdigo da transao de sada SeqInv* Seqncia de lanamento do item
* Opcional na incluso

Parmetros opcionais: CodPro Cdigo do produto CodDer Cdigo da derivao do produto CplPro Descrio complementar do produto ou servio CodClf Cdigo interno da classificao fiscal ClaFis Cdigo da classificao fiscal - NCM QtdEnt Quantidade de sada do produto UniMed Unidade de medida da quantidade do produto PreUni Preo unitrio do item da nota fiscal de sada VlrBic Valor base do ICMS PerIcm Percentual do ICMS VlrIcm Valor do ICMS VlrIic Valor isentas ICMS VlrOic Valor outras ICMS VlrBip Valor base do IPI PerIpi Percentual de IPI VlrIpi Valor do IPI VlrIip Valor isentas IPI VlrOip Valor outras IPI VlrBid Valor base IPI destacado/presumido (50% compra no comrcio) VlrIpd Valor do IPI destacado/presumido (50% compra no comrcio) VlrBsi Valor base do ICMS substitudo SeqIpv Seqncia do item na nota fiscal de sada VlrDsc Valor do desconto do item CodStr Situao tributria do item da nota fiscal de sada CodTrd Cdigo de reduo do ICMS CodSer Cdigo do item de servio da nota fiscal de sada VlrCtb Valor contbil do item da nota fiscal CtaRed Conta contbil reduzida FilNfc Cdigo da filial da nota fiscal de entrada CodFor Fornecedor da nota fiscal de entrada NumNfc Nmero da nota fiscal de entrada SnfNfc Cdigo da srie da nota fiscal de entrada SeqIpc Seqncia do item da nota fiscal de entrada VlrDac Valor das despesas acessrias (embalagem, encargos, outras despesas) CodTst Cdigo do ICMS substitudo PerIim Percentual do imposto de importao do item da nota fiscal de sada VlrBii Valor base imposto de importao VlrIim Valor do imposto de importao do item da nota fiscal de sada VlrRis Valor de reteno de ICMS Substituto CodBem Cdigo do bem SeqNfi Seqncia do item na nota fiscal impressa PerIrf Percentual do IRRF VlrBir Valor Base do IRRF VlrIrf Valor do IRRF PerCrt Percentual do COFINS Retido VlrBct Valor Base do COFINS Retido VlrCrt Valor do COFINS Retido PerPit Percentual do PIS Retido VlrBpt Valor Base do PIS Retido VlrPit Valor do PIS Retido PerCsl Percentual da CSLL VlrBcl Valor Base da CSLL VlrCsl Valor da CSLL PerOur Percentual das Outras Retenes VlrBor Valor Base das Outras Retenes VlrOur Valor das Outras Retenes PerIss Percentual do ISS

VlrBis VlrIss PerIns VlrBin VlrIns VlrBpr VlrPir VlrBcr VlrCor CstIpi CstPis CstCof CodCcu TnsNfc NffNfc DesImp VlrDai VlrSic VlrBsd VlrIsd VlrBsp VlrStp VlrBsc VlrStc VlrBfu PerFun VlrFun VlrFre VlrSeg VlrBpr VlrPir VlrBcr VlrCor PerPif VlrBpf VlrPif PerCff VlrBcf VlrCff NumRde CodDfs VlrAjs VlrCid TotCid QtdBip AliIpi QtdBpf AliPif QtdBcf AliCff QtdBpi AliPis QtdBco AliCof VlrSub Retorno: <SeqInv>

Valor Base do ISS Valor do ISS Percentual do INSS Valor Base do INSS Valor do INSS Valor Base do PIS a Recuperar Valor do PIS a Recuperar Valor Base do COFINS a Recuperar Valor do COFINS a Recuperar Cdigo da Situao Tributria IPI Cdigo da Situao Tributria PIS Cdigo da Situao Tributria COFINS Cdigo do centro de custo Cdigo da transao Seqencial de lanamento da nota fiscal Descrio do produto para impresso Valor da diferena de alquota interestadual do ICMS Valor do ICMS substitudo Valor base ICMS substitudo destacado Valor do ICMS substitudo destacado Valor base da substituio do PIS Valor da substituio do PIS Valor base da substituio do COFINS Valor da substituio do COFINS Valor base do Funrural Percentual do Funrural Valor do Funrural Valor do frete Valor do seguro Base de clculo do PIS a recuperar Valor do PIS a recuperar Base do clculo do COFINS a recuperar Valor do COFINS a recuperar Percentual do PIS Faturamento Valor base do PIS Faturamento Valor do PIS Faturamento Percentual do COFINS Faturamento Valor base do COFINS Faturamento Valor do COFINS Faturamento Nmero do registro de exportao Cdigo do dispositivo fiscal Valor do ajuste do item referente ao dispositivo fiscal Valor Unitrio do Imposto CIDE Total do Imposto CIDE Quantidade da Base do IPI Alquota por Valor do IPI Quantidade da Base do PIS por faturamento Alquota por Valor do PIS por faturamento Quantidade da Base do COFINS por faturamento Alquota por Valor do COFINS por faturamento Quantidade da Base do PIS a recuperar (Estorno devoluo) Alquota por Valor do PIS a recuperar (Estorno devoluo) Quantidade da Base do COFINS a recuperar (Estorno devoluo) Alquota por Valor do COFINS a recuperar (Estorno devoluo) Valor Subsdio

2.18.4

EXCLUIR ITEM

Ao: SID.Niv.ExcluirItem (CIEC) Parmetros obrigatrios: CodCli Cdigo do cliente da nota fiscal de sada NumNfi Nmero inicial da nota fiscal de sada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de sada CodTns Cdigo da transao de sada SeqInv Seqncia de lanamento do item Retorno: "OK"

2.18.5

GRAVAR CONHECIMENTO DE TRANSPORTE (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarTransporte (CIEC) Parmetros obrigatrios: CodCli Cdigo do cliente da nota fiscal de sada NumNfi Nmero inicial da nota fiscal de sada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de sada CodTns Cdigo da transao de sada DatEmi Data de emisso da Nota Fiscal transportada CodEdc Cdigo de documento da Nota Fiscal transportada CodSel Cdigo da Srie Legal da Nota Fiscal transportada NumNft Nmero da Nota fiscal transportada VlrTot Valor total da Nota Fiscal transportada QtdMer Quantidade das Mercadorias da Nota Fiscal transportada UniMed Unidade de medida das Mercadorias da Nota Fiscal transportada Parmetros Opcionais SeqCct Seqncia da composio do conhecimento de transporte CodSsl Cdigo da Sub-srie Legal da Nota Fiscal transportada ChvNel Chave de acesso da NF-e transportada VlrMer Valor total da mercadoria da Nota Fiscal transportada PesBru Peso Bruto da Nota Fiscal transportada PesLiq Peso Lquido da Nota Fiscal transportada Retorno: <SeqCct>

2.18.6

EXCLUIR CONHECIMENTO DE TRANSPORTE

Ao: SID.Niv.ExcluirTransporte (CIEC) Parmetros obrigatrios: CodCli Cdigo do cliente da nota fiscal de sada NumNfi Nmero inicial da nota fiscal de sada NumNff Seqencial de lanamento da nota fiscal CodSnf Cdigo da srie da nota fiscal de sada CodTns Cdigo da transao de sada SeqCct Seqncia da composio do conhecimento de transporte Retorno: OK

2.18.7

GRAVAR PARCELAS DE VENDA (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarParcelaVenda (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada VctPar Data de Vencimento da parcela da Nota Fiscal de sada VlrPar Valor da Parcela da Nota Fiscal de sada Parmetros Opcionais CodPar Seqncia de parcelas da Nota Fiscal NumTit Nmero do ttulo a ser gerado no Contas a Receber CodTpt Cdigo do Tipo de Ttulo a ser gerado no Contas a Receber ObsPar Texto da Observao Retorno: <CodPar>

2.18.8

EXCLUIR PARCELAS DE VENDA

Ao: SID.Niv.ExcluirParcelaVenda (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada CodPar Seqncia de parcelas da Nota Fiscal

Retorno: OK

2.18.9

GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarEntradaVencimentoLoteSerie (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada SeqIpv Seqncia do item na Nota Fiscal Parmetros Opcionais SeqDls Seqncia de Movimento de item CodDep Cdigo do Depsito DatEnt Data de Entrada do produto no depsito DatFab Data de Fabricao do lote DatVlt Data de Validade do produto no depsito CodLot Cdigo do lote de fabricao para estocagem NumSep Nmero de srie do produto QtdEst Quantidade a ser movimenta do estoque ObsDls Texto da Observao Retorno: <SeqDls>

2.18.10 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE

Ao: SID.Niv.ExcluirEntradaVencimentoLoteSerie (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada SeqIpv Seqncia do item na Nota Fiscal SeqDls Seqncia de Movimento de item Retorno: OK

2.18.11 GRAVAR LIGAO ENTRE ITENS (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarLigacaoItens (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada SeqIpv Seqncia do item na Nota Fiscal EmpRlc Empresa da Nota Fiscal de sada relacionada FilRlc Filial da Nota Fiscal de sada relacionada SnfRlc Srie da Nota Fiscal de sada relacionada NfvRlc Nmero da Nota Fiscal de sada relacionada InvRlc Seqncia do Item de produto relacionado Parmetros Opcionais SeqLni Seqncia de ligao Retorno: <SeqLni>

2.18.12 EXCLUIR LIGAO ENTRE ITENS

Ao: SID.Niv.ExcluirLigacaoItens (CIEC) Parmetros obrigatrios: CodSnf Cdigo da Srie da Nota Fiscal NumNfi Nmero inicial da nota fiscal de sada SeqIpv Seqncia do item na Nota Fiscal SeqLni Seqncia de ligao Retorno:

OK

2.18.13 GRAVAR INFORMACOES DOCUMENTO ELETRNICO (INCLUIR/ALTERAR)

Ao: SID.Niv.GravarInformacoesDocumentoEletronico (CIEC) Parmetros obrigatrios: CodEmp Cdigo empresa CodFil Cdigo filial CodSnf Srie da nota fiscal NumNfi Nmero da nota fiscal UsuEmi Usurio emissor do documento eletrnico Parmetros Opcionais SitDoe Situao do documento eletrnico SitDea Situao do documento eletrnico anterior ChvDoe Chave do documento eletrnico NumDfs Nmero da nota fiscal de servio na prefeitura CodVer Cdigo de verificao do documento eletrnico NumPrt Nmero do protocolo de autorizao do documento eletrnico DatAut Data de autorizao do documento eletrnico HorAut Hora da autorizao do documento eletrnico UsuEmi Usuario que realizou a emisso do documento eletrnico NumPrc Nmero do protocolo de cancelamento do documento eletrnico DatCan Data de autorizao para cancelamento do documento eletrnico HorCan Hora da autorizao do cancelamento do documento eletrnico UsuCan Usuario que solicitou o cancelamento do documento eletrnico NumPri Nmero do protocolo de inutilizao do documento eletrnico DatInu Data de autorizao da Inutilizao do documento eletrnico HorInu Hora da autorizao de inutilizao do documento eletrnico UsuInu Usurio que solicitou inutilizao do documento eletrnico Retorno: OK

2.18.14 EXCLUIR INFORMACOES DOCUMENTO ELETRNICO

Ao: SID.Niv.ExcluirInformacoesDocumentoEletronico (CIEC) Parmetros obrigatrios: CodEmp Cdigo empresa CodFil Cdigo filial CodSnf Srie da nota fiscal NumNfi Nmero da nota fiscal Retorno: OK

2.19 CONTROLADORIA TRIBUTOS INVENTRIO DE ESTOQUES

2.19.1 GRAVAR SALDOS FSICOS MENSAIS (INCLUIR/ALTERAR)

Ao: SID.Est.GravarInventario (CIEC) Parmetros obrigatrios: CodPro Cdigo do produto CodDep Cdigo do depsito MesAno Ms e ano correspondente as informaes (MM/YYYY) Parmetros Opcionais CodFil Cdigo da Filial CodDer Cdigo da derivao QtdEst Quantidade fsica total do estoque no depsito VlrEst Valor total em estoque no depsito QtdCfo Quantidade consignada a fornecedor VlrCfo Valor consignado a fornecedor QtdCcl Quantidade consignada a cliente VlrCcl Valor total consignado a cliente PreMed Preo mdio Retorno:

OK

2.19.2

GRAVAR SALDOS CONSIGNADOS (INCLUIR/ALTERAR)

Ao: SID.Est.GravarConsignado (CIEC) Parmetros obrigatrios: CodPro Cdigo do produto CodDep Cdigo do depsito MesAno Ms e ano correspondente as informaes Parmetros Opcionais CodDer Cdigo da derivao CodCli Cdigo do cliente com o produto consignado CodFor Cdigo do fornecedor do produto consignado QtdCfo Quantidade consignada a fornecedor VlrCfo Valor consignado a fornecedor QtdCcl Quantidade consignada a cliente VlrCcl Valor total consignado a cliente Retorno: OK

2.20 CONTROLADORIA CONTABILIDADE

2.20.1 GERAR LOTE CONTBIL

Ao: SID.Lct.GerarLote (CCCT) Parmetros obrigatrios: DatLot Data do lote TotInf Total informado para fechamento do lote Retorno: <NumLot> Nmero do lote gerado

2.20.2

EXCLUIR LOTE CONTBIL

Ao: SID.Lct.ExcluirLote (CCCT) Parmetros obrigatrios: NumLot Nmero do lote contbil Parmetros opcionais: CodEmp Cdigo da empresa OriLct* Origem do lote contbil
* Quando no informado utilizado origem "MAN"

Retorno: "OK"

2.20.3

GERAR LANAMENTO

Ao: SID.Lct.Gravar (CCCT) Parmetros obrigatrios: NumLot Nmero do lote CtaDeb* Nmero reduzido da conta de dbito CtaCre* Nmero reduzido da conta de crdito VlrLct Valor do lanamento contbil CodHpd** Cdigo do histrico padro CplLct** Descrio complementar do lanamento
* Informar CtaDeb e/ou CtaCre ** Informar CodHpd e/ou CplLct

Parmetros opcionais: DatLct Data de lanamento DatLot Data do lote DocLot Documento de controle de lanamentos CgcCpf C.N.P.J./C.P.F. CtaRed(n)* Conta contbil reduzida

CodCcu(n)* PerRat(n)* VlrRat(n)* Retorno: <NumLct>

Cdigo do centro de custo Percentual do rateio Valor do rateio

* (n) = Seqncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses.

Nmero do lanamento gerado

2.20.4

INTEGRAO CONTBIL

Ao: SID.Ctb.Integrar (CCCT) Parmetros obrigatrios: (ver Observao) Parmetros opcionais: CodFil Cdigo da filial DatIni Data inicial (sugesto) DatFin Data final (sugesto) CodAgi Agrupamento de filiais TipLot Lote dirio (0=No, 1=Sim*) TipAtu Tipo de atualizao (0=Perodo completo*, 1=Por intervalos) QtdDia Quantidade de dias IndVal Indicativo de validao (0=No*, 1=Sim) IntNfs Indicativo se integra Notas Fiscais de Saida (0=No*, 1=Sim) IntVef Indicativo se integra Faturas Vendas (0=No*, 1=Sim) IntEst Indicativo se integra Estoques (0=No*, 1=Sim) IntCre Indicativo se integra Contas a Receber (0=No*, 1=Sim) IntNfe Indicativo se integra Notas Fiscais de Entrada (0=No*, 1=Sim) IntCof Indicativo se integra Faturas Compras (0=No*, 1=Sim) IntCpa Indicativo se integra Contas a Pagar (0=No*, 1=Sim) IntCom Indicativo se integra Comisses (0=No*, 1=Sim) IntTes Indicativo se integra Tesouraria (0=No*, 1=Sim) IntPat Indicativo se integra Patrimnio (0=No*, 1=Sim) IntIve Indicativo se integra Impostos Vendas (0=No*, 1=Sim) IntIco Indicativo se integra Impostos Compras (0=No*, 1=Sim) IntIvz Indicativo se integra Impostos Reduo Z (0=No*, 1=Sim) IntPrj Indicativo se integra Projetos (0=No*, 1=Sim) IniNfs Data inicial para integrao Notas Fiscais de Sada FinNfs Data final para integrao Notas Fiscais de Sada IniVef Data inicial para integrao Faturas Vendas FinVef Data final para integrao Faturas Vendas IniEst Data inicial para integrao Estoques FinEst Data final para integrao Estoques IniCre Data inicial para integra o Contas a Receber FinCre Data final para integrao Contas a Receber IniNfe Data inicial para integrao Notas Fiscais de Entrada FinNfe Data final para integrao Notas Fiscais de Entrada IniCof Data inicial para integrao Faturas Compras FinCof Data final para integrao Faturas Compras IniCpa Data inicial para integrao Contas a Pagar FinCpa Data final para integrao Contas a Pagar IniCom Data inicial para integrao Comisses FinCom Data final para integrao Comisses IniTes Data inicial para integrao Tesouraria FinTes Data final para integrao Tesouraria IniPat Data inicial para integrao Patrimnio FinPat Data final para integrao Patrimnio IniIve Data inicial para integrao Impostos Vendas FinIve Data final para integrao Impostos Vendas IniIco Data inicial para integrao Impostos Compras FinIco Data final para integrao Impostos Compras IniIvz Data inicial para integrao Impostos Reduo Z FinIvz Data final para integrao Impostos Reduo Z IniPrj Data inicial para integrao Projetos FinPrj Data final para integrao Projetos
* = Valor padro

Retorno: <QtdLct>

Quantidade de lanamentos gerados

Observao: Os campos DatIni e DatFin so usados para sugerir um perodo para TODOS os mdulos de integrao, no havendo necessidade de informar o perodo individualmente. Neste caso, necessrio informar tambm o indicativo de integrao de cada mdulo desejado. Se o perodo de datas dos mdulos forem informados, no ser necessrio informar o indicativo de integrao do mdulo. Neste caso, no deve-se usar os campos DatIni e DatFin.

2.21 CONTROLADORIA PATRIMNIO

2.21.1 MOVIMENTAR BEM

Ao: SID.Pat.Movimentar (CPBE) Parmetros obrigatrios: CodBem Cdigo do bem CodTns Cdigo da transao CcuNov Cdigo do centro de custos de destino DatTrf Data da transferncia Parmetros opcionais: NumPla Nmero da plaqueta (caso deseja-se transferir apenas uma plaqueta de centro custos) EmpNfv Cdigo da empresa da nota fiscal de sada FilNfv Cdigo da filial da nota fiscal de sada SnfNfv Cdigo da srie da nota fiscal de sada NumNfv Nmero da nota fiscal de sada SeqIpv Seqncia do item de produto na nota fiscal de sada SeqIsv Seqncia do item de servio na nota fiscal de sada DatBai Baixa de bens LocNov Transferncia de Local Real FilNov Transferncia de Filial EspNov Transferncia de Espcie CtaNov Transferncia de Conta Contbil VlrVen Valor de venda Retorno: "OK"

2.21.2

BUSCAR DEPRECIAO DO BEM

Ao: SID.Pat.BuscarDepreciacao (CPBE) Parmetro obrigatrio: CodBem (n)* Cdigo do bem Parmetros opcionais: MulQtd(n)* Retorno vem multiplicado pela quantidade de itens (S=sim, N=no) DatCal(n)* Data do clculo da depreciao MesAnt(n)* Indicativo se para buscar depreciao do perodo anterior ao informado (S=sim, N=no) DprBem(n)*1 Indicativo se deve buscar a depreciao na tabela de bens caso no existam clculos de depreciao **
* (n) = Seqncia incremental, iniciando sempre em 1 (um) No utilizar os parnteses. ** No utilizado quando informado data do clculo "DatCal".

Retorno: XML contendo o cdigo do bem, depreciao mensal, depreciao acumulada e retorno. Quando no possuir clculo de depreciao 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>

2.22 MANUFATURA ORDEM DE PRODUO

2.22.1 APONTAR ORDENS DE PRODUO

Ao: SID.Prd.ApontarOps (MCAP) Parmetros obrigatrios: CodOri Cdigo da origem NumCad Cdigo do operador NumOrp Nmero da O.P. CodEtg Cdigo do estgio SeqRot Seqncia de roteiro CodEqp Cdigo do equipamento Parmetros opcionais: StrPrm String com todos os parmetros concatenados EndCol Endereo do coletor TurTrb Turno CodCre Centro de recurso DatMov Data do movimento da O.P. HorMov Hora do movimento da O.P. QtdRe1 Quantidade de 1a. qualidade QtdRe2 Quantidade de 2a. qualidade QtdRe3 Quantidade de 3a. qualidade QtdRfg Quantidade de refugo CodPro Cdigo do produto CodDer Cdigo da derivao CodLot Cdigo do lote NumSep Cdigo da srie CodMtv Cdigo do motivo de parada CodDft Cdigo do defeito de fabricao CodDep Cdigo do depsito Retorno: "OK"

2.22.2

REMETER/RETORNAR SERVIO DE TERCEIROS

Ao: SID.Prd.RemeterRetornarServico (MCRR) Parmetros obrigatrios: CodEmp Cdigo da empresa CodOri Cdigo da origem NumOrp Nmero da O.P. CodEtg Cdigo do estgio RemSer Remessa/retorno de servio (S = Remessa; N = Retorno de servio) CodFor Cdigo do fornecedor CodSer Cdigo do servio Parmetros opcionais: SeqRot Seqncia de roteiro CodPro Cdigo do produto DatGer Data de gerao do registro HorGer Hora de gerao do registro CodUsu Cdigo do usurio que gerou o registro QtdRfg Quantidade de refugo QtdRe1 Quantidade de 1a. qualidade no estgio QtdRe2 Quantidade de 2a. qualidade no estgio QtdRe3 Quantidade de 3a. qualidade no estgio Retorno: "OK"

2.22.3

BAIXAR COMPONENTES DA O.P./O.S.

Ao: SID.Prd.BaixarComponentes (MPMO) Parmetros obrigatrios: CodOri Cdigo da origem NumOrp Nmero da O.P./O.S. CodEtg Cdigo do estgio

CodCmp CodDer QtdUti

Cdigo do componente Cdigo da derivao do componente Quantidade a utilizar (quantidade a baixar)

Parmetros opcionais: SeqCmp Sequncia do componente QtdMnc Quantidade de material no-conforme QtdCdr Quantidade destinada para refugo QtdUn2 Quantidade de acordo com a segunda unidade de medida CodLot Cdigo do lote do componente NumSep Nmero de srie do componente LotDes Lote do produto da O.P./O.S. para o qual o componente foi utilizado SepDes Srie do produto da O.P./O.S. para o qual o componente foi utilizado DatMov Data do movimento Retorno: "OK" Observao: Para maiores detalhes, consultar a documentao da funo de programador BaixarComponentes na ajuda do sistema.

2.23 INTEGRAES CARTO PRESENTE

2.23.1 GRAVAR CARTO PRESENTE

Ao: SID.Int.GravarCartaoPresente (IVME) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial CarPre Cdigo do carto presente TipPro Tipo de processamento (I Incluso; A Alterao) DatVal Data de validade do carto presente DatEmi Data de emisso do carto presente VlrCar Valor do carto presente VlrInc Valor de incremento do valor do carto presente Campos obrigatrios apenas para incluso. Campos obrigatrios apenas para alterao. Retorno: "OK"

2.23.2

CONSULTAR CARTO PRESENTE

Ao: SID.Int.ConsultarCartaoPresente (IVME) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial CarPre Cdigo do carto presente Retorno: "VlrCar;VlrSal;DatVal" Legenda: VlrCar = Valor do carto presente. VlrSal = Valor do saldo do carto presente. DatVal = Data de validade do carto presente.

2.23.3

CONSUMIR CARTO PRESENTE

Ao: SID.Int.ConsumirCartaoPresente (IVME) Parmetros obrigatrios: CodEmp Cdigo da empresa CodFil Cdigo da filial CarPre Cdigo do carto presente VlrUti Valor do carto presente a ser utilizado DatRes Data do resgate do valor do carto presente Retorno:

"OK"

3 SIDXML
SIDXML o conceito atribudo forma de agrupar aes SID em texto pseudo XML e submet-las em uma nica requisio HTTP. O benefcio a possibilidade de processamento agrupado dentro de uma transao de banco, assim ocorrendo alguma falha todo o bloco de comandos SID desfeito, alm de reduzir o trfego via rede. Outra caracterstica a possibilidade de utilizar o "retorno" de aes como parmetros em outras.

3.1 SINTAXE XML

Para utiliz-lo, deve-se enviar a ao de "login" (EXESENHA) normalmente e, em seguida, enviar a ao "SID.SRV.XML" com o texto XML. O texto XML deve ser montado como abaixo: <sidxml> <sid acao='[ACAOSID]' retorno='[RETORNO]'> <param nome='[PARAMETRO]' valor='[VALOR]' /> ...demais parmetros... </sid> ...demais aes... </sidxml> Onde: [ACAOSID] [RETORNO]* [PARAMETRO] [VALOR] * Parmetro opcional Nome da ao SID que se deseja executar; Nome qualquer para uma varivel interna que armazenar o contedo do retorno da ao; Nome do parmetro SID; Valor do parmetro;

Observaes tcnicas: Para submeter o texto XML, deve-se utilizar sempre o mtodo "POST"; No h limite de quantidade de aes ou parmetros, apenas o tamanho final do texto XML (1 Mb); Para utilizar o contedo de uma varivel interna, deve-se preceder o nome da varivel um "@" no parmetro valor. Exemplo: <param nome='NUMPED' valor='@RETORNO_PEDIDO'>; Os valores dos parmetros devem sempre estar delimitados por apstrofos ('), independente do tipo de contedo; O Sapiens Server considera falha ou erro, todo retorno de ao iniciando com "ERRO:";

Parmetros do SIDXML: A passagem de parmetros para o SIDXML pode ser feita definindo o primeiro sub-elemento do SIDXML com o rtulo "param", sendo os atributos deste elemento considerados como parmetros. Os parmetros existentes, e seus possveis valores, so: a) retorno indica o formato de resultado da execuo da ao SIDXML. Possveis valores: <padro> o resultado da ao um texto simples "OK" ou "ERRO:...."; XML o resultado da ao um XML indicando o retorno individual de cada ao; b) transacao indica o modo de tratamento de transaes de banco de dados. Possveis valores: <padro> todo contedo do SIDXML processado dentro de uma transao nica, assim ocorrendo erro em alguma ao, tudo desfeito; INDIVIDUAL cada ao dentro do SIDXML processado em sua prpria transao, assim ocorrendo erro em alguma ao, somente o resultado desta ao desfeito, sendo as aes posteriores tambm processadas; Exemplo: <sidxml> <param retorno='XML' transacao='INDIVIDUAL' /> ... aes... </sidxml> Observaes: A utilizao de parmetro transacao como INDIVIDUAL torna obrigatrio a utilizao do parmetro retorno como XML. Limitaes: Por questes tcnicas internas, o XML no dever conter quebras de linha, ou seja, todo o contedo dever ser submetido numa nica linha, exemplo: <sidxml><sid acao=...><...><...></sidxml> No utilizar o cabealho padro do XML (<?xml version="1.0"?>); No utilizar caracteres como "?" e "&" no XML; No utilizar o caractere apstrofo (') no valor de um parmetro; A ao SID.SRV.EXEREL no pode ser utilizada no SIDXML;

3.2 EXEMPLO
O exemplo de XML a seguir, realiza as seguintes funes: Cadastra um novo cliente e suas definies; Gera uma nota fiscal de venda e seus itens (para este novo cliente);

Processa o fechamento da nota fiscal; Executa uma regra LSP para buscar uma informao 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='senior@senior.com.br' /> </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='senior@senior.com.br' /> <param nome='ASSUNTO' valor='Seu boleto para pagamento segue em anexo' /> <param nome='ANEXO' valor='@RET_ARQUIVO' /> </sid> </sidxml> Abaixo um exemplo demonstrando como montar um XML dentro de regras LSP:

Definir Alfa XML; Definir Alfa URL; Definir Alfa RETORNO; ... XML = "<sidxml>"; XML = XML + "<sid acao='SID.SRV.ALTEMPFIL'>"; XML = XML + "<param nome='CODEMP' valor='2'/>"; XML = XML + "<param nome='CODFIL' valor='3'/>"; XML = XML + "</sid>"; XML = XML + "</sidxml>"; ... URL= "http://.../sapiensweb/conector.exe?SIS=CO&LOGIN=SID&ACAO=SID.SRV.XML&USER=..."; SapiensSIDEx(URL, XML, "", "", "", RETORNO);