Sapiens Sid

Sapiens SID
Guia de Referncia
Sapiens SID
Servio Interativo Dinmico
(C) Senior
Sapiens SID
(C) Senior
Julho 2013
(C) Senior
Sapiens SID
NDICE ANALTICO
1 GUIA DE REFERNCIA............................................................................................................................................4
2 AES SID...........................................................................................................................................................6
3 SIDXML.............................................................................................................................................................. 94
(C) Senior
GUIA DE REFERNCIA
Nota a respeito do Conector: A partir da verso 5.7, o 'conector.exe' utilizado somente nas instalaes em modo de
compatibilidade. Para as instalaes com o novo middleware, utiliza-se somente 'conector'.
Os exemplos citados nesse documento so baseados no novo middleware, utilizando apenas 'conector'.
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>:<porta>/<diretrio_virtual>/conector?
SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usurio>&SENUSU=<senha>
Onde:
<servidor>:<porta>
<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?
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:
SIS=CO&LOGIN=SID&USER=<usurio>&CONNECTION=<cdigo_de_conexo>&ACAO=<ao>&<parmetro>=<valor>&...
Exemplo:
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.
Observao: No so usados cookies para manter a sesso, sendo exclusivamente mantidas pelos parmetros User e
Connection, obrigatrios no corpo da ao.
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:
SIS=CO&LOGIN=SID&ACAO=EXESENHA&NOMUSU=<usurio>&SENUSU=<senha>&PROXACAO=<ao_a_executar_aps_login
>&<parmetro>=<valor>&...
Exemplo:
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.Param = "NUMTIT=TX003/A";
vAcaoSID.SID.Param = "CODTPT=DM";
vAcaoSID.SID.Param = "VLRMOV=7700";
vAcaoSID.SID.Param = "VCTORI=20/10/2005";
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:
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 ".".
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.
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.
22222
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).
22222
EXECUTAR REGRA INTERNA (REGRAS LSP)

Ao:
SID.Srv.Regra
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".
22222
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")
Observao: Esta ao no compatvel com chamada via Web Service (com.senior.g5.co.ger.sid).
22222
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)
CaminhoArq
Caminho onde ser gerado o bloqueto (imagem ou pdf). Deve ser utilizado apenas quando se
utiliza a ao SID via WebService.
Retorno:
"OK"
Ou
"<caminho>"
Ou
"<caminho>"
22222
(caso seja informado o parmetro "Impressora=...")

(caso seja informado o parmetro "Formato=JPEG")
(caso seja informado o parmetro "Formato=PDF")
IMPRIMIR NOTAS FISCAIS DE SADA

Ao:
SID.Srv.ExeNfs (RFNF)
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
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.
22222
OBTER INFORMAES DA CONEXO ATUAL (USO INTERNO)

Ao:
SID.Srv.Status
Retorno:
Informaes referentes conexo ativa uso interno
22222
ENCERRAR CONEXO ATUAL (SOMENTE SE INVOCADO VIA HTTP)

Ao:
LogOff
Retorno:
"OK"
2.2 MERCADO PEDIDO DE VENDAS

22222
GRAVAR CABECALHO PEDIDO (INCLUIR/ALTERAR)

Ao:
SID.Ped.Gravar (RVPE)
CodCli
Cdigo do cliente
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
Sequncia do endereo de entrega do cliente
SeqCob
Sequncia do endereo de cobrana do cliente
SeqCto
Sequncia 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
Sequncia 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
PerDs3
PerDs4
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
FatPed
Indicativo de como o pedido deve ser faturado (0 Sapiens; 1 ECF)
Retorno:
<NumPed>
Nmero do pedido gerado
Observao:
Esta ao aceita campos de usurio.
22222
GRAVAR CABECALHO PEDIDO PREVISO (INCLUIR/ALTERAR)

Ao:
SID.Ped.GravarPrevisao (RVPE)
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:
22222
GRAVAR ITEM DE PRODUTO (INCLUIR/ALTERAR)

Ao:
SID.Ped.GravarProduto (RVPE)
NumPed
Nmero do pedido
SeqIpd
Sequncia 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
TnsPro
UniVen*
Unidade de medida de venda
QtdVen*
Quantidade de medida de venda
PreVen*
Preo de venda
PedCli
SeqPcl
Sequncia 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
NumPrj
Nmero do projeto
CodFpj
Cdigo da fase do projeto
CtaFin(n)*
Conta financeira
CtaRed(n)*
Conta contbil reduzida
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
VlrDsc
NumPrj(n)*
CodFpj(n)*
ObsRat(n)*
Percentual do rateio da conta*

Valor do rateio da conta*
Percentual do rateio*
Valor do rateio*
Valor do desconto
Nmero interno do projeto
Observao do rateio
Retorno:
<SeqIpd>
Sequncia do item
* (n) = Sequncia 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.
Observao:
22222
GRAVAR ITEM DE PRODUTO PREVISO (INCLUIR/ALTERAR)

Ao:
SID.Ped.GravarProdutoPrevisao (RVPE)
NumPed
Nmero do pedido
SeqIpd
CodPro
Cdigo do produto
CodDer
Cdigo da derivao
QtdPed
TnsPro
UniVen*
QtdVen*
Quantidade de medida de venda
PedCli
SeqPcl
CplIpd
CodDep
Cdigo do depsito
QtdCan
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>
Sequncia do item
Observao:
22222
GRAVAR ITEM DE SERVIO (INCLUIR/ALTERAR)

Ao:
SID.Ped.GravarServico (RVPE)
NumPed
Nmero do pedido
SeqIsp
CodSer
Cdigo do servio
QtdPed
Quantidade do servio
CodTpr*
PreUni*
Preo unitrio
* Utilizar CodTpr ou PreUni
TnsSer
Transao para servios
PedCli
SeqPcl
CplIsp
Complemeo da descrio do servio
QtdCan
DatEnt
Data da entrega
PerDsc
PerCom
Percentual de comisso
SitIsp
Situao do item
CodCcu
CtaRed
PerIpi
PerIcm
PerIss
PerIns
PerIrf
PerCff
PerPif
PerCrt
PerPit
PerCsl
NumPrj
CodFpj
CtaFin(n)*
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
NumPrj(n)*
CodFpj(n)*
ObsRat(n)*

Percentual de IPI
Percentual de ICMS
Percentual de ISS
Percentual de INSS
Percentual de IRRF
Percentual de COFINS
Percentual de PIS
Percentual de COFINS Retido
Nmero do projeto
Conta financeira**
Conta contbil reduzida**
Percentual do rateio da conta***
Valor do rateio da conta***
Percentual do rateio***
Valor do rateio***
Observao do rateio
Retorno:
<SeqIsp>
Sequncia do item
** Depende da parametrizao.
*** Informar apenas o percentual ou valor.
Observao:
22222
FECHAR PEDIDO
Ao:
SID.Ped.Fechar (RVPE)
NumPed
Nmero do pedido
RecPed
Recalcular o pedido (0=No*, 1=Sim-buscando valores, 2=Sim-sem buscar valores)
* Valor padro
Retorno:
"OK"
22222
FECHAR PEDIDO PREVISO

Ao:
SID.Ped.FecharPrevisao (RVPE)
NumPed
Nmero do pedido
Retorno:
"OK"
22222
EXCLUIR PEDIDO
Ao:
SID.Ped.Excluir (RVPE)
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.
22222
EXCLUIR PEDIDO PREVISO

Ao:
SID.Ped.ExcluirPrevisao (RVPE)
NumPed
Nmero do pedido
Retorno:
"OK"
222222 EXCLUIR ITEM DE PRODUTO

Ao:
SID.Ped.ExcluirProduto (RVPE)
NumPed
Nmero do pedido
SeqIpd
Sequncia do item de produto do pedido
PedCli
Nmero do Pedido do cliente
Retorno:
"OK"
Observaes:
222222 EXCLUIR ITEM DE PRODUTO PREVISO

Ao:
SID.Ped.ExcluirProdutoPrevisao (RVPE)
NumPed
Nmero do pedido
SeqIpd
Sequncia do item de produto do pedido
Retorno:
"OK"
222222 EXCLUIR ITEM DE SERVIO

Ao:
SID.Ped.ExcluirServico (RVPE)
NumPed
Nmero do pedido
SeqIsp
Sequncia do item de servio do pedido
PedCli
Nmero do Pedido do cliente
Retorno:
"OK"
Observaes:
222222 GRAVAR OBSERVAO (INCLUIR/ALTERAR)

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

Ao:
SID.Ped.ExcluirObservacao (RVPE)
NumPed
Nmero do pedido
SeqObs
Retorno:
"OK"
222222 LISTAR EMBALAGENS DO PEDIDO

Ao:
SID.Ped.ListarEmbalagens (RVPE)
NumPed
Nmero do pedido
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>
222222 CONFIRMAR CONFERNCIA DA EMBALAGEM

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

Ao:
SID.Ped.SubstituirEmb (RVPE)
NumPed
Nmero do pedido
EmbOri
Nmero da embalagem original
EmbSub
Nmero da embalagem substituta
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
Retorno:
"OK"
222222 ANALISAR ESTOQUE DE EMBALAGENS

Ao:
SID.Ped.AnalisarEstoqueEmb (RVPE)
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
Data de entrega final
AceBlo
Aceita Pedido Bloqueado (S ou N (padro da rotina))
Retorno:
"OK"
222222 ANALISAR OBSERVAO DE BLOQUEIO POR REA

Ao:
SID.Ped.AnalisarObsBloArea (RVPE)
NumPed
Nmero do pedido bloqueado
SeqObs
Sequncia 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
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
Retorno:
"OK"
222222 GRAVAR PEDIDO VIA CONTRATO DE LICITAO

Ao
SID.Ped. GravarPedidoContrato (RVPE)
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 Sequncia de pedidos a serem importados. Indicam que dentro dos mesmos existe uma Sequncia 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 Sequncia 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
Sequncia de campos e valores do item do pedido a importar. Esses delimitadores so obrigatrios na estrutura e devem ser
internos aos delimitadores <itens></itens>.
pedido.
Os delimitadores abaixo devem estar dentro dos delimitadores <item></item> e se referem aos campos dos itens do
<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 Sequncia de pedidos, ordenados
numericamente pela Sequncia 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= 'Sequncia_do_pedido' [item='Sequncia_do_item'] resultado='erro ou sucesso'>texto do
erro
ou nmero do pedido</pedido>
.
.
.
(demais pedidos)
</retorno>
O formato do retorno para um determinado pedido com erro durante a importao :

<pedido pedido= 'Sequncia_do_pedido' [item='Sequncia_do_item'] resultado='erro'>texto_do_erro</pedido>
onde
'Sequncia_do_pedido' o nmero de Sequncia em que foi processado o pedido delimitado pelos delimitadores
<pedido></pedido>
'Sequncia_do_item' o nmero de Sequncia do item que est sendo processado dentro do pedido, caso o erro
tenha ocorrido em um item delimitado pelos delimitadores <itens></itens>. A Sequncia 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= 'Sequncia_do_pedido' resultado='sucesso'>numero pedido gerado = 'nmero_pedido_sapiens'
</pedido>
onde
'Sequncia_do_pedido' tambm o nmero de Sequncia em que foi processado o pedido delimitado pelos
delimitadores <pedido></pedido>
'nmero_pedido_sapiens' o nmero do pedido gerado pelo Sapiens
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 Sequncia. 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 Sequncia 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>
<codpro></codpro>
<datent></datent>
<qtdped>2</qtdped>
</item>
<item>
<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>
222222 GRAVAR PEDIDO EM GRADE

Ao
SID.Ped. GravarPedidoGrade (RVPE)
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>
<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 Sequncia de pedidos a serem importados. Indicam que dentro dos mesmos existe uma Sequncia 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 Sequncia 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 Sequncia 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 Sequncia 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 Sequncia 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
Sequncia 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:
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 Sequncia de observaes a serem importadas para o pedido. Devem estar dentro dos delimitadores
<pedido></pedido>. Indicam que dentro dos mesmos existe uma Sequncia de observaes a serem importados. Esses
delimitadores no so obrigatrios na estrutura. ignorada se no existirem as Sequncias 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 Sequncia de pedidos, ordenados
numericamente pela Sequncia 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 :
erro
<retorno>
<pedido pedido= 'Sequncia_do_pedido' [item='Sequncia_do_item'] resultado='erro ou sucesso'>texto do
ou nmero do pedido</pedido>
.
.
.
.
(demais pedidos)
O formato do retorno para um determinado pedido com erro durante a importao :

<pedido pedido= 'Sequncia_do_pedido' [item='Sequncia_do_item'] resultado='erro'>texto_do_erro</pedido>
onde
'Sequncia_do_pedido'
o nmero de Sequncia em que foi processado o pedido delimitado pelos delimitadores

<pedido></pedido>
'Sequncia_do_item'
o nmero de Sequncia do item grade que est sendo processado dentro do pedido, caso o erro tenha
ocorrido em um item delimitado pelos delimitadores <itens></itens>. A Sequncia 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= 'Sequncia_do_pedido' resultado='sucesso'>situao = 'fechado ou no fechado' [motivo =
'motivo do erro no fechamento'] nmero pedido gerado = 'nmero_pedido_sapiens' </pedido>
onde
'Sequncia_do_pedido'
o nmero de Sequncia 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 = 'Sequncia_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='Sequncia_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 = 'Sequncia_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 = 'Sequncia_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 = 'Sequncia_do_pedido' resultado = 'sucesso no pedido, com erros na gravao dos itens'>
<mensagem> <itens> <item item= 'Sequncia_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 = 'Sequncia_do_pedido' resultado = 'erro no pedido, com erros na gravao dos itens'>
<mensagem> texto_do_erro_do_pedido </mensagem> <itens> <item item= 'Sequncia_do_item_do_pedido'>
texto_do_erro_do_item </item> </itens> </pedido>
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 Sequncia. 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
Sequncia 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>
</derivacoes>
</item>
<item>

<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>
<derivacoes>
</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>
222222 CANCELAR PEDIDO

Ao:
SID.Ped.Cancelar (RVPE)
NumPed
Nmero do pedido
NumDav
Nmero do DAV
Retorno:
"OK"
Observaes:
necessrio informar apenas um parmetro, porm possvel informar os dois.
222222 REGISTRAR IMPRESSO DAV/DAV-OS

Ao:
SID.Ped.RegistrarImpressaoPedido (RVPE)
CodEmp
Cdigo da Empresa
CodFil
Cdigo da Filial
NumPed
Nmero do DAV
TipDav
Tipos de Venda (1 = DAV, 2 = Pr-Venda, 3 = DAV-OS, 4 = ERP)
Retorno:
"OK"
Observaes:
No ser registrada a gravao de impresso do pedido cajo este j tenha sido impresso.
2.3 SUPRIMENTOS COTAES

22222
GRAVAR COTAO
Ao:
SID.Cot.Gravar (SCCP)
NumSol
Nmero da solicitao
SeqSol
Sequncia da solicitao
CodFor
Cdigo do fornecedor
QtdCot
Quantidade cotada
PreCot
Preo da cotao
PrzEnt
Prazo de entrega
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 Sequncia da cotao gerada)
2.4 MERCADO NOTA FISCAL VENDA

22222
GRAVAR CABEALHO DA NOTA FISCAL VENDA (INCLUIR)

Ao:
SID.Nfv.Gravar (RFNF)
CodSnf
Srie da nota fiscal
CodCli
Cdigo do cliente
TnsPro
Transao da nota para produtos
TnsSer
Transao da nota para servios
NumNfv
TipNfs
Tipo da nota fiscal de sada
CodCpg
CodEdc
Espcie de documento
DatEmi
Data de emisso
DatSai
Data de sada
CodFpg
CodRep
CodTra
CodEmb
QtdEmb
PesBru
PesLiq
PerDs1
PerDs2
PerDs3
PerDs4
PerEnc
PerFre
ObsNfv
VlrDar
PrcNfv
PreImp
PlaVei
TraMtr
CodMtr
PerDs1
PerDs2
PerDs3
PerDs4
PerDs5
VlrPar(n)*
VctPar(n)*
GerBai(n)*
TnsBai(n)*
Cdigo da embalagem
Quantidade de embalagens
Peso bruto
Peso lquido
Percentual de desconto-1
Percentual de encargos
Percentual do frete
Observao da nota
Valor de arredondamento (- desconto, + acrscimo)
Procedncia da nota
Nmero pr-impresso do formulrio da nota fiscal
Placa do veculo da nota fiscal
Transportadora do motorista
Cdigo do motorista
Valor da parcela a ser gerada**
Data de vencimento da parcela**
Indica se liquida o ttulo imediatamente aps sua gerao (S=sim, N=no)
Transao utilizada para baixar o ttulo
Retorno:
<NumNfv>
* (n) = Sequncia 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.
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.
22222
FECHAR NOTA FISCAL VENDA

Ao:
SID.Nfv.Fechar (RFNF)
NumNfv
Nmero da nota fiscal (no utilizar para fechamento agrupado)
CodSnf
Srie da nota fiscal
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
Indicativo para buscar valores (0=no, 1=sim*)
GerNfe
Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim, 2=Somente gera o
arquivo eletrnico)
MsgBlo
Indicativo se deve exibir o motivo do bloqueio no retorno
(0=no*, 1=sim)
* Valor padro
Retorno:
"OK"
22222
CANCELAR NOTA FISCAL VENDA

Ao:
SID.Nfv.Cancelar (RFNF)
NumNfv
CodSnf
Srie da nota fiscal
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.
22222
RECALCULAR PARCELAS (BASEADO NA COND. PGTO.)

Ao:
SID.Nfv.RecalcularParcelas (RFNF)
NumNfv
CodSnf
Srie da nota fiscal
Retorno:
"OK"
22222
GRAVAR ITEM DE PRODUTO NA NOTA FISCAL VENDA (INCLUIR)

Ao:
SID.Nfv.GravarProduto (RFNF)
NumNfv
CodSnf
Srie da nota fiscal
SeqIpv
Sequncia do item
CodPro
Cdigo do produto
CodDer
Cdigo da derivao (quando existir)
QtdFat
Quantidade faturada
PreUni
Preo unitrio
TnsPro
Transao dos itens
NopPro
Natureza da operao
CplIpv
Complemento da descrio
CodTpr
PesBru
Peso bruto
PesLiq
Peso lquido
FilPed
Filial do pedido
NumPed
Nmero do pedido
SeqIpd
Sequncia do pedido
PreBas
Preo base
PerDsc
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
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
SeqIpc
Sequncia do item de produto da NF de entrada
PerDs1
PerDs2
PerDs3
PerDs4
PerDs5
VlrDs1
Valor do desconto 1 do cliente
VlrDs2
VlrDs3
VlrDs4
VlrDs5
MntIcm
Parmetro que indica se o percentual de ICMS que foi passado na ao SID deve ser mantido
CodStr
Cdigo da situao tributria
Retorno:
"OK"
Observao:
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.
22222
GRAVAR ITEM DE SERVIO NA NOTA FISCAL VENDA (INCLUIR)

Ao:
SID.Nfv.GravarServico (RFNF)
NumNfv
CodSnf
Srie da nota fiscal
SeqIsv
Sequncia do item
CodSer
Cdigo do servio
QtdFat
Quantidade faturada
PreUni
Preo unitrio
TnsSer
Transao dos itens
NopSer
Natureza da operao
CplIsv
Complemento da descrio do servio
CodTpr
FilPed
Filial do pedido
NumPed
Nmero do pedido
SeqIsp
Sequncia do pedido
PerDsc
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
Sequncia 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
CtaFin
Conta financeira
CtaRed
Conta contbil
CodCcu
Centro de custos
FilNfc
Filial da nota fiscal de entrada
CodFor
Cdigo do fornecedor
NumNfc
SnfNfc
SeqIsc
Sequncia do item de servio da NF de entrada
QtdDev
Soma das quantidades devolvidas da NF de entrada
VlrDar
Valor de arredondamento (- desconto, +acrscimo)
PerDs1
PerDs2
PerDs3
PerDs4
PerDs5
VlrDs1
VlrDs2
VlrDs3
VlrDs4
VlrDs5
Retorno:
"OK"
Observao:
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.
22222
CANCELAR FATURA
Ao:
SID.Nfv.CancelarFatura (RFNF)
NumNff
Nmero da fatura a ser cancelada
Retorno:
"OK"
22222
LISTAR EMBALAGENS DA NFV PARA CONTROLE DE EMBARQUE

Ao:
SID.Nfv.ListarEmbCtrlEbq (RFNF)
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
CodSnf
Cdigo da srie da nota fiscal
NumNfv
NumEbq
Nmero do embarque
CodTra
Retorno:
Xml contendo o nmero do embarque e as embalagens da nota, conforme exemplo:
<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.
22222
COMPOR O DOCUMENTO DE EMBARQUE COM A NFV

Ao:
SID.Nfv.ComporCtrlEbq (RFNF)
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
CodSnf
Cdigo da srie da nota fiscal
NumNfv
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.
222222 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,
16 Autorizao em 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 (Carta de correo NFe e Cte):
SeqEve
Sequncia do evento da carta de correo eletrnica.
Parmetros obrigatrios para MD-e:
TipDoe
Tipo do evento de Manifestao do Destinatrio.**
ChvNov
DesMot[x] onde x a
TipDoe
TipCtg
ChvCtg
Retorno:
"OK"
Nova chave de acesso da nota fiscal eletrnica.

Sequncia da observao. Exemplo: DesMot1, DesMot2, Desmot3...
Tipo do Documento.**
Tipo de Contingncia (1 = DPEC, 2 = EPEC, 3 = SCAN, 4 = SVC, 5 = FS-IA, 6 = FS-DA).***
Chave de Contingncia.
Observao:
1 - Campos obrigatrios de um retorno de NF-e autorizada, cancelada, denegada ou inutilizada.
2 - 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.
Quando a situao do documento for 7- Solicitado Cancelamento e o SitNel informado for 3- Autorizado o sistema ir
alterar internamente esse valor para 9- Cancelada por motivo de compatibilidade com o evento de cancelamento.
**TipDoe pode ser 5 Evento de Cancelamento, 6 Cincia da Operao, 7 Confirmao da Operao, 8 Operao no
Realizada ou 9 Manifesto Eletrnico de Documentos Fiscais.
*** TipCtg de preenchimento obrigatrio quando for autorizao em contingncia (SitNel = 16 Autorizao em
Contingncia).
3 - ChvCtg de preenchimento obrigatrio quando for autorizao em contingncia (SitNel = 16 Autorizao em
Contingncia) e o TipCtg for igual a 5 FS-IA ou 6 FS-DA.
O uso desta ao SID exclusivo para clientes que possuem a integrao IENF (Nota Fiscal Eletrnica) ativada em sua
proprietria.
4 - Para que seja feito o retorno de uma contingncia via ao SID necessrio que seja informado a Chave da
Contingncia(ChvCtg) e o Tipo de Contingncia(|TipCtg) pois quando esses campos so informados utilizado o webservice
de Importao de Retorno verso 4. Quando esses campos no so informados o sistema utiliza a verso 2.
No retorno da CC-e s podero ser informadas as situaes: 3- Autorizada, 4 Rejeitada , 5 Denegada e 10=Erro
Gerao.
Ao informar SeqEve assume-se que a solicitao se trata de uma CC-e.
Retornos esperados na nota fiscal eletrnica.
Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
5 = Denegada
2 = Enviada
10 = Erro Gerao
6 = Solicitado
Inutilizao
6 = Solicitado
Inutilizao
8 = Inutilizada
12 = Erro Solicitao
Inutilizao
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 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.
7 = Solicitado
Cancelamento
9 = Cancelada
7 = Solicitado
Cancelamento
11 = Erro Solicitao
Cancelamento
No haver mensagem de retorno. A situao do documento ser atualizada conforme

retorno do evento de cancelamento:
Evento retorno 3(autorizado) atualiza NFe com 9(cancelada)
Evento retorno 4 ou 11(rejeitado,erro gerao) atualiza NFe com 11(erro solicitao
cancelamento).
Retornos esperados na Carta de Correo eletrnica.

Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
5 = Denegada
2 = Enviada
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.
Retornos esperados no Evento de Cancelamento.

Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
2 = Enviada
3 = Autorizada
4 = Rejeitada
2 = Enviada
10 = Erro de gerao
Documento aguardando evento de cancelamento. Somente so vlidos os retornos de

autorizado(3), rejeitado(4) ou erro de gerao(10). Foi informada a situao do evento
de cancelamento como = X.
Retornos esperados na Manifestao do Destinatrio.

Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
10 = Erro gerao

Manifestao do Destinatrio aguardando autorizao. Somente so vlidos os retornos
de autorizado(3), rejeitado(4) ou erro de gerao(10). Foi informada a situao da
manifestao do destinatrio como = X
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. ".
222222 ATUALIZAO DA SITUAO DO CT ELETRNICO

Ao:
SID.Nfv.AtualizarCTE (RFNF)
ChvNel
Nmero da chave de acesso do conhecimento de transporte eletrnico.
SitNel
Inutilizao, 7=Solicitado Cancelamento, 8=Inutilizada, 9=Cancelada, 10=Erro Gerao, 11-Erro
Solicitao Cancelamento, 12-Erro Solicitao Inutilizao, 13-Impresso em Modo Contingncia,
16 Autorizao em 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.
ChvNov
DesMot[x] onde x a
TipDoe
TipCtg
ChvCtg
sequncia da observao. Exemplo: DesMot1, DesMot2, Desmot3...

Tipo de Documento ser utilizado no CTE a partir da verso 5.8.3.1.**
Tipo de Contingncia (1 = DPEC, 2 = EPEC, 3 = SCAN, 4 = SVC, 5 = FS-IA, 6 = FS-DA).***
Chave de Contingncia.
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.
** TipDoe pode ser 5 Evento de Cancelamento
*** TipCtg de preenchimento obrigatrio quando for autorizao em contingncia (SitNel = 16 Autorizao em
Contingncia).
ChvCtg de preenchimento obrigatrio quando for autorizao em contingncia (SitNel = 16 Autorizao em
Contingncia) e o TipCtg for igual a 6 FS-DA.
O uso desta ao SID exclusivo para clientes que possuem a integrao ICTE (Conhecimento de Transporte Eletrnico)
ativada em sua proprietria.
O retorno da CC-e feito atravs da ao SID.Nfv.AtualizarNFE.
Retornos esperados no Conhecimento de Transporte Eletrnico.
Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
5 = Denegada
2 = Enviada
10 = Erro Gerao
6 = Solicitado
Inutilizao
6 = Solicitado
Inutilizao
7 = Solicitado
Cancelamento
7 = Solicitado
Cancelamento
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
Documento aguardando cancelamento. Somente so vlidos os retornos de documento
eletrnico cancelado(9), erro na solicitao de cancelamento(11). Foi informado a
Retornos esperados no Evento de Cancelamento. A partir verso 5.8.3.1

Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
10 = Erro de gerao
Documento aguardando evento de cancelamento. Somente so vlidos os retornos de

autorizado(3), rejeitado(4) ou erro de gerao(10). Foi informada a situao do evento
de cancelamento = X.
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. ".
222222 ATUALIZAO DA SITUAO DA NFS ELETRNICA

Ao:
SID.Nfv.AtualizarNFSE (RFNF)
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 obrigatrios para retorno pela chave de acesso:
ChvNel
Nmero da chave de acesso do conhecimento de transporte eletrnico.
SitNel
Cancelamento9=Cancelada, 10=Erro Gerao, 11-Erro Solicitao Cancelamento).
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.
Para que seja atualizado pela chave de acesso basta informar os parmetros ChvNel e SitNel alm dos campos obrigatrios
do processo.
Retornos esperados na nota fiscal eletrnica de servio.
Situao do
documento no
Sapiens
Retorno esperado
2 = Enviada
3 = Autorizada
2 = Enviada
4 = Rejeitada
2 = Enviada
10 = Erro Gerao
7 = Solicitado
Cancelamento
7 = Solicitado
Cancelamento
9 = Cancelada
11 = Erro Solicitao
Cancelamento

Documento aguardando cancelamento. Somente so vlidos os retornos de documento
eletrnico cancelado(9), erro na solicitao de cancelamento(11). Foi informado a
222222 FECHAR CONTROLE DE EMBARQUE

Ao:
SID.Nfv.FecharCtrlEbq (RFNF)
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.
SUPRIMENTOS NOTA FISCAL COMPRA
222222 GRAVAR CABEALHO DA NOTA FISCAL COMPRA (INCLUIR)

Ao:
SID.Nfc.Gravar (SRNF)
CodFor
Cdigo do fornecedor da nota fiscal de entrada
NumNfc
CodSnf
TnsPro*
Transao da NF entrada para produtos
TnsSer*
Transao da NF entrada para servios
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
CodTra
Cdigo da transportadora da nota fiscal de entrada
CodRed
Cdigo da transportadora de redespacho da nota fiscal de entrada
QtdEmb
Quantidade de embalagens da nota fiscal
CodEmb
Cdigo da embalagem
NumEmb
Numerao das embalagens da nota fiscal
ObsNfc
Texto da observao
PesBru
Peso bruto da nota fiscal de entrada
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
CodSel
CodSsl
ChvNel
DatParSid
VlrBic
VlrIbs
VlrIcm
VlrIsn
VlrSeg
VlrEmb
VlrEnc
VlrOut
VlrFrd
VlrOud
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 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
Cdigo da srie legal da nota fiscal de entrada
Cdigo da subsrie legal da nota fiscal de entrada
Chave de acesso da nota fiscal eletrnica
Indica se deve gerar as parcelas pela data de emisso (0=no, 1=sim*). *Padro
Valor base do ICMS
Valor base do ICMS Simples Nacional
Valor do ICMS da nota fiscal de entrada
Valor do ICMS Simples Nacional da nota fiscal de entrada
Valor do seguro
Valor embalagem
Valor encargos financeiros
Valor outras despesas
Retorno:
<NumNfc>
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.
* Valor financeiro dos dados gerais da nota fiscal de entrada (VlrFin) ser sempre o somatrio do (VlrFin) dos itens de
produto / servio, portanto no h necessidade de aliment-lo na ao SID dos dados gerais. Por uma questo de compatibilidade o
campo ser mantido no layout. O seu zeramento ocorre internamente para que o somatrio ocorra durante a insero dos itens.
* Aceita campos de usurio.
* Os valores diversos (exemplo: Frete, Arredondamento, Encargos e etc) devem ser informados nos dados gerais da nota.
A distribuio para os itens se d no fechamento da nota fiscal de entrada (para os processos SID e Webservice), na digitao
ocorre conforme a insero dos itens pelo usurio. As informaes destes valores nos itens tambm possvel (a ao SID produto
e servio permitem), porm a soma dos valores atribudos aos itens deve bater com o valor informado nos dados gerais, do
contrrio haver uma redistribuio baseada no valor informado nos dados gerais. Independente de reclculo da nota (RecNot).
222222 GRAVAR ITEM DE PRODUTO NA NOTA FISCAL COMPRA (INCLUIR)

Ao:
SID.Nfc.GravarProduto (SRNF)
CodFor
NumNfc
CodSnf
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
SeqIpc
Sequncia 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
OriMer
Origem fiscal da mercadoria
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
Cdigo da unidade de medida da nota fiscal de entrada
QtdAjb
Quantidade de Ajuste de Balana para Efeito de Estoque
QtdDev
Quantidade devolvida do item da nota fiscal de entrada
UniMed
Unidade de medida de estoque do item da nota fiscal de entrada
QtdEst
Quantidade de entrada conforme unidade de medida de estoque
VlrFum
Valor do frete por unidade de medida quando CIF
QtdFre
Quantidade base na unidade do produto valida para o valor do frete
ForFre
Cdigo do fornecedor para gerao ttulo de frete
PesBru
Peso bruto do item da nota fiscal de entrada
PesLiq
Peso lquido do item da nota fiscal de entrada
PreEst
Preo do item conforme unidade de medida de estoque
PreBas
Preo unitrio base para o movimento de estoque
PerDsc
Percentual de desconto do item da nota fiscal de entrada
PerDs3
Percentual de desconto 3
PerDs4
PerDs5
PerIpi
Percentual de IPI do item da nota fiscal de entrada
PerIcm
Percentual do ICMS do item da nota fiscal de entrada
PerIsn
Percentual do ICMS Simples Nacional do item da nota fiscal de entrada
PecIcm
Percentual de ICMS creditado efetivamente
PerFun
Percentual do Funrural ou INSS
NumPrj
Nmero do projeto
CodFpj
CtaFin
Conta financeira reduzida
CtaRed
CodCcu
VlrFre
Valor frete
VlrSeg
Valor do seguro
VlrEmb
Valor embalagem
VlrEnc
VlrOut
VlrDar
Valor para arredondamento
VlrFrd
VlrOud
VlrBru
Valor bruto do item da nota fiscal de entrada
VlrDsc
Valor do desconto do item da nota fiscal de entrada
VlrDs1
Valor do desconto 1
VlrDs2
Valor do desconto 2
VlrDs3
Valor de desconto 3
VlrDs4
Valor de desconto 4
VlrDs5
Valor de desconto 5
VlrDzf
VlrBfu
Valor base do Funrural ou INSS
VlrFun
Valor do Funrural ou INSS
VlrBip
Valor base IPI
VlrIpi
Valor do IPI do item da nota fiscal de entrada
VlrBid
Valor base IPI presumido (50% compra no comrcio)
VlrIpd
Valor do IPI presumido (50% compra no comrcio)
VlrBic
Valor base do ICMS
VlrIbs
VlrIcm
Valor do ICMS do item da nota fiscal de entrada
VlrIsn
Valor do ICMS Simples Nacional do item da nota fiscal de entrada
VlrDfa
Valor da diferena de alquota inter-estadual
VlrBsi
Valor base ICMS substitudo
VlrIcs
Valor do ICMS substitudo do item da nota fiscal de entrada
VlrBsd
Valor base ICMS substitudo destacado
VlrIsd
Valor ICMS substitudo destacado
VlrBsp
Valor base da substituio tributrio do PIS
VlrStp
VlrBsc
VlrStc
VlrIip
VlrIic
VlrOip
VlrOic
VlrLpr
VlrLou
VlrLiq
VlrFin
AcrFin
EmpNfv
FilNfv
SnfNfv
NumNfv
SeqIpv
CodFab
NumEpi
VlrBpi
VlrPis
FilCtr
NumCtr
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
BasCre
DatParSid
CodFam
CodTpr
CplIpc
SalCan
QtdBpf
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
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
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
Valor base do PIS Retido
Soma dos valores do PIS retido
Percentual de Cofins Retido
Valor base do Cofins Retido
Valor do Cofins 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
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
Cdigo da base de clculo do crdito
Cdigo da famlia de produto
Indicativo se o saldo do item da O.C. dever ser cancelado
Quantidade da base do PIS por faturamento (Estorno devoluo)
QtdBcf
AliPif
AliCff
CstPis
CstCof
CstIpi
VlrImp
CoeFci
CodFci
Quantidade da base do COFINS por faturamento (Estorno devoluo)

Alquota por valor do PIS por faturamento (Estorno devoluo)
Alquota por Valor do COFINS por faturamento (Estorno devoluo)
Cdigo da situao tributria de PIS
Cdigo da situao tributria de COFINS
Cdigo da situao tributria de IPI
Valor da parcela importada do exterior
Coeficiente do contedo de importao calculado
Cdigo da ficha de contedo de importao (FCI)
Retorno:
<SeqIpc>
Sequncia do item gerado
Observao:
222222 GRAVAR ITEM DE SERVIO NA NOTA FISCAL COMPRA (INCLUIR)

Ao:
SID.Nfc.GravarServico (SRNF)
CodFor
NumNfc
CodSnf
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
SeqIsc
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
QtdRec
Quantidade recebida do servio da nota fiscal de entrada
QtdDev
Soma das quantidades devolvidas pelas NF de sada
UniMed
Unidade de medida do servio da nota fiscal de entrada
PerDsc
Percentual de desconto do servio da nota fiscal de entrada
PerIss
Percentual do ISS do servio da nota fiscal de entrada
PerIrf
Percentual do IRRF do servio da nota fiscal de entrada
PerIns
Percentual do INSS
NumPrj
Nmero do projeto
CodFpj
CtaFin
CtaRed
CodCcu
VlrEnc
VlrOut
VlrDar
VlrOud
VlrBru
Valor bruto do servio da nota fiscal de entrada
VlrDsc
Valor do desconto do servio da nota fiscal de entrada
VlrDs1
VlrDs2
VlrBis
Valor base ISS
VlrIss
Valor do ISS sobre o servio da nota fiscal de entrada
VlrBir
Valor base IRRF
VlrIrf
Valor do IRRF sobre o servio da nota fiscal de entrada
VlrBin
Valor base do INSS
VlrIns
Valor do INSS
VlrLse
Valor do servio
VlrLou
Valor dos outros valores
VlrLiq
Valor lquido do item de servio da nota fiscal de entrada
VlrFin
Valor do item vlido para o financeiro
AcrFin
Valor de Acrscimo Financeiro
EmpNfv
FilNfv
SnfNfv
NumNfv
NumEpi
CodClf
OriMer
CodStr
CodTic
CodTrd
CodTst
PerIpi
PerIcm
PerIsn
VlrDzf
VlrBip
VlrIpi
VlrBid
VlrIpd
VlrBic
VlrIbs
VlrIcm
VlrIsn
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
PerDs2
PerDs3
PerDs4
PerDs5
VlrDs3
VlrDs4
VlrDs5
BecIpi
VecIpi
BecIcm
VecIcm
PecIcm
VlrBie
VlrIem
VlrOui
BcoImp
CofImp
BpiImp
PisImp
SeqIsp
VlrBpf
PerPif
VlrPif
VlrBcf
PerCff
VlrCff
IgnOcp
RecNot

Identificador da inspeo aberta para o item
Cdigo da classificao fiscal do item da nota fiscal de entrada
Origem fiscal da mercadoria
Percentual de IPI do item da nota fiscal de entrada
Percentual do ICMS do item da nota fiscal de entrada
Percentual do ICMS Simples Nacional do item da nota fiscal de entrada
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 do ICMS Simples Nacional 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 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
Valor base do CSLL Retido
Valor do CSLL Retido
Valor base de Outras Retenes
Valor de Outras Retenes
Percentual de Outras Retenes
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 Creditado Efetivamente
Percentual de ICMS creditado efetivamente
Valor base do INSS parte empresa
Valor do INSS parte empresa
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
Ignora a carga de dados da OCP, se informada (0=no*, 1=sim). *Padro
BasCre
DatParSid
NumNfv
SeqIsv
QtdBpf
QtdBcf
AliPif
AliCff
CstPis
CstCof
CstIpi
Cdigo da base de clculo do crdito

Quantidade da base do PIS por faturamento (Estorno devoluo)
Quantidade da base do COFINS por faturamento (Estorno devoluo)
Alquota por valor do PIS por faturamento (Estorno devoluo)
Cdigo da situao tributria de PIS
Cdigo da situao tributria de COFINS
Cdigo da situao tributria de IPI
Retorno:
<SeqIsc>
Sequncia do item gerado
Observao:
222222 GRAVAR PARCELAS MANUAIS NA NOTA FISCAL DE COMPRA

Ao:
SID.Nfc.GravarParcelasManuais (SRNF)
CodFor
NumNfc
CodSnf
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
CodTpt(n)1
Cdigo do tipo do ttulo a ser gerado no conta a pagar
DatParSid
Retorno:
"OK"
Observaes:
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.
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.
222222 FECHAR NOTA FISCAL COMPRA

Ao:
SID.Nfc.Fechar (SRNF)
CodFor
NumNfc
CodSnf
GerNfe
Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim)
RecNot
Indicativo para recalcular nota (0=no*, 1=sim)
Observaes:
* Valor Padro
Retorno:
"OK"
222222 CANCELAR NOTA FISCAL COMPRA

Ao:
SID.Nfc.Cancelar (SRNF)
CodFor
NumNfc
CodSnf
GerNfe
Indicativo para gerar arquivo de notas fiscais eletrnicas (0=no*, 1=sim)
Observaes:
* Valor Padro
Retorno:
"OK"
222222 GERAR NOTA FISCAL VIA ORDEM DE COMPRA

Ao:
SID.Nfc.GerarNFCOrdemCompra (SRNF)
CodFor
NumNfc
CodSnf
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
ChvNel*
Retorno:
"OK"
Observaes:
* Campo somente ser obrigatrio quando no cadastro da filial F070FCP o valor do campo "Consistir chave eletrnica da nota fiscal" estiver
como "S".
222222 GRAVAR RATEIO PARA ITEM DE PRODUTO

Ao:
SID.Nfc.GravarRateioProduto (SRNF)
CodFor
NumNfc
CodSnf
SeqIpc
Sequncia do item de produto da nota fiscal de entrada
CtaFin(n)*
Conta financeira reduzida**
CtaRed(n)*
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)*
CodFpj(n)*
ObsRat(n)*
Observao do rateio
Retorno:
"OK"
Observaes:
* (n) = Sequncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses, exemplo: CtaFin1 PerCta1.
222222 GRAVAR RATEIO PARA ITEM DE SERVIO

Ao:
SID.Nfc.GravarRateioServico (SRNF)
CodFor
NumNfc
CodSnf
SeqIsc
CtaFin(n)*
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
NumPrj(n)*
CodFpj(n)*

Sequncia do item de servio da nota fiscal de entrada
Conta financeira reduzida**
Percentual do rateio para a conta***
Valor do rateio para a conta***
Percentual do rateio para o centro de custos***
Valor do rateio para o centro de custos ***
ObsRat(n)*
Observao do rateio
Retorno:
"OK"
Observaes:
* (n) = Sequncia incremental da linha do rateio, iniciando sempre em 1 (um) No utilizar os parnteses, exemplo: CtaFin1 PerCta1.
SUPRIMENTOS ORDEM DE COMPRA
222222 GRAVAR CABEALHO ORDEM DE COMPRA

Ao:
SID.Ocp.Gravar (SCOC)
CodFor
Cdigo do fornecedor da ordem de compra
CodCpg
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
VlrOud
VlrDs1
Valor de desconto 1
VlrDs2
Valor do desconto 2
VlrDs3
Valor de desconto 3
VlrDs4
Valor de desconto 4
VlrDzf
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
Indicativo se o saldo da ordem de compra dever ser cancelado
Retorno:
<NumOcp>
Observao:
Esta ao aceita campos de usurio
*O campo NumOcp dever ser informado quando se deseja gravar uma alterao. Para ordens de compra novas no deve ser informado
valor. Caso informado o nmero da nova ordem de compra na ao SID, o sistema no atualizar o controle de numerao da ordem.
222222 EXCLUIR ORDEM DE COMPRA

Ao:
SID.Ocp.Excluir (SCOC)
NumOcp
Retorno:
"OK"
222222 GRAVAR ITEM DE PRODUTO NA ORDEM DE COMPRA

Ao:
SID.Ocp.GravarProduto (SCOC)
NumOcp
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
SeqIpo
Sequncia do item de produto na ordem de compra
TnsPro
Transao do item de produto da OC
CplIpo
CodFam
Cdigo da Famlia do Produto
UniFor
Unidade de medida do produto no fornecedor
QtdFor
Quantidade da ordem de compra na unidade de medida do fornecedor
PreFor
Preo unitrio do produto na unidade de medida do 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
SitIpo
Situao do item da ordem de compra
DatEnt
Data de previso de entrega para o produto da ordem de compra
PerDsc
Percentual de desconto para o produto da ordem de compra
PerIim
Percentual de imposto de importao do item 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
VlrDsc
Valor do desconto para o produto da ordem de compra
VlrFre
Valor Frete
VlrSeg
Valor Seguro
VlrEmb
Valor embalagem
VlrEnc
VlrOut
VlrDar
CtaFin
CtaRed
CodCcu
NumPrj
Nmero do projeto
CodFpj
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
RecOrd
Retorno:
<SeqIpo>
Sequncia do item de produto na ordem de compra
Observao:
222222 GRAVAR ITEM DE SERVIO NA ORDEM DE COMPRA

Ao:
SID.Ocp.GravarServico (SCOC)
NumOcp
CodSer
QtdPed

Cdigo do servio na ordem de compra
Quantidade pedida do servio na ordem de compra
SeqIso
Sequncia do item de servio na ordem de compra
TnsSer
Transao de servio do item da OC
CplIso
Complemento da descrio do servio
CodFam
Cdigo da famlia do servio
CodTri
QtdPed
Quantidade pedida do servio da ordem de compra
UniMed
Unidade de medida do servio da ordem de compra
CodTpr
Cdigo da tabela de preo do servio
PreUni
Preo unitrio do servio da ordem de compra
PerDsc
Percentual de desconto do servio da ordem de compra
PerIss
Percentual do ISS do servio da ordem de compra
PerIrf
Percentual do IRRF do servio da ordem de compra
PerIns
Percentual do INSS
PerIpi
Percentual de IPI do servio da ordem de compra
PerIcm
Percentual de ICM do servio da ordem de compra
VlrDsc
Valor do desconto do servio da ordem de compra
VlrEnc
VlrOut
VlrDar
CtaFin
CtaRed
CodCcu
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
NumPrj
Nmero do projeto
CodFpj
RecOrd
VlrOud
Valor de outras despesas destacado
Retorno:
<SeqIso>
Sequncia do item de servio na ordem de compra
Observao:
222222 FECHAR ORDEM DE COMPRA

Ao:
SID.Ocp.Fechar (SCOC)
NumOcp
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.
222222 GERAR ORDEM DE COMPRA VIA COTAO

Ao:
SID.Ocp.GerarOCPCotacao (SCOC)
NumCot(n)*
Nmero da cotao
SeqCot(n)*
Sequncia(s) da cotao (separadas por vrgula, ex.: "101,102,103")
TnsPro
Transao de produto
TnsSer
Transao de servio
Observaes:
* (n) = ndice incremental, iniciado em 1. No utilizar os parnteses.
Retorno:
"OK"
222222
GERAR ARQUIVO DE MEIOS DE PAGAMENTO (PAF)

Ao:
SID.NFV.MEIOSDEPAGAMENTO
CodEmp
Cdigo da Empresa
CodFil
Cdigo da Filial
DatIni
Data do incio do relatrio
DatFim
Data do fim do relatrio
NomArq
Caminho e nome do arquivo
Observaes:
Exemplo: NomArq = C:\Senior\SPED\MeiPag.txt
2.5 SUPRIMENTOS ESTOQUES

22222
GERAR REQUISIO
Ao:
SID.Est.Requisitar (SERE)
CodPro
Cdigo do produto movimentado
CodDer
Cdigo da derivao do produto movimentado
QtdEme
Quantidade do documento de movimento de estoque
NumEme
Nmero do documento de entrada do movimento de estoque
SeqEme
Sequncia 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
NumPrj
Nmero do projeto
CodFpj
CtaFin
CtaRed
QtdApr
Quantidade aprovado do movimento de estoque
UsuAtd
Usurio atendente do movimento de estoque
UsuSol
Usurio responsvel pela solicitao do movimento
UsuRes
Usurio responsvel pela aplicao do produto ou servio movimentado
CcuRes
Centro de custo responsvel pela aplicao do produto ou servio
UsuRec
Usurio recebedor do produto ou servio solicitado
ObsEme
Observao da solicitao de movimento de estoque
ResEst1
Indicativo se o estoque do produto da requisio deve ser reservado(S=sim, N=no)
CodDep
Cdigo do depsito para reserva
ProSer2
Indicativo se a requisio de servio (S=Servio)
NumDoc
Nmero de documento da requisio
CodBem
Cdigo do bem
FilPed
Filial do pedido
NumPed
Nmero do pedido
SeqIpd
Sequncia do item pedido
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>
22222
Nmero e Sequncia da requisio gerada
ATENDER REQUISIO
Ao:
SID.Est.AtenderRequisicao (SERE)
NumEme
SeqEme
QtdAtd
Quantidade atendida do movimento de estoque
CodDep
Cdigo do depsito movimentado
DepTrf
Cdigo do depsito transferido (para movimentos de transferncia)
CodTns
Cdigo da transao de movimentao de estoque
CtaFin
CtaRed
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:
No processo de atendimento de requisio via Sid, no existe a possibilidade de gerar solicitao de compras
automtica.
Caso no seja informada quantidade atendida (QtdAtd=0), a requisio ser cancelada com a quantidade
aprovada.
Retorno:
"OK"
22222
EXCLUIR REQUISIO
Ao:
SID.Est.ExcluirRequisicao (SERE)
NumEme
SeqEme
Retorno:
"OK"
22222
GRAVAR RATEIO REQUISIO

Ao:
SID.Est.GravarRateioRequisicao (SERE)
NumEme
SeqEme
Ctafin(n)*
Conta financeira*
CtaRed(n)*
PerCta(n)*
VlrCta(n)*
CodCcu(n)*
VlrRat(n)*
Valor do rateio***
PerRat(n)*
NumPrj(n)*
Nmero do projeto
CodFpj(n)*
ObsRat(n)*
Observao do rateio
Observaes:
Retorno:
"OK"
22222
MOVIMENTAR ESTOQUE
Ao:
SID.Est.Movimentar (SECE)
CodPro
CodDer
CodTns
Cdigo da transao de movimento do estoque
CodDep
QtdMov
Quantidade do movimento
VlrMov*
Valor do movimento *(obrigatrio quando a transao exigir)
DatMov
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
CodCcu
Cdigo do centro de custo do usurio responsvel
DatVlt
Data de validade do produto no depsito
CtaRed
NumSep
Cdigo da srie do produto
NumPrj
Nmero do projeto
CodFpj
CtaFin
Retorno:
<SeqMov>
Sequncia do movimento
Observao:
Esta ao aceita campos de usurio;
Esta ao SID no suporta o conceito de valorizao individual de srie(E075PRO.CTRVIS).
22222
EXCLUIR MOVIMENTO DE ESTOQUE

Ao:
SID.Est.ExcluirMovimento (SECE)
CodPro
CodDer
CodDep
DatMov
SeqMov
Retorno:
"OK"
22222
LISTAR ITENS DA EMBALAGEM

Ao:
SID.Est.ListarItensEmbalagem (SECE)
CodEmp
Cdigo da empresa
NumEmb
Nmero da embalagem
Retorno:
Xml contendo os itens da embalagem, conforme exemplo:
<embalagem>
<codemp>1</codemp>
<numemb>5</numemb>
<itens>
<item>
<codpro>1101</codpro>
<codder>A</codder>
<codbar>78912340000111</codbar>
<qtdpro>3</qtdpro>
</item>
<item>
<codder>B</codder>
<codbar>78912340000222</codbar>
<qtdpro>10</qtdpro>
</item>
</itens>
</embalagem>
22222
CONFIRMAR CONFERNCIA DA EMBALAGEM

Ao:
SID.Est.ConfirmarConferEmb (SECE)
CodEmp
Cdigo da empresa
NumEmb
Nmero da embalagem
Retorno:
"OK"
22222
GRAVAR SOLICITAO DE COMPRA (INCLUIR/ALTERAR)

Ao:
SID.Est.GravarSolCompra (SCSC)
CodPro1
CodDer1
CodSer2
Cdigo do Servio
QtdSol
Quantidade para solicitao de compras
DatPrv2
Data previso para entrega do servio
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.
1
NumSol
Nmero do documento da solicitao
SeqSol
Sequncia do item na solicitao de compra
CplPro
CodTns
Cdigo da transao da solicitao de compras
UniMed3
Unidade de medida
PreSol3
Preo da solicitao
CodDep4
DatPrv
Data prevista de entrega do produto
CtaFin
CtaRed
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
CodCcu(n) 5
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
CodFpj(n) 5
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:
6
Depende da parametrizao.
7
Informar apenas o percentual ou apenas o valor.
3
4
Retorno:
"OK"
222222 EXCLUIR SOLICITAO DE COMPRA

Ao:
SID.Est.ExcluirSolCompra (SCSC)
NumSol
Nmero do documento da solicitao
SeqSol
Sequncia do item na solicitao de compra
Retorno:
"OK"
222222 BUSCAR ESTOQUE DISPONVEL

Ao:
SID.Est.BuscarEstoqueDisp (SECE)
CodPro
Cdigo do produto
CodDer
Cdigo da derivao do produto (quando existir)
CodDep
Cdigo do depsito
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
222222 BUSCAR PREO MDIO

Ao:
SID.Est.BuscarPrecoMedio (SECE)
CodPro(n)*
Cdigo do produto
CodDer(n)*
Cdigo da derivao do produto (quando existir)
* (n) = Sequncia 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:
<produto>
<codder>A</codder>
<premed>7.5845</premed>
</produto>
<produto>
<codder> </codder>
<premed>8.668</premed>
</produto>
222222 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
CodFxa
Cdigo da faixa de grades
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.
222222 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.
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
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

22222
MARCAR EMBALAGEM/PRODUTO PARA TRANSFERNCIA

Ao:
SID.Nft.MarcarEPT (RFNF)
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
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.
EmpOri
Cdigo da empresa de origem
EmpDes
Cdigo da empresa de destino
Retorno:
"OK"
22222
BUSCAR ITENS DA NOTA FISCAL DE TRANSFERNCIA

Ao:
SID.Nft.BuscarItensNFT (RFNF)
FilOri
FilDes
CodSnf
Srie da nota fiscal
NumNfv
EmpOri
EmpDes
Retorno:
XML contendo os itens da nota fiscal de transferncia, conforme exemplo:
<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>
<codder>5</codder>
<qtdfat>5</qtdfat>
<codbar>78912340000125</codbar>
</item>
</itens>
</nfv>
22222
CONFIRMAR CONFERNCIA DOS ITENS DA NFT

Ao:
SID.Nft.ConfirmarConferencia (RFNF)
FilOri
FilDes
CodSnf
Srie da nota fiscal
NumNfv
CodDep
Cdigo do depsito
EmpOri
EmpDes
SnfNfc
Srie da nota fiscal de entrada (gerada no processo)
Retorno:
"OK"
2.7 MERCADO PR-FATURAS

22222
CRIAR EMBALAGEM PARA PR-FATURA

Ao:
SID.Pfa.CriarEmbalagem (RFEX)
CodEmp
CodFil
NumAne
NumPfa
CodEmb
NumEmb
Cdigo da empresa
Cdigo da filial
Nmero da anlise de embarque
Nmero da pr-fatura
Cdigo da embalagem
Nmeros das embalagens
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>
22222
Sequncia da Embalagem Criada
INCLUIR OS CONTEDOS DAS EMBALAGEM DA PR-FATURA

Ao:
SID.Pfa.IncluirConteudoEmb (RFEX)
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
NumAne
NumPfa
Nmero da pr-fatura
SeqEmb
NumSep1
Nmero de Srie
CodBar1
Cdigo de Barras
CodPro1
Cdigo do Produto
CodDer1
Cdigo de Derivao
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"
22222
EXCLUIR EMBALAGEM DA PR-FATURA

Ao:
SID.Pfa.ExcluirEmbalagem (RFEX)
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
NumAne
NumPfa
Nmero da pr-fatura
SeqEmb1
NumEmb1
Nmeros das embalagens
Observao:
Se for informado SeqEmb no e necessrio informar NumEmb e vice-versa.

Retorno:
"OK"
2.8 CADASTROS CLIENTES
22222
GRAVAR CLIENTE (INCLUIR/ALTERAR)

Ao:
SID.Cli.Gravar
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.)
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
Cidade do endereo de cobrana do cliente
EstCob
Estado do endereo de cobrana do cliente
CgcCob
Nmero do CNPJ de cobrana
EntCor
Indicativo do endereo de entrega de correspondncias
BaiCob
Bairro de Cobrana do cliente
FonCli
Nmero do telefone - 1
FonCl2
FonCl3
FaxCli
Nmero do FAX do cliente
CxaPst
Nmero da caixa postal do cliente
IntNet
Endereo eletrnico (E-Mail)
CodFor
Cdigo do cliente como fornecedor
CliRep
Cdigo do cliente como representante
CliTra
Cdigo do cliente como transportadora
SitCli
Situao do cliente (Padro=A)
CodMot
Cdigo do motivo da situao do cliente
BloCre
Indicativo se o motivo bloqueia crdito para o cliente (Faturamento) (Padro=N)
ObsMot
Observao do motivo da situao do cliente
TriIcm
Tributa ICMS (S/N) (Padro=S)
TriIpi
TriPis
TriCof
CodPdv
IdeCli
Tributa
Tributa
Tributa
Cdigo
Cdigo
IPI (S/N) (Padro=S)

PIS (S/N) (Padro=S)
COFINS (S/N) (Padro=S)
do cliente no PDV
de identificao do cliente
Retorno:
<CodCli>
Cdigo do cliente gerado
Observao:
22222
GRAVAR DEFINIES DO CLIENTE (INCLUIR/ALTERAR)

Ao:
SID.Cli.GravarDefinicoes
CodCli
Cdigo do cliente
CodRep
Cdigo do representante padro para o cliente
CodCpg
Cdigo da condio de pagamento padro para o cliente
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
CodTra
Cdigo da transportadora padro para o cliente
CodRed
Cdigo da transportadora de redespacho padro para o cliente
RecJmm
Percentual de juros de mora ms para o contas a receber
RecTjr
Tipo de juros para contas a receber (Padro=S)
RecDtj
Dias de tolerncia para clculo de juros de mora
RecMul
Percentual de multa para atraso contas a receber
RecDtm
Dias de tolerncia para multa do contas a receber
PerDsc
Percentual padro de desconto para os ttulos gerados
TolDsc
Quantidade padro de dias de tolerncia para desconto
PorSi1
Cdigo do primeiro portador aceito pelo cliente
PorSi2
Cdigo do segundo portador aceito pelo cliente
CodCrt
Cdigo da carteira padro para o cliente
PorNa1
Cdigo do primeiro portador no aceito pelo cliente
PorNa2
Cdigo do segundo portador no aceito pelo cliente
CodIn1
Cdigo da primeira instruo bancria
CodIn2
Cdigo da segunda instruo bancria
CodBan
Cdigo do banco onde o cliente mantm conta corrente
CodAge
Cdigo da agncia bancria onde o cliente mantm conta corrente
CcbCli
Nmero da conta corrente bancria do cliente
CtaRed
Conta contbil reduzida - 1
CtaRcr
CtaFdv
CtaFcr
CriEdv
FveTns
FveFpg
FveCpg
CifFob

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)
Retorno:
"OK"
Observao:
22222
EXCLUIR CLIENTE
Ao:
SID.Cli.Excluir
CodCli
Cdigo do cliente
CodEmp
Cdigo da empresa
Retorno:
"OK"
22222
EXCLUIR DEFINIES DO CLIENTE

Ao:
SID.Cli.ExcluirDefinicoes
CodCli
Cdigo do cliente
Retorno:
"OK"
22222
GRAVAR DADOS PESSOA JURDICA (INCLUIR/ALTERAR)

Ao:
SID.Cli.GravarPesJuridica
CodCli
Cdigo do cliente
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
Quantidade de funcionrios
VlrFat
Valor do faturamento anual em dlares (US$)
AnoFat
Ano base do faturamento anual
Retorno:
"OK"
Observao:
22222
EXCLUIR DADOS PESSOA JURDICA

Ao:
SID.Cli.ExcluirPesJuridica
CodCli
Cdigo do cliente
Retorno:
"OK"
22222
GRAVAR DADOS PESSOA FSICA (INCLUIR/ALTERAR)

Ao:
SID.Cli.GravarPesFisica
CodCli
Cdigo do cliente
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
Estado onde trabalha o cnjuge do cliente
FonCng
Nmero do telefone da empresa onde trabalha o cnjuge
RamCng
Ramal do fone onde trabalha o cnjuge do cliente
CrtCng
Dados da carteira profissional do cnjuge
CarCng
Cargo exercido na empresa pelo cnjuge
SalCng
Salrio do cnjuge na empresa onde trabalha
TipMor
Tipo de moradia do cliente
TpoMor
Ms e ano da mudana para a moradia atual (reside desde)
VlrAlu
Valor das despesas com moradia
RefCm1
Referncia comercial - 1
RefCm2
Referncia comercial - 2
RefPe1
Referncia pessoal - 1
RefPe2
Referncia pessoal - 2
RefBc1
Referncia bancria - 1
RefBc2
Referncia bancria - 2
UltCpr
Nome da loja onde efetuou a ltima compra a crdito
UltFin
Nome do banco ou financeira onde j fez emprstimo
DatSpc
Data da ltima consulta do SPC
CidSpc
Cidades de pesquisa e de Intercmbio do SPC
InfSpc
NomInv
CarCre
NumCre
ValCre
VctCre
NomCre
DepCre
NasCre
GraCre
EmpAnt
TemAnt
FonAnt
RamAnt
ResAnt
NomAva
CpfAva
EndAva
EenAva
CepAva
CidAva
EstAva
FonAva
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
Retorno:
"OK"
Observao:
22222
EXCLUIR DADOS PESSOA FSICA

Ao:
SID.Cli.ExcluirPesFisica
CodCli
Cdigo do cliente
Retorno:
"OK"
22222
GRAVAR CONTATO DO CLIENTE (INCLUIR/ALTERAR)

Ao:
SID.Cli.GravarContato
CodCli
Cdigo do cliente
SeqCto
Sequncia 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
Ramal do contato - 1
FonCt2
RamCt2
FonCt3
RamCt3
FaxCto
Fax do contato
IntNet
Endereo eletrnico (e-mail)
HobCon
Hobby do contato
TimCon
Time do contato
SitCto
Situao do registro de contato
Retorno:
<SeqCto>
Observao:
222222 EXCLUIR CONTATO DO CLIENTE
Ao:
SID.Cli.ExcluirContato
CodCli
Cdigo do cliente
SeqCto
Sequncia do contato
Retorno:
"OK"
222222 GRAVAR ENDEREO DE ENTREGA

Ao:
SID.Cli.GravarEndEntrega
CodCli
Cdigo do cliente
CepEnt
CEP do endereo de entrega
EndEnt
Endereo de entrega
SeqEnt
Sequncia 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
Sequncia da rota
CodSro
Cdigo da sub-rota
SitReg
Situao do endereo de entrega
Retorno:
<SeqEnt>
Observao:
222222 EXCLUIR ENDEREO DE ENTREGA

Ao:
SID.Cli.ExcluirEndEntrega
CodCli
Cdigo do cliente
SeqEnt
Sequncia do endereo de entrega
Retorno:
"OK"
222222 GRAVAR ENDEREO DE COBRANA

Ao:
SID.Cli.GravarEndCobranca
CodCli
Cdigo do cliente
SeqCob
Sequncia 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>
222222 EXCLUIR ENDEREO DE COBRANA

Ao:
SID.Cli.ExcluirEndCobranca
CodCli
Cdigo do cliente
SeqCob
Sequncia do endereo de cobrana
Retorno:
"OK"
2.9 CADASTROS REPRESENTANTES

22222
GRAVAR REPRESENTANTE (INCLUIR/ALTERAR)

Ao:
SID.Rep.Gravar
CodRep
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
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
FonRe2
FonRe3
FaxRep
Nmero do FAX do representante
CxaPst
Nmero da caixa postal do representante
IntNet
DatCad
Data do cadastramento do representante
DatAtu
Data da ltima alterao do representante
QtdDep
Quantidade de dependentes para imposto de renda
CalIrf
Indicativo se o clculo de IRRF por empresa
CalIss
Indicativo se o clculo de ISS por empresa
CalIns
Indicativo se o clculo de INSS por empresa
CodMot
Cdigo do motivo da situao do representante
ObsMot
Observao do motivo da situao do representante
UsuMot
Usurio responsvel pelo motivo da situao do representante
DatMot
Data do motivo da situao do representante
HorMot
Hora do motivo da situao do representante
DatNas
Data do nascimento
NumRge
Nmero do RG
OrgRge
rgo emissor do RG
DatRge
Data de emisso do RG
RepCli
Cdigo do representante como cliente
RepFor
Cdigo do representante como fornecedor
CodCdi
Cdigo do canal de distribuio padro do representante
NenRep
Nmero do Endereo do Representante
Retorno:
<CodRep>
Cdigo do cliente gerado
Observao:
22222
GRAVAR DEFINIES DO REPRESENTANTE (INCLUIR/ALTERAR)

Ao:
SID.Rep.GravarDefinicoes
CodRep
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
Indicativo se as outras retenes esto na base de comisso dos pedidos, pr-faturas e notas
PifCom
CffCom
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
RecAdc
RecAoc
RecPcj
RecPcm
RecPcc
RecPce
RecPco
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
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
Cdigo da agncia do banco da conta corrente do representante
CcbRep
Nmero da conta corrente do representante
TipCol
Tipo de Colaborador
NumCad
Nmero do Cadastro do Representante como Colaborador
VenVmp
Valor mnimo aceito para pedidos
RecVmt
Valor mnimo aceito para ttulos do contas a receber
PerCqt
Percentual das cotas sobre as quantidades de venda
PerCvl
Percentual das cotas sobre os valores de venda
CtaRed
CtaRcr
CtaFdv
CtaFcr
Retorno:
"OK"
Observao:
22222
EXCLUIR REPRESENTANTE
Ao:
SID.Rep.Excluir
CodRep
Retorno:
"OK"
22222
EXCLUIR DEFINIES DO REPRESENTANTE

Ao:
SID.Rep.ExcluirDefinicoes
CodRep
Retorno:
"OK"
2.10 CADASTROS FORNECEDORES

222222 GRAVAR FORNECEDOR (INCLUIR/ALTERAR)
Ao:
SID.For.Gravar
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.)
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
Cdigo do pas
FonFor
FaxFor
Nmero do FAX do fornecedor
CxaPst
Caixa postal do fornecedor
IntNet
ForRep
Cdigo do fornecedor como representante
ForTra
Cdigo do fornecedor como transportadora
SitFor
Situao do fornecedor (Padro=A)
CodMot
Cdigo do motivo da situao do fornecedor
CliFor
Indicativo se o registro representa um cliente ou um fornecedor ou ambos (Padro=A)
CodCli
Cdigo do fornecedor como cliente (cria o cliente se no existir, e liga ambos)
RecPis
Indicativo se as notas fiscais do fornecedor podero ter recuperao de PIS (Padro=N)
RecIpi
Indicativo se as notas fiscais podero ter recuperao de IPI (Padro=S)
RecIcm
Indicativo se as notas fiscais podero ter recuperao de ICMS (Padro=S)
CodTri
Cdigo de tributao para emisso de DARF/DIRF
IdeFor
Identificao do fornecedor
Retorno:
<CodFor>
Cdigo do fornecedor gerado
Observao:
222222 GRAVAR DEFINIES DO FORNECEDOR (INCLUIR/ALTERAR)

Ao:
SID.For.GravarDefinicoes
CodFor
Cdigo do fornecedor
CodCpg
Cdigo da condio de pagamento padro
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
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
CtaRcr
CtaFdv
CtaFcr
CriEdv
Critrio para escolha do dia de vencimento (A, S, N, U)
Retorno:
"OK"
Observao:
222222 EXCLUIR FORNECEDOR

Ao:
SID.For.Excluir
CodFor
Cdigo do fornecedor
Retorno:
"OK"
Observao:
222222 EXCLUIR DEFINIES DO FORNECEDOR

Ao:
SID.For.ExcluirDefinicoes
CodFor
Cdigo do fornecedor
Retorno:
"OK"
2.11 CADASTROS PRODUTOS

222222 GRAVAR PRODUTO (INCLUIR/ALTERAR)
Ao:
SID.Pro.Gravar
CodPro
Cdigo do produto
DesPro
Descrio usual do produto
CodFam
Cdigo da famlia do produto
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
OriMer
Origem fiscal da mercadoria (0=Nacional*, 1=Estrangeiro Importao direta, 2=Estrangeiro
Adquirido no mercado interno) *Valor padro
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.
PerPis *
Percentual de PIS retido vlido para o produto.
PerCof *
Percentual de COFINS retido vlido para o produto.
CstPis *
Cdigo da situao tributria de PIS nas operaes de venda.
CstCof *
Cdigo da situao tributria de COFINS nas operaes de venda.
CtaRed *
Conta contbil reduzida 1.
TriPis *
Indicativo se o produto tem tributao de PIS ou no.
TriCof *
Indicativo se o produto tem tributao de COFINS ou no
AgrCcr
Controle de crdito de ICMS para o agronegcio
* Campos disponveis na verso 5.7.1.1
Retorno:
"OK"
Observao:
222222 EXCLUIR PRODUTO

Ao:
SID.Pro.Excluir
CodPro
Cdigo do produto
Retorno:
"OK"
222222 GRAVAR DERIVAO (INCLUIR/ALTERAR)

Ao:
SID.Pro.GravarDerivacao
CodPro
Cdigo do produto
CodDer
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:
222222 EXCLUIR DERIVAO

Ao:
SID.Pro.ExcluirDerivacao
CodPro
Cdigo do produto
CodDer
Retorno:
"OK"
2.12 FINANAS CONTAS A RECEBER

222222 GRAVAR TTULO CR
Ao:
SID.Tcr.Gravar (FRCR)
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
Cdigo da carteira do ttulo a receber
ProJrs
Indicativo se o vencimento prorrogado com ou sem juros
CodFpg*
*Depende da parametrizao.
CodMoe
Cdigo da moeda do ttulo a receber
CodNtg
Cdigo da natureza de gasto
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)*
CodCnv
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
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
Cdigo do Convnio
* (n) = Sequncia 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:
222222 BAIXAR TTULO CR

Ao:
SID.Tcr.Baixar (FRCR)
NumTit
CodTpt
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
NsuTef
Nmero da Transao TEF
TipRet
DatLib
Data de liberao
DiaAtr
Dia de atrasos
DiaJrs
Dia de juros
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)*
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
Sequncia do movimento relacionado gerado ou aproveitado
Nmero do documento para movimento da tesouraria
Transao de movimentao na tesouraria
Ignora clculo de juros, multa e desconto (0=no*, 1=sim)
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
*Valor padro
* (n) = Sequncia incremental da linha do rateio, iniciando sem 1 (um) No utilizar os parnteses.
Retorno:
- 0 (padro): "OK"
- 1: <SeqMov> (Sequncia do movimento gerado)
222222 GRAVAR RATEIO TTULO CR

Ao:
SID.Tcr.GravarRateio (FRCR)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
CtaFin(n)*
Conta financeira**
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
Valor do rateio***
NumPrj(n)*
CodFpj(n)*
ObsRat(n)*
Observao do rateio
Retorno:
"OK"
Observaes:
222222 EXCLUIR TTULO CR

Ao:
SID.Tcr.ExcluirTitulo (FRCR)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
TroPor
Indicativo para trocar o portador (c/ o anterior) antes de excluir o ttulo (0=no*, 1=sim)
* Valor padro
Retorno:
"OK"
222222 EXCLUIR BAIXA CR

Ao:
SID.Tcr.ExcluirBaixa (FRCR)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
SeqMov
Retorno:
"OK"
222222 ALTERAR TTULO CR

Ao:
SID.Tcr.Alterar (FRCR)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
VctPro
Vencimento prorrogado
ProJrs
Indicativo se o vencimento da prorrogao possui juros (S/N)
CodMpt
Cdigo do motivo de prorrogao do ttulo
CodPor
Cdigo do portador do ttulo
CodCrt
Cdigo da carteira do ttulo
Retorno:
"OK"
222222 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)
CodCli
Cdigo do cliente
NumTit
CodTpt
CodTns
DatPgt
ConJrs*
ConMul*
ConDsc*
* Valor padro

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
VlrCor
VlrOac
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
Valor da correo monetria do ttulo
Valor de outros acrscimos do ttulo
VlrOde
VlrMov
CodFpg
DiaAtr
DiaJrs
VctOri
Valor de outros descontos do ttulo

Valor do movimento j calculado com juros, multa, desconto, etc.
Nmero de dias de atraso
Nmero de dias de juros calculados
Vencimento original / prorrogado
222222 PROCESSAR BAIXAS AUTOMTICAS

Ao:
SID.Tcr.ProcessarBaixasAutomaticas (FRCR)
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) = Sequncia incremental do ttulo, iniciando sempre em 1 (um) No utilizar os parnteses.
NroDoc
Nmero do documento
TipVct
Tipo de vencimento (1=provvel pagamento*, 2=vencimento normal) *Padro
CodFpg
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) = Sequncia incremental do ttulo, deve coincidir com a Sequncia 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

222222 GRAVAR TTULO CP
Ao:
SID.Tcp.Gravar (FPCP)
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
CodCrp
Cdigo do grupo de contas a pagar
CodNtg
CodTri
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
Quantidade de dias de tolerncia para os juros de mora
PerMul
Percentual de multa prevista para o ttulo a pagar
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
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 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
Sequncia de juno de ttulos pagos com mesmo cheque
Data da liberao do cheque aprovado para pagamento
Cdigo do portador anterior
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
Data do provvel pagamento do ttulo
Nmero do CNPJ ou CPF do favorecido
Retorno:
"OK"
Observao:
222222 BAIXAR TTULO CP

Ao:
SID.Tcp.Baixar (FPCP)
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
TipRet
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
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
Valor da correo monetria do ttulo
VlrOac
Valor de outros acrscimos do ttulo
NumPrj
CodFpj
CtaFin
CtaRed
CodCcu
TipPgt
CodBan
CodAge
CcbFor
AgrPre
* Valor padro
Nmero do projeto
Tipo de pagamento do ttulo
Indicativo para agrupar sequncia preparao de cheque (0=no*, 1=sim)
Retorno:
- 0 (padro): "OK"
- 1: <SeqMov> (Sequncia do movimento gerado)
222222 GRAVAR RATEIO TTULO CP

Ao:
SID.Tcp.GravarRateio (FPCP)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
CodFor
Cdigo do fornecedor
CtaFin(n)*
Conta financeira**
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
Valor do rateio***
NumPrj(n)*
CodFpj(n)*
ObsRat(n)*
Observao do rateio
Retorno:
"OK"
Observaes:
222222 EXCLUIR TTULO CP

Ao:
SID.Tcp.ExcluirTitulo (FPCP)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
CodFor
Cdigo do fornecedor
Retorno:
"OK"
222222 EXCLUIR BAIXA CP

Ao:
SID.Tcp.ExcluirBaixa (FPCP)
NumTit
Nmero do ttulo
CodTpt
Tipo do ttulo
CodFor
Cdigo do fornecedor
SeqMov
Retorno:
"OK"
2.14 FINANAS TESOURARIA

222222 GRAVAR MOVIMENTO (INCLUIR/ALTERAR)
Ao:
SID.Tes.Gravar (FTCB)
NumCco
Conta interna
CodTns
Cdigo da transao
VlrMov*
Valor do movimento
DatMov
Data do movimento
SeqMov
DatCtb*
Data contbil do movimento
DatLib*
Data de liberao do movimento
CodNtg
Cdigo da natureza de gastos
CodCcu
CodDoc
Cdigo do tipo de documento para tesouraria
DocMov*
Nmero do documento do movimento
CtaRed
CtaFin
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
Retorno:
<SeqMov>
Observaes:
* Campos disponveis somente na incluso
222222 GRAVAR RATEIO DO MOVIMENTO

Ao:
SID.Tes.GravarRateio (FTCB)
NumCco
Conta interna
CodTns
Cdigo da transao
DatMov
Data do movimento
SeqMov
CtaFin(n)*
Conta financeira**
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
Valor do rateio***
NumPrj(n)*
CodFpj(n)*
ObsRat
Observao do rateio
Retorno:
"OK"
222222 PROCESSAR MOVIMENTO (CHEQUE)

Ao:
SID.Tes.ProcessarMvto (FTCB)
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)
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

222222 GRAVAR LANAMENTO
Ao:
SID.Prj.Gravar (FJCF)
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.)
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
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
Sequncia 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
CtaFin(n)*
Conta financeira**
CtaRed(n)*
CodCcu(n)*
PerCta(n)*
VlrCta(n)*
PerRat(n)*
VlrRat(n)*
Valor do rateio***
NumPrj(n)*
CodFpj(n)*
Retorno:
<SeqGer>
Sequncia de gerao do lanamento manual na data
222222 EXCLUIR LANAMENTO

Ao:
SID.Prj.Excluir (FJCF)
DatGer
SeqGer
Data da gerao do registro

Sequncia de gerao do lanamento manual na data
Retorno:
"OK"
2.16 CONTROLADORIA TRIBUTOS - REDUO Z

222222 GRAVAR TOTALIZADORES DA REDUO Z
Ao:
SID.Rez.GravarTotalizador (CIEC)
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
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
CooRed
Nmero do contador de ordem de operao do ltimo documento emitido no dia
Retorno:
"OK"
222222 GRAVAR MOVIMENTOS DA REDUO Z

Ao:
SID.Rez.GravarMovimento (CIEC)
CodEqu
DatRef
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
CodAgf
Cdigo de agrupamento para escrita fiscal
VlrCtb
Valor contbil do movimento da reduo Z
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
CtaRed
SitTri
Situao Tributria dos Itens do Cupom Fiscal
CodFpg
PerPit
VlrBpt
AliPif
QtdBpf
VlrPit
PerCrt
VlrBct
AliCff
QtdBcf
VlrCrt
Percentual do PIS faturamento

Base de clculo do PIS faturamento
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
Retorno:
<SeqRez>
Sequncia de lanamento do movimento da reduo Z
222222 GRAVAR RATEIOS DOS MOVIMENTOS DA REDUO Z

Ao:
SID.Rez.GravarRateio (CIEC)
CodEqu
DatRef
SeqRez
CriRat
Critrio utilizado para o Rateio
SeqRat
Sequncia do Rateio
DatBas
Data base contbil e financeira
CtaRed
PerCta
Percentual rateado para a conta
VlrCta
Valor rateado para a conta
CodCcu
PerRat
Percentual rateado para o centro de custos
VlrRat
Valor rateado para o centro de custos
ObsRat
Observao do rateio
Retorno:
<SeqRat>
Sequncia do Rateio
222222 GRAVAR ITENS DA REDUO Z

Ao:
SID.Rez.GravarItem (CIEC)
CodEqu
DatRef
SeqRez
NumCfi
Nmero do cupom fiscal de referncia do item
VlrCtb
Valor contbil do item no movimento do cupom fiscal
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
NatPis
CstCof
NatCof
CodCli
ChvDoe
Alquota por Valor do PIS

Quantidade da Base do PIS
Valor do PIS faturamento
Base de clculo do COFINS faturamento
Alquota por Valor do COFINS
Quantidade da Base do COFINS
Cdigo da Situao Tributria do PIS
Natureza do PIS
Cdigo da Situao Tributria do COFINS
Natureza do COFINS
Cdigo do cliente do cupom fiscal
Chave do documento eletrnico
Retorno:
<SeqIte>
Sequncia do item no movimento do cupom fiscal
2.17 CONTROLADORIA TRIBUTOS NOTA FISCAL COMPRA

222222 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)
Ao:
SID.Nic.Gravar (CIEC)
CodFor
NumNfi
Nmero inicial da nota fiscal de entrada
NumNff
Seqencial de lanamento da nota fiscal
CodSnf
CodTns
Cdigo da transao de entrada
CodAgf
Cdigo do Agrupamento fiscal
DatEmi
Data de Emisso
CodAgf
Cdigo de agrupamento para escrita fiscal
DatEnt
Data de Entrada
NopOpe
Natureza de operao
CodEdc
SitNfc
Situao da nota fiscal
TipNfe
Tipo de nota fiscal de entrada
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
VlrBri
Base de Clculo do ICMS ST Resp. Solidrio
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
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
VlrBcl
VlrCsl
PerOur
VlrBor
VlrOur
PerIss
VlrBis
VlrIss
PerIns
VlrBin
VlrIns
VlrBpf
VlrPif
VlrBcf
VlrCff
VlrBsd
VlrIsd
VlrBsp
VlrStp
VlrBsc
VlrStc
VlrBfu
PerFun
VlrFun
CodTri
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
VlrDzp
VlrDzc
DatExf
DatExc
Retorno:
"OK"
Percentual da CSLL
Valor Base da CSLL
Valor da CSLL
Percentual das Outras Retenes
Valor Base das 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 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 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 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
Valor base do imposto de importao
Valor do imposto de importao
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
Sequncia 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
Cdigo da mensagem 1
Cdigo da mensagem 2
Cdigo da mensagem 3
Cdigo da mensagem 4
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 do seguro 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
Valor Desconto PIS Zona Franca
Valor Desconto Cofins Zona Franca
Data da escriturao do documento extemporneo SPED Fiscal
Data da escriturao do documento extemporneo SPED Contribuies
222222 GRAVAR RATEIOS DOS DADOS GERAIS

Ao:
SID.Nic.GravarRateio (CIEC)
CodFor
Cdigo do Fornecedor
NumNfi
NumNff
CodSnf
Cdigo da srie da nota fiscal sada
CodTns
Transao
CriRat
SeqRat
Sequncia do rateio
DatBas
CtaRed
PerCta
VlrCta
CodCcu
PerRat
VlrRat
ObsRat
Observao do rateio
Retorno:
<SeqRat>
Sequncia do Rateio
222222 GRAVAR ITEM (INCLUIR/ALTERAR)

Ao:
SID.Nic.GravarItem (CIEC)
CodFor
NumNfi
NumNff
CodSnf
CodTns
SeqInc*
Sequncia de lanamento do item
* Opcional na incluso
CodPro
Cdigo do produto
CodDer
CplPro
Descrio complementar do produto ou servio
CodClf
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
VlrBri
Base de Clculo do ICMS ST Resp. Solidrio
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
VlrDsc
Valor do desconto do item
CodStr
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
FilNfv
NumNfv
SnfNfv
SeqIpv
VlrDac
CodTst
PerIim
VlrBii
VlrIim
VlrRis
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
PerPir
VlrBpr
VlrPir
PerCor
VlrBcr
VlrCor
CstIpi
CstPis
CstCof
CodCcu
CodCli
TnsNfv
BasCre
NffNfv
VlrDai
VlrBsd
VlrIsd
VlrBsp
VlrStp
VlrBsc
VlrStc
VlrBfu
PerFun
VlrFun
VlrSeg
VlrFre
VlrBie
VlrIem
PerPif
VlrBpf
VlrPif
PerCff
VlrBcf
VlrCff
CodDfs
VlrAjs
VlrFei
VlrSei

Valor das despesas acessrias (embalagem, encargos, outras despesas)
Percentual de imposto de importao do item da nota fiscal de entrada
Valor do imposto de importao do item da nota fiscal de entrada
Cdigo do bem
Peso na entrada
Diferena de peso
Base de clculo de ICMS da diferena de peso
Nota fiscal do produtor
Percentual do IRRF
Valor Base do IRRF
Valor do IRRF
Valor do PIS Retido
Percentual da CSLL
Valor Base da CSLL
Valor da CSLL
Valor Base da Outras Retenes
Percentual do ISS
Valor Base do ISS
Valor do ISS
Percentual do INSS
Valor Base do INSS
Valor do INSS
Percentual do PIS a Recuperar
Valor Base do PIS a Recuperar
Valor do PIS a Recuperar
Percentual do COFINS 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 cliente
Cdigo da transao
Cdigo da Base de Clculo de Crdito
Diferena de alquota interestadual do ICMS
Valor base do ICMS substitudo destacado
Valor base para clculo da substituio do PIS
Valor do Funrural
Valor do seguro
Valor do frete
Valor base do PIS Faturamento
Valor base do COFINS faturamento
Cdigo do dispositivo fiscal
Valor do ajuste do item referente ao dispositivo fiscal
Valor do seguro de importao
VlrOui
QtdBip
AliIpi
QtdBpi
AliPis
QtdBco
AliCof
alipif
AliPif
QtdBcf
AliCff
VlrSub
OriMer
VlrDzp
VlrDzc
VlrMrc
PerStp
PerStc
NumDrb

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)
Valor Subsdio
Origem Fiscal da Mercadoria
Valor Desconto PIS Zona Franca
Valor Desconto Cofins Zona Franca
Valor da Mercadoria do item
Percentual de Substituio de PIS
Percentual de Substituio de COFINS
Nmero do ato concessrio de Drawback
Retorno:
<SeqInc>
222222 EXCLUIR ITEM

Ao:
SID.Nic.ExcluirItem (CIEC)
CodFor
NumNfi
NumNff
CodSnf
CodTns
SeqInc
Retorno:
"OK"
222222 GRAVAR PARCELA COMPRA (INCLUIR/ALTERAR)

Ao:
SID.Nic.GravarParcelaCompra (CIEC)
CodFor
CodSnf
NumNfi
VctPar
Data de Vencimento da Parcela da Nota Fiscal de entrada
VlrPar
Valor da Parcela da Nota Fiscal de entrada
NumTit
Nmero do ttulo a ser gerado no Contas a Pagar
Parmetros Opcionais:
CodPar
Sequncia de parcelas da Nota Fiscal de entrada
CodTpt
Cdigo do tipo de ttulo a ser gerado no Contas a Pagar
ObsPar
Texto da observao
Retorno:
<CodPar>
222222 EXCLUIR PARCELA COMPRA

Ao:
SID.Nic.ExcluirParcelaCompra (CIEC)
CodFor
CodSnf
NumNfi
CodPar
Sequncia de parcelas da Nota Fiscal de entrada
Retorno:
OK
222222 GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (INCLUIR/ALTERAR)

Ao:
SID.Nic.GravarEntardaVencimentoLoteSerie (CIEC)
CodFor
CodSnf
NumNfi
SeqIpc
Sequncia do item da Nota Fiscal de Entrada
Parmetros Opcionais:
SeqDls
Sequncia 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
Nmero de srie do produto
QtdEst
Quantidade a ser movimentada do estoque
ObsDls
Texto da observao
Retorno:
<SeqDls>
222222 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE

Ao:
SID.Nic.ExcluirEntardaVencimentoLoteSerie (CIEC)
CodFor
CodSnf
NumNfi
SeqIpc
SeqDls
Sequncia de movimento de item
Retorno:
OK
222222 GRAVAR LIGAO ENTRE ITENS (INCLUIR/ALTERAR)

Ao:
SID.Nic.GravarLigacaoItens (CIEC)
CodFor
CodSnf
NumNfi
SeqIpc
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
Sequncia do item de produto relacionado
Parmetros Opcionais
SeqLni
Sequncia de ligao
Retorno:
<SeqLni>
2222222 EXCLUIR LIGAO ENTRE ITENS

Ao:
SID.Nic.ExcluirLigacaoItens (CIEC)
CodFor
CodSnf
NumNfi
SeqIpc
SeqLni
Sequncia de ligao
Retorno:
OK
2.18 CONTROLADORIA TRIBUTOS NOTA FISCAL VENDA

222222 GRAVAR DADOS GERAIS (INCLUIR/ALTERAR)
Ao:
SID.Niv.Gravar (CIEC)
CodCli
Cdigo do cliente da nota fiscal de sada
NumNfi
Nmero inicial da nota fiscal de sada
NumNff
CodSnf
Cdigo da srie da nota fiscal de sada
CodTns
Cdigo da transao de sada
CodAgf
Cdigo do Agrupamento Fiscal
DatEmi
Data de emisso da nota fiscal de sada
NopOpe
Natureza de operao de sada
DatSai
Data da sada da nota fiscal de sada
CodEdc
SitNfv
Situao da nota fiscal
TipNfs
Tipo da nota fiscal de sada
ObsNfv
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
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
VlrIsd
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
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
PerCrt
VlrBct
VlrCrt
PerPit
VlrBpt
VlrPit
Valor do PIS Retido
PerCsl
Percentual da CSLL
VlrBcl
Valor Base da CSLL
VlrCsl
Valor da CSLL
PerOur
VlrBor
VlrOur
VlrBpf
VlrPif
VlrBcf
VlrCff
CodRai
VlrDai
VlrBid
VlrIpd
VlrBsp
VlrStp
VlrBsc
VlrStc
VlrBfu
PerFun
VlrFun
CodTri
PerIcf
IcmFre
VlrFre
CifFob
VlrSeg
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
HorSai
VlrSub
DatZfm
DatExf
DatExc

Cdigo da cidade para recolhimento do ISS
Valor da diferena de alquota interestadual do ICMS
Valor base IPI destacado / presumido
Valor do IPI destacado / presumido
Valor do Funrural
Percentual do ICMS sobre o frete
Valor do ICMS sobre o frete
Valor do frete
Indicativo se o valor do frete CIF ou FOB
Valor do seguro
Valor das despesas acessrias
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
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
Cdigo da mensagem 1
Cdigo da mensagem 2
Cdigo da mensagem 3
Cdigo da mensagem 4
Sequncia do endereo de entrega do cliente
Sequncia do endereo do participante da coleta
Sequncia do endereo do participante da entrega
Nmero do cupom fiscal de referncia da reduo Z
Total do Imposto CIDE
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)
Hora da sada das mercadorias da nota fiscal de sada
Valor Subsdio
Data Efetiva do Ingresso na Zona Franca de Manaus
Data da escriturao do documento extemporneo SPED Fiscal
Data da escriturao do documento extemporneo SPED Contribuies
Retorno:
"OK"
222222 GRAVAR RATEIOS DOS DADOS GERAIS
Ao:
SID.Niv.GravarRateio (CIEC)
CodCli
Cdigo do Cliente
NumNfi
NumNff
CodSnf
Cdigo da srie da nota fiscal sada
CodTns
Transao
CriRat
SeqRat
Sequncia do rateio
DatBas
CtaRed
PerCta
VlrCta
CodCcu
PerRat
VlrRat
ObsRat
Observao do rateio
Retorno:
<SeqRat>
Sequncia do Rateio
222222 GRAVAR ITEM (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarItem (CIEC)
CodCli
NumNfi
NumNff
CodSnf
CodTns
SeqInv*
* Opcional na incluso
CodPro
Cdigo do produto
CodDer
CplPro
Descrio complementar do produto ou servio
CodClf
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
SeqIpv
Sequncia 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
FilNfc
Cdigo da filial da nota fiscal de entrada
CodFor
Fornecedor da nota fiscal de entrada
NumNfc
SnfNfc
SeqIpc
Sequncia do item da nota fiscal de entrada
VlrDac
Valor das despesas acessrias (embalagem, encargos, outras despesas)
CodTst
PerIim
Percentual do imposto de importao do item da nota fiscal de sada
VlrBii
VlrIim
VlrRis
CodBem
SeqNfi
PerIrf
VlrBir
VlrIrf
PerCrt
VlrBct
VlrCrt
PerPit
VlrBpt
VlrPit
PerCsl
VlrBcl
VlrCsl
PerOur
VlrBor
VlrOur
PerIss
VlrBis
VlrIss
PerIns
VlrBin
VlrIns
PerPir
VlrBpr
VlrPir
PerCor
VlrBcr
VlrCor
Coefci
CstPis
CstCof
CodCcu
TnsNfc
NffNfc
DesImp
VlrDai
VlrSic
VlrBsd
VlrIsd
VlrBsp
VlrStp
VlrBsc
VlrStc
VlrBfu
PerFun
VlrFun
VlrFre
VlrSeg
PerPif
VlrBpf
VlrPif
PerCff
VlrBcf
VlrCff
NumRde
CodDfs
VlrAjs
VlrCid
TotCid
QtdBip
AliIpi
QtdBpf
AliPif
QtdBcf
AliCff
QtdBpi
AliPis
QtdBco
AliCof
VlrSub
NatPis
NatCof
OriMer
Valor do imposto de importao do item da nota fiscal de sada

Cdigo do bem
Sequncia do item na nota fiscal impressa
Percentual do IRRF
Valor Base do IRRF
Valor do IRRF
Valor do PIS Retido
Percentual da CSLL
Valor Base da CSLL
Valor da CSLL
Percentual do ISS
Valor Base do ISS
Valor do ISS
Percentual do INSS
Valor Base do INSS
Valor do INSS
Percentual do PIS a Recuperar
Valor Base do PIS a Recuperar
Valor do PIS a Recuperar
Percentual do COFINS 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 da transao
Descrio do produto para impresso
Valor da diferena de alquota interestadual do ICMS
Valor do Funrural
Valor do frete
Valor do seguro
Valor base do PIS Faturamento
Valor base 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
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
Natureza do PIS
Natureza do COFINS
Origem Fiscal da Mercadoria
VlrMrc
PerPim
PerCim
PerStp
PerStc
Valor da Mercadoria do item

Percentual de PIS a Recuperar na Importao
Percentual de Cofins a Recuperar na Importao
Percentual de Substituio de PIS
Percentual de Substituio de COFINS
Retorno:
<SeqInv>
222222 EXCLUIR ITEM

Ao:
SID.Niv.ExcluirItem (CIEC)
CodCli
NumNfi
NumNff
CodSnf
CodTns
SeqInv
Retorno:
"OK"
222222 GRAVAR CONHECIMENTO DE TRANSPORTE (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarTransporte (CIEC)
CodCli
NumNfi
NumNff
CodSnf
CodTns
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
Parmetros Opcionais
SeqCct
Sequncia da composio do conhecimento de transporte
QtdMer
Quantidade das Mercadorias da Nota Fiscal transportada
UniMed
Unidade de medida das Mercadorias da Nota Fiscal transportada
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>
222222 EXCLUIR CONHECIMENTO DE TRANSPORTE

Ao:
SID.Niv.ExcluirTransporte (CIEC)
CodCli
NumNfi
NumNff
CodSnf
CodTns
SeqCct
Sequncia da composio do conhecimento de transporte
Retorno:
OK
222222 GRAVAR PARCELAS DE VENDA (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarParcelaVenda (CIEC)
CodSnf
Cdigo da Srie da Nota Fiscal
NumNfi
VctPar
Data de Vencimento da parcela da Nota Fiscal de sada
VlrPar
Valor da Parcela da Nota Fiscal de sada
Parmetros Opcionais
CodPar
Sequncia 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
CodFpg
Cdigo da Forma de Pagamento
Retorno:
<CodPar>
222222 EXCLUIR PARCELAS DE VENDA

Ao:
SID.Niv.ExcluirParcelaVenda (CIEC)
CodSnf
NumNfi
CodPar
Sequncia de parcelas da Nota Fiscal
Retorno:
OK
222222 GRAVAR ENTRADA, VENCIMENTO, LOTE E SRIE (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarEntradaVencimentoLoteSerie (CIEC)
CodSnf
NumNfi
SeqIpv
Sequncia do item na Nota Fiscal
Parmetros Opcionais
SeqDls
Sequncia 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
NumSep
Nmero de srie do produto
QtdEst
Quantidade a ser movimenta do estoque
ObsDls
Texto da Observao
Retorno:
<SeqDls>
2222222 EXCLUIR ENTRADA, VENCIMENTO, LOTE E SRIE

Ao:
SID.Niv.ExcluirEntradaVencimentoLoteSerie (CIEC)
CodSnf
NumNfi
SeqIpv
SeqDls
Sequncia de Movimento de item
Retorno:
OK
2222222 GRAVAR LIGAO ENTRE ITENS (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarLigacaoItens (CIEC)
CodSnf
NumNfi
SeqIpv
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
Sequncia do Item de produto relacionado
Parmetros Opcionais
SeqLni
Sequncia de ligao
Retorno:
<SeqLni>
2222222 EXCLUIR LIGAO ENTRE ITENS

Ao:
SID.Niv.ExcluirLigacaoItens (CIEC)
CodSnf
NumNfi
SeqIpv
SeqLni
Sequncia de ligao
Retorno:
OK
2222222 GRAVAR INFORMACOES DOCUMENTO ELETRNICO (INCLUIR/ALTERAR)

Ao:
SID.Niv.GravarInformacoesDocumentoEletronico (CIEC)
CodEmp
Cdigo empresa
CodFil
Cdigo filial
CodSnf
Srie da nota fiscal
NumNfi
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
2222222 EXCLUIR INFORMACOES DOCUMENTO ELETRNICO

Ao:
SID.Niv.ExcluirInformacoesDocumentoEletronico (CIEC)
CodEmp
Cdigo empresa
CodFil
Cdigo filial
CodSnf
Srie da nota fiscal
NumNfi
Retorno:
OK
2.19 CONTROLADORIA TRIBUTOS INVENTRIO DE ESTOQUES

222222 GRAVAR SALDOS FSICOS MENSAIS (INCLUIR/ALTERAR)
Ao:
SID.Est.GravarInventario (CIEC)
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
QtdPrp
Quantidade em Estoque Prprio
VlrPrp
Valor em Estoque Prprio
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
222222 GRAVAR SALDOS CONSIGNADOS (INCLUIR/ALTERAR)

Ao:
SID.Est.GravarConsignado (CIEC)
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

222222 GERAR LOTE CONTBIL
Ao:
SID.Lct.GerarLote (CCCT)
DatLot
Data do lote
TotInf
Total informado para fechamento do lote
Retorno:
<NumLot>
Nmero do lote gerado
222222 EXCLUIR LOTE CONTBIL

Ao:
SID.Lct.ExcluirLote (CCCT)
NumLot
CodEmp
Cdigo da empresa
OriLct*
Origem do lote contbil
* Quando no informado utilizado origem "MAN"
Retorno:
"OK"
222222 GERAR LANAMENTO

Ao:
SID.Lct.Gravar (CCCT)
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
DatLct
Data de lanamento
DatLot
Data do lote
DocLot
Documento de controle de lanamentos
CgcCpf
C.N.P.J./C.P.F.
CtaRed(n)*
CodCcu(n)*
PerRat(n)*
Percentual do rateio
VlrRat(n)*
Valor do rateio
CtaRea(n)*
Conta contbil reduzida origem da composio auxiliar
CtaAux(n)*
Conta contbil auxiliar
VlrAux(n)*
Valor da composio auxiliar
Retorno:
<NumLct>
Nmero do lanamento gerado
222222 INTEGRAO CONTBIL

Ao:
SID.Ctb.Integrar (CCCT)
(ver Observao)
CodFil
Cdigo da filial
DatIni
Data inicial (sugesto)
DatFin
Data final (sugesto)
CodAgi
Agrupamento de filiais
LotFil
Lote por filial (0=No*, 1=Sim)
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
FinVef
IniEst
FinEst
IniCre
FinCre
IniNfe
FinNfe
IniCof
FinCof
IniCpa
FinCpa
IniCom
FinCom
IniTes
FinTes
IniPat
FinPat
IniIve
FinIve
IniIco
FinIco
IniIvz
FinIvz
IniPrj
FinPrj
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Retorno:
<QtdLct>
Quantidade de lanamentos gerados
* = Valor padro
inicial para integrao Faturas Vendas

final para integrao Faturas Vendas
inicial para integrao Estoques
final para integrao Estoques
inicial para integra o Contas a Receber
final para integrao Contas a Receber
inicial para integrao Notas Fiscais de Entrada
final para integrao Notas Fiscais de Entrada
inicial para integrao Faturas Compras
final para integrao Faturas Compras
inicial para integrao Contas a Pagar
final para integrao Contas a Pagar
inicial para integrao Comisses
final para integrao Comisses
inicial para integrao Tesouraria
final para integrao Tesouraria
inicial para integrao Patrimnio
final para integrao Patrimnio
inicial para integrao Impostos Vendas
final para integrao Impostos Vendas
inicial para integrao Impostos Compras
final para integrao Impostos Compras
inicial para integrao Impostos Reduo Z
final para integrao Impostos Reduo Z
inicial para integrao Projetos
final para integrao Projetos
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

222222 MOVIMENTAR BEM
Ao:
SID.Pat.Movimentar (CPBE)
CodBem
Cdigo do bem
CodTns
Cdigo da transao
CcuNov
Cdigo do centro de custos de destino
DatTrf
Data da transferncia
NumPla
Nmero da plaqueta (caso deseja-se transferir apenas uma plaqueta de centro custos)
EmpNfv
FilNfv
SnfNfv
NumNfv
SeqIpv
Sequncia do item de produto na nota fiscal de sada
SeqIsv
Sequncia 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"
222222 BUSCAR DEPRECIAO DO BEM

Ao:
SID.Pat.BuscarDepreciacao (CPBE)
Parmetro obrigatrio:
CodBem (n)*
MulQtd(n)*
DatCal(n)*
MesAnt(n)*
DprBem(n)*1
depreciao **
Cdigo do bem
Retorno vem multiplicado pela quantidade de itens (S=sim, N=no)
Data do clculo da depreciao
Indicativo se para buscar depreciao do perodo anterior ao informado (S=sim, N=no)
Indicativo se deve buscar a depreciao na tabela de bens caso no existam clculos de
* (n) = Sequncia 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:
<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>
</bem>
<bem>
<codbem>VEIPARAT0001-000</codbem>
<dprmes>0</dprmes>
<dpracu>0</dpracu>
</bem>
</depreciacao>
2.22 MANUFATURA ORDEM DE PRODUO

222222 APONTAR ORDENS DE PRODUO
Ao:
SID.Prd.ApontarOps (MCAP)
CodOri
Cdigo da origem
NumCad
Cdigo do operador
NumOrp
Nmero da O.P.
CodEtg
Cdigo do estgio
SeqRot
Sequncia de roteiro
CodEqp
Cdigo do coletor (equipamento de coleta)
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
QtdRe3
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
EqpMov**
Cdigo do equipamento
*Este campo est deprecado (mantido somente para compatibilidade), no devendo ser usado, pois o formato das
informaes pode variar conforme as verses do sistema.
**Este campo obrigatrio se a empresa estiver configurada para utilizar a parada por equipamento (E070EPR.IndPre =
S) e o centro de recurso informado for limitado por mquina (E725CRE.LimCap = M), caso contrrio ele no deve ser informado.
Esta ao SID no suporta OS gerada a partir de uma ordem de manuteno.

Retorno:
"OK"
222222 REMETER/RETORNAR SERVIO DE TERCEIROS

Ao:
SID.Prd.RemeterRetornarServico (MCRR)
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
SeqRot
Sequncia 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
QtdRe3
Retorno:
"OK"
222222 BAIXAR COMPONENTES DA O.P./O.S.

Ao:
SID.Prd.BaixarComponentes (MPMO)
CodOri
Cdigo da origem
NumOrp
Nmero da O.P./O.S.
CodEtg
Cdigo do estgio
CodCmp
Cdigo do componente
CodDer
Cdigo da derivao do componente
QtdUti
Quantidade a utilizar (quantidade a baixar)
SeqCmp
Sequncia do componente
QtdMnc
Quantidade de material no-conforme
QtdCdr
Quantidade somada a quantidade j informada no componente.
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.
222222 INCLUIR OPERAO NA ORDEM DE PRODUO

Ao:
SID.Prd.IncluirOperacaoOP (MPMO)
CodOri
Cdigo da Origem
CodOpr
Cdigo da Operao
MovAut
Indicativo se inicia operao automaticamente aps fim da anterior (S = Sim; N = No)
NumOrp
Nmero da O.P.
NumCad
Nmero do Cadastro do Operador
CodEtg
Cdigo do estgio
SeqRot
TipPos
DtrIni*
DtrFim*
HorIni**
HorFim***
DtpIni*
DtpFim*
HorIpv****
HorFpv*****
CodEqp******
Sequncia de roteiro
Tipo posicionamento (1 = Inicia aps fim da anterior; 2 = Inicia junto; 3 = Finaliza junto)
Data de incio real da operao na O.P.
Data de fim real da operao na O.P.
Hora de incio real da operao na O.P.
Hora de fim real da operao na O.P.
Data inicial prevista da operao na O.P.
Data final prevista da operao na O.P.
Hora de incio prevista da operao na O.P.
Hora de fim prevista da operao na O.P.
Cdigo do equipamento
* Se o movimento for automtico e valor for nulo ou 00/00/0000, retorna a data atual
** Se o movimento for automtico e DtrIni for nulo, retorna a hora atual. possvel informar no formato inteiro (minutos) ou HH:MM
*** Se o movimento for automtico e DtrFim for nulo, retorna a hora atual. possvel informar no formato inteiro (minutos) ou HH:MM
**** Se o movimento for automtico e DtpIni for nulo, retorna a hora atual. possvel informar no formato inteiro (minutos) ou HH:MM
***** Se o movimento for automtico e DtpFim for nulo, retorna a hora atual. possvel informar no formato inteiro (minutos) ou HH:MM
****** Este campo obrigatrio se a empresa estiver configurada para utilizar a parada por equipamento (E075EPR.IndPre = S), for
passado S no parmetro MovAut e o centro de recurso padro da operao for limitado por mquina (E725CRE.LimCap = M), caso contrrio ele no
deve ser informado.
Esta ao SID no suporta OS gerada a partir de uma ordem de manuteno.
Retorno:
"OK"
2.23 INTEGRAES CARTO PRESENTE

222222 GRAVAR CARTO PRESENTE
Ao:
SID.Int.GravarCartaoPresente (IVME)
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"
222222 CONSULTAR CARTO PRESENTE

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

Ao:
SID.Int.ConsumirCartaoPresente (IVME)
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
CarPre
VlrUti
Valor do carto presente a ser utilizado
DatRes
Data do resgate do valor do carto presente
Retorno:
"OK"
2.24
CONTROLADORIA TRIBUTOS PAF
222222 PAF ECF INTEGRA

Ao:
SID.Tri.PafEcfSIntegra
CodEmp
Cdigo da empresa
CodFil
Cdigo da filial
DatIni
Data Inicial
DatFim
Data Final
ArqLoc
Arquivo a ser Integrado
Retorno:
"OK"
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='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='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?SIS=CO&LOGIN=SID&ACAO=SID.SRV.XML&USER=...";
SapiensSIDEx(URL, XML, "", "", "", RETORNO);

Sapiens Sid

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Sapiens Sid

Uploaded by

Copyright:

Available Formats

Sapiens SID

1.1 AUTENTICAR (LOGIN/REGISTRO)

Nome ou IP do servidor web.

ERRO: Usurio ou senha invlido

1.2 EXECUTAR AES (SUBMETER REQUISIES)

1.3 AUTENTICAO EMBUTIDA

1.4 EXECUTAR SID ATRAVS DE SERVIO MC

@ Define o servio e porta @

1.5 NOTAS DE IMPLEMENTAO

2.1 AES UTILITRIAS

ALTERAR EMPRESA/FILIAL (USURIO ATIVO)

EXECUTAR REGRA INTERNA (REGRAS LSP)

IMPRIMIR RELATRIO (IMPRIMIR OU GERAR IMAGENS)

Nome ou compartilhamento da impressora, se desejar imprimir direto

IMPRIMIR BLOQUETOS (IMPRIMIR, GERAR IMAGENS E GERAR PDF)

Parmetros obrigatrios para bloquetos do comercial

(caso seja informado o parmetro "Impressora=...")

IMPRIMIR NOTAS FISCAIS DE SADA

OBTER INFORMAES DA CONEXO ATUAL (USO INTERNO)

ENCERRAR CONEXO ATUAL (SOMENTE SE INVOCADO VIA HTTP)

2.2 MERCADO PEDIDO DE VENDAS

GRAVAR CABECALHO PEDIDO (INCLUIR/ALTERAR)

Indicativo de como o pedido deve ser faturado (0 Sapiens; 1 ECF)

Nmero do pedido gerado

GRAVAR CABECALHO PEDIDO PREVISO (INCLUIR/ALTERAR)

Nmero do pedido gerado

GRAVAR ITEM DE PRODUTO (INCLUIR/ALTERAR)

Percentual do rateio da conta*

GRAVAR ITEM DE PRODUTO PREVISO (INCLUIR/ALTERAR)

GRAVAR ITEM DE SERVIO (INCLUIR/ALTERAR)

Cdigo do centro de custo

FECHAR PEDIDO PREVISO

EXCLUIR PEDIDO PREVISO

222222 EXCLUIR ITEM DE PRODUTO

222222 EXCLUIR ITEM DE PRODUTO PREVISO

222222 EXCLUIR ITEM DE SERVIO

222222 GRAVAR OBSERVAO (INCLUIR/ALTERAR)

Sequncia da observao do pedido

222222 EXCLUIR OBSERVAO

222222 LISTAR EMBALAGENS DO PEDIDO

222222 CONFIRMAR CONFERNCIA DA EMBALAGEM

222222 SUBSTITUIR EMBALAGEM

222222 ANALISAR ESTOQUE DE EMBALAGENS

222222 ANALISAR OBSERVAO DE BLOQUEIO POR REA

222222 GRAVAR PEDIDO VIA CONTRATO DE LICITAO

O formato do retorno para um determinado pedido com erro durante a importao :

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

O texto de retorno plano e sem quebras de linha.

222222 GRAVAR PEDIDO EM GRADE

A descrio de cada delimitador e sua funcionalidade ou obrigatoriedade est a seguir

O formato do retorno para um determinado pedido com erro durante a importao :

o nmero de Sequncia em que foi processado o pedido delimitado pelos delimitadores

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

o nmero de Sequncia em que foi processado o pedido delimitado pelos delimitadores

o nmero do pedido gerado pelo Sapiens

[motivo = 'motivo do erro no fechamento']

O texto de retorno plano e sem quebras de linha.

<codfxa>FAIXA DE CAL 01</codfxa>

222222 CANCELAR PEDIDO

222222 REGISTRAR IMPRESSO DAV/DAV-OS

2.3 SUPRIMENTOS COTAES

2.4 MERCADO NOTA FISCAL VENDA

GRAVAR CABEALHO DA NOTA FISCAL VENDA (INCLUIR)

Nmero da nota fiscal