Estrutura Analítica dos Campos - Serviço 306

Fatura

A coluna CPA/CRE indica se o campo é utilizado apenas para Contas a Pagar ou apenas para Contas a Receber. Caso não preenchida, o campo é válido para ambos.

	Obrigatório?		CPA/ CRE	Tipo	Tamanho
Tag	Insert	Up/Del	CPA/ CRE	Tipo	Tamanho	Descrição	Observação
Fatura
MOV_CH_ORIGEM	Sim	Sim		Alfanumérico	1	Origem do movimento
AGN_ST_CODIGO	Sim	Sim		Alfanumérico	18	Código do Agente	Pode ser informado com o código do agente, código alternativo do agente, CPF ou CNPJ do agente, conforme tipo de código informado no campo AGN_ST_TIPOCODIGO.
AGN_ST_TIPOCODIGO	Não	Não		Alfanumérico	3	Tipo do código do Agente	Preenchido com COD - Código / ALT - Código alternativo / CPF / CGC. Se não for informado assume tipo COD
AGN_TAU_ST_CODIGO	Não	Sim		Alfanumérico	1	Código da tabela auxiliar.	Só é obrigatório se a ação aceitar todos os tipos de agente
TPD_ST_CODIGO	Sim	Sim		Alfanumérico	10	Código do tipo de documento.	O tipo de documento é um cadastro do Mega, para definições de tipos de documentos e suas respectivas configurações utilizadas no módulo financeiro.
FAT_IN_NUMERO	Sim	Sim		Numérico	20	Número do documento principal.
FIL_IN_CODIGO	Sim	Sim		Numérico	7	Código da Filial
FAT_DT_EMISSAO	Sim	Não		Data		Data de Emissão da Fatura
FPA_DT_ENTRADA	Não	Não	Pagar	Data		Data de Entrada da Fatura
FAT_RE_VALOR	Sim	Não		Numérico	22,2	Valor da Fatura
ACAO_IN_CODIGO	Sim	Não		Numérico	3	Código de Ação	Deverá ser informado o código de ação referente ao processo de contas a pagar/receber. O código de ação é um cadastro do Mega que indica configurações referentes ao fluxo de informação que um documento/movimento percorrerá pela organização..
COND_ST_CODIGO	Não	Não		Alfanumérico	10	Condição de Pagamento	A condição de pagamento é um cadastro que indica as regras de definição de parcelas de uma fatura do financeiro. Se não for informado, será utilizada a condição configurada no agente.
IND_IN_CODIGOMOE	Não	Não		Numérico	3	Código da moeda utilizada no lançamento.
IND_IN_CODIGOIND	Não	Não		Numérico	3	Código do índice utilizado para correção de valores.
FAT_ST_SERIEDOC	Não	Não		Alfanumérico	5	Série de documento
COS_IN_CODIGO	Não	Não		Numérico	3	Código de serviço	Se este campo for informado, as retenções serão incluídas ou atualizadas, seguindo a configuração do código de serviço.
PDC_IN_CODIGO	Não	Não	Pagar	Numérico	6	Codigo do Pedido de Compra
FPA_ST_SOLICITANTE	Não	Não	Pagar	Alfanumérico	20	Solicitante da Fatura
FPA_ST_FAVORECIDO	Não	Não	Pagar	Alfanumérico	100	Favorecido da Fatura	Se não for informado, será utilizado o nome do agente
FAT_ST_DOCTOINTERNO	Não	Não		Alfanumérico	20	Número do documento Interno
SAP_ST_CODIGO	Não	Não	Pagar	Alfanumérico	10	Série de AP	Se não for informado, será utilizada a série padrão configurada nos parâmetros do financeiro
DRF_ST_CODIGO	Não	Não	Pagar	Alfanumérico	4	Código da DARF	Preenchido em caso de retenções
SER_ST_CODIGO	Não	Não	Receber	Alfanumérico	3	Série da Fatura
FPA_BO_PODEREPETIR	Não	Não	Pagar	Alfanumérico	1	Permite repetir número de fatura a pagar?	Preenchido com S - Sim / N - Não. Não utilizado para faturas a receber. Caso preenchido com N, o sistema validará se existe outra fatura com o mesmo tipo de documento e número de fatura (campos TPD_ST_CODIGO e FAT_IN_NUMERO respectivamente)
CALC_COT_RE_VALOR	Não	Não		Numérico	22,8	Cotação do índice financeiro	Se não for informado obtém a cotação da data de emissão da fatura
FAT_BO_VALORMOEDA	Não	Não		Alfanumérico	1	Valor em moeda?	Preenchido com S - Sim / N - Não. Se for vazio ou N significa que o valor já está em R$. Se for S converte com base no índice financeiro informado.
FAT_CH_SITUACAO	Não	Não		Alfanumérico	1	Situação da Fatura	Preenchido com N - Normal / C - Cancelado. Se não informado, a fatura possuirá situação Normal. Se informado C, todos os movimentos da fatura serão cancelados.
ACAOM_IN_SEQUENCIA	Não	Não		Numérico	1	Número Sequencial do Movimento	Se informado no update ou delete, o mesmo pode ajudar a encontrar a fatura correta que será atualizada ou excluída.
FAT_IN_NUMPARCELAS	Não	Não		Numérico	1	Número de parcelas	Se não informado, utiliza a quantidade da condição de pagamento, ou a quantidade defininda na tag de Parcelas..
USU_IN_INCLUSAO	Não	Não		Numérico	5	Usuário do Mega que realizou a inclusão	Se não informado, é utilizado o usuário de integração.
FPA_RE_BASEIR	Não	Não	Pagar	Numérico	22,8	Valor da base de IR	No caso de retenção de IR na baixa do documento para pessoa física, estes campos não são considerados, e a base de IR recebe o valor bruto do documento, enquanto o valor fica zerado para ser definido no momento da baixa.
FPA_RE_VALORIR	Não	Não	Pagar	Numérico	22,8	Valor de IR
FPA_RE_BASEISS	Não	Não	Pagar	Numérico	22,8	Valor da base de ISS
FPA_RE_VALORISS	Não	Não	Pagar	Numérico	22,8	Valor de ISS
FPA_RE_BASEINSS	Não	Não	Pagar	Numérico	22,8	Valor da base de INSS
FPA_RE_VALORINSS	Não	Não	Pagar	Numérico	22,8	Valor de INSS
FPA_ST_GARE	Não	Não	Pagar	Alfanumérico	10	Código de recolhimento da guia GARE
FPA_ST_GAREETIQUETA	Não	Não	Pagar	Alfanumérico	13	Dívida Ativa/Número Etiqueta da GARE
FPA_ST_GARENOTIFICACAO	Não	Não	Pagar	Alfanumérico	13	Número parcela/Notificação da GARE
FPA_ST_FGTS	Não	Não	Pagar	Alfanumérico	6	Código da receita FGTS
FPA_ST_FGTSLACRE	Não	Não	Pagar	Alfanumérico	12	Lacre do Conectividade Social (FGTS)
FPA_ST_FGTSIDENTIFICADOR	Não	Não	Pagar	Alfanumérico	16	Identificador do FGTS
FPA_ST_DARFREFERENCIA	Não	Não	Pagar	Alfanumérico	17	Número de referência do tributo (DARF)

Retenções do Contas a Pagar

As tags de retenções são preenchidas apenas para documentos de Contas a Pagar.
Para alteração de retenções, informar os novos valores, assim o serviço irá refazer os movimentos de retenções.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
RetencoesCPA
UF_ST_SIGLA	Não		Alfanumérico	2	UF para cálculo do ISS
MUN_IN_CODIGO	Não		Numérico	5	Município para cálculo do ISS
FPA_RE_BASEIR	Não		Numérico	22,2	Base de IR	No caso de retenção de IR na baixa do documento para pessoa física, estes campos não são considerados, e a base de IR recebe o valor bruto do documento, enquanto a alíquota e valor ficam zerados para serem definidos no momento da baixa.
FPA_RE_ALIQUOTAIR	Não		Numérico	5,2	Alíquota de IR
FPA_RE_VALORIR	Não		Numérico	22,2	Valor de IR
FPA_BO_DILUIIR	Não		Alfanumérico	1	Dilui IR nas parcelas
DRF_ST_CODIGOIR	Não		Alfanumérico	4	Código da DARF
AGN_IN_CODIGOIR	Não		Numérico	7	Código do agente de IR
AGN_PAD_IN_CODIGOIR	Não		Numérico	1	Código do padrão do agente de IR
AGN_TAU_ST_CODIGOIR	Não		Alfanumérico	1	Código da tabela auxiliar do agente de IR
FPA_RE_BASEISS	Não		Numérico	22,2	Base de ISS
FPA_RE_ALIQUOTAISS	Não		Numérico	5,2	Alíquota de ISS
FPA_RE_VALORISS	Não		Numérico	22,2	Valor de ISS
AGN_IN_CODIGOISS	Não		Numérico	7	Código do agente de ISS
AGN_PAD_IN_CODIGOISS	Não		Numérico	1	Código do padrão do agente de ISS
AGN_TAU_ST_CODIGOISS	Não		Alfanumérico	1	Código da tabela auxiliar do agente de ISS
FPA_BO_DILUIISS	Não		Alfanumérico	1	Dilui ISS nas parcelas
FPA_RE_BASEINSS	Não		Numérico	22,2	Base de INSS
FPA_RE_ALIQUOTAINSS	Não		Numérico	5,2	Alíquota de INSS
FPA_RE_VALORINSS	Não		Numérico	22,2	Valor de INSS
FPA_BO_DILUIINSS	Não		Alfanumérico	1	Dilui INSS nas parcelas
FPA_DT_COMPETENCIA	Não		Data		Data de competência de INSS
FPA_RE_BASEFUNRURAL	Não		Numérico	22,2	Base de FUNRURAL
FPA_RE_ALIQUOTAFUNRURAL	Não		Numérico	5,2	Alíquota de FUNRURAL
FPA_RE_VALORFUNRURAL	Não		Numérico	22,2	Valor de FUNRURAL
FPA_RE_BASESEST	Não		Numérico	22,2	Base de SEST/SENAT
FPA_RE_ALIQUOTASEST	Não		Numérico	5,2	Alíquota de SEST/SENAT
FPA_RE_VALORSEST	Não		Numérico	22,2	Valor de SEST/SENAT
FPA_BO_DILUISEST	Não		Alfanumérico	1	Dilui SEST/SENAT nas parcelas
RET_BO_CALCULAIR	Não		Alfanumérico	1	Indica se calcula IR.	Se for ‘N’ e os valores de IR forem 0, não recalcula. No caso de retenção de IR para pessoa física na baixa do documento, este campo não é considerado.
RET_BO_CALCULAISS	Não		Alfanumérico	1	Indica se calcula ISS.	Se for ‘N’ e os valores de ISS forem 0, não recalcula
RET_BO_CALCULAINSS	Não		Alfanumérico	1	Indica se calcula INSS.	Se for ‘N’ e os valores de INSS forem 0, não recalcula
RET_BO_CALCULASEST	Não		Alfanumérico	1	Indica se calcula SEST.	Se for ‘N’ e os valores de SEST forem 0, não recalcula

Parcela

Se a tag de Parcela não for informada, as parcelas da fatura serão geradas através da condição de pagamento.
A coluna CPA/CRE indica se o campo é utilizado apenas para Contas a Pagar ou apenas para Contas a Receber. Caso não preenchida, o campo é válido para ambos.

	Obrigatório?		CPA/ CRE	Tipo	Tamanho
Tag	Insert	Up/Del	CPA/ CRE	Tipo	Tamanho	Descrição	Observação
Parcela
MOV_ST_PARCELA	Sim	Sim		Alfanumérico	3	Parcela	Indica um número ou letra que representa a parcela na fatura. Exemplo com fatura com 3 parcelas: 001, 002 e 003 / A, B e C. Caso não informado, o sistema irá gerar este sequencial conforme regra configurada na condição de pagamento.
MOV_DT_VENCTO	Sim			Data		Data de vencimento
MOV_DT_PRORROGADO	Não			Data		Data de prorrogado	Se não informado, o campo recebe a data de vencimento.
MOV_RE_VALORMOE	Sim			Numérico	22,2	Valor
MOV_ST_DOCUMENTO	Não			Alfanumérico	20	Número do documento	Se não informado, o campo recebe o número do documento principal da fatura.
MOV_RE_PERCJUROSEFET	Não			Numérico	5,2	Percentual do juros para efeito de mora.	Campos utilizados para cálculo de juros no momento da baixa da parcela. Se um dos campos não for informado, o campo será calculado através do outro campo informado.
MOV_RE_VRMORAEFET	Não			Numérico	22,2	Valor de Mora Diária
MOV_RE_PERCMULTAEFET	Não			Numérico	5,2	Valor da multa com vencimento posterior a uma determinada data.	Campos utilizados para cálculo da multa no momento da baixa da parcela.
MOV_RE_VRMULTAEFET	Não			Numérico	22,2	Percentual de multa com vencimento posterior a uma determinada data
MOV_DT_DTBASEMULTA	Não			Data		Após esta data será cobrada a multa
MOV_RE_PERCDESCEFET	Não			Numérico	5,2	Percentual de Desconto	Campos utilizados para cálculo de descontos no momento da baixa da parcela.
MOV_RE_VRDESCCONDEFET	Não			Numérico	22,2	Valor do Desconto
MOV_DT_DTBASEDESC	Não			Data		Até esta data será concedido o desconto
MOV_RE_PERCDESCEFET2	Não			Numérico	5,2	Percentual de Desconto 2	Campos utilizados para cálculo do segundo desconto no momento da baixa da parcela.
MOV_RE_VRDESCCONDEFET2	Não			Numérico	22,2	Valor do Desconto 2
MOV_DT_DTBASEDESC2	Não			Data		Até esta data será concedido o desconto 2
TCOB_ST_CODIGO	Não			Alfanumérico	5	Código do tipo de cobrança.
HIS_IN_REDUZIDO	Não			Numérico	5	Código reduzido do histórico
MOV_ST_COMPLHIST	Não			Alfanumérico	500	Complemento de histórico
AGN_IN_CODIGOCTAPREV	Não			Numérico	7	Conta financeira prevista para pagamento/cobrança
BAN_IN_NUMERO	Não		Pagar	Numérico	3	Número do banco
CAID_BAN_IN_NUMERO	Não		Pagar	Numérico	3	Número do banco (depósito em conta)
CAID_ST_CONTACORR	Não		Pagar	Alfanumérico	20	Número da Conta Corrente
FORP_IN_CODIGO	Não		Pagar	Numérico	3	Forma de pagamento
PRIP_ST_CODIGO	Não		Pagar	Alfanumérico	10	Prioridade de pagamento
CPA_ST_CODIGOBARRAS	Não		Pagar	Alfanumérico	50	Código de barras	O campo deve receber somente números, sem caracteres não numéricos, exemplo: .(ponto) e espaço. O sistema não permitirá a gravação de um código de barras inválido.
CPA_ST_LINHADIGITAVEL	Não		Pagar	Alfanumérico	50	Linha digitável	O campo deve receber somente números, sem caracteres não numéricos, exemplo: .(ponto) e espaço.
CPA_ST_NOSSONUMBANC	Não		Pagar	Alfanumérico	25	Nosso número (Contas a pagar)
CRE_ST_NOSSONUMBANC	Não		Receber	Alfanumérico	25	Nosso número (Contas a receber)
HCOB_IN_SEQUENCIA	Não		Receber	Numérico	7	Forma de cobrança

Movimento Vinculado

Para alteração de movimentos vinculados, incluir no XML as operações de inclusão e exclusão, pois o serviço não fará tratamento de alteração para esta tag.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
MovtoVinculado
MOV_RE_VALOR	Sim		Numérico	22,2	Valor
MOV_DT_DATADOCTO	Sim		Data		Data	Data de emissão do movimento vinculado.
ACAO_IN_CODIGO	Sim		Numérico	3	Ação	Código da ação do cadastro de códigos de ação do Mega.
CLA_IN_REDUZIDO	Não		Numérico	7	Reduzido da classe
HIS_IN_REDUZIDO	Não		Numérico	7	Reduzido do histórico
ADIANT_MOV_ST_DOCUMENTO	Não		Numérico	20	Documento de adiantamento
ADIANT_MOV_RE_VALOR	Não		Numérico	22,2	Valor do Adiantamento
ADIANT_MOV_DT_DATADOCTO	Não		Data		Data do Adiantamento

Classe

Se tiver somente um registro, e não for informado o percentual ou valor, é inserido como 100%.

O rateio pode ser informado por valor ou percentual.
É recomendável utilizar o mesmo tipo de informação para todos os itens do rateio.
Por exemplo, se a classe for informada por percentual, informar também o centro de custo e projeto por percentual.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
Classe
CLA_IN_REDUZIDO	Depende		Numérico	7	Código Reduzido da Classe	Obrigatório se o campo CLA_ST_EXTENSO não estiver preenchido.
CLA_ST_EXTENSO	Depende		Numérico	7	Código Extenso da Classe	Obrigatório se o campo CLA_IN_REDUZIDO não estiver preenchido.
LCL_CH_NATUREZA	Não		Alfanumérico	1	Natureza da Classe
LCL_RE_VALORMOE	Depende		Numérico	22,2	Valor do Lançamento	Obrigatório se existir mais de um registro e se o campo LCL_RE_PERCENTUAL não estiver preenchido
LCL_RE_PERCENTUAL	Depende		Numérico	5,2	Percentual do Lançamento	Obrigatório se existir mais de um registro e se o campo LCL_RE_VALOR não estiver preenchido
LCL_ST_OBSERVACAO	Não		Alfanumérico	100	Observação do Lançamento

Centro de Custo

Se tiver somente um registro, e não for informado o percentual ou valor, é inserido como 100%.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
CentroCusto
CCF_IN_REDUZIDO	Sim		Numérico	7	Código Reduzido do Centro de Custo
LCC_RE_VALORMOE	Depende		Numérico	22,2	Valor do Lançamento	Obrigatório se existir mais de um registro e se o campo LCC_RE_PERCENTUAL não estiver preenchido
LCC_RE_PERCENTUAL	Depende		Numérico	5,2	Percentual do Lançamento	Obrigatório se existir mais de um registro e se o campo LCC_RE_VALOR não estiver preenchido
LCC_ST_OBSERVACAO	Não		Alfanumérico	100	Observação do Lançamento

Projeto

Se tiver somente um registro, e não for informado o percentual ou valor, é inserido como 100%.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
Projeto
PRO_IN_REDUZIDO	Sim		Numérico	7	Código Reduzido do Projeto
LPR_RE_VALORMOE	Depende		Numérico	22,2	Valor do Lançamento	Obrigatório se existir mais de um registro e se o campo LPR_RE_PERCENTUAL não estiver preenchido
LPR_RE_PERCENTUAL	Depende		Numérico	5,2	Percentual do Lançamento	Obrigatório se existir mais de um registro e se o campo LPR_RE_VALOR não estiver preenchido
LPR_ST_OBSERVACAO	Não		Alfanumérico	100	Observação do Lançamento

Baixa por Referência

A baixa por referência está disponível apenas para operação de inclusão.

	Obrigatório?		Tipo	Tamanho
Tag	Insert	Up/Del	Tipo	Tamanho	Descrição	Observação
BaixaRef
REF_TPD_ST_CODIGO	Depende		Alfanumérico	10	Tipo de documento	Campos obrigatórios se o documento que está sendo baixado por referência não existe no sistema
REF_ST_NUMERONF	Depende		Alfanumérico	20	Número do documento
REF_DT_EMISSAONF	Depende		Data		Data de emissão
REF_RE_VALORNF	Depende		Numérico	22,2	Valor do documento
REF_ST_OBSERVACAO	Não		Alfanumérico	100	Observação do documento
REF_ORG_IN_CODIGO	Depende		Numérico	7	Código da Organização	Campos obrigatórios se o documento que está sendo baixado por referência já existe no sistema
REF_MOV_SEQ_IN_CODIGO	Depende		Numérico	3	Sequencial do documento
REF_MOV_IN_NUMLANCTO	Depende		Numérico	8	Identificador do documento

Observações

Os campos com a coluna Update/Delete preenchida são usados para localizar o registro. Todos os outros são usados para alterar o valor do campo.
As tags de rateio (Classe, CentroCusto e Projeto) correspondem ao rateio total da fatura, e não das parcelas, ou seja, a somatória dos valores do rateio informado deve ser igual ao valor total da fatura..
Se todos os documentos que estão sendo baixados por referência já existirem no sistema, o node de rateio será opcional, pois o serviço poderá montar o rateio da fatura com base nos rateios dos documentos que estão sendo baixados por referência.
Ao alterar o rateio da fatura, os rateios de centro de custo e projeto dos movimentos vinculados às parcelas também serão atualizados.