Histórico da Página

...

Informações

title	Parâmetros

Informações

icon	false

Expandir

title	Lançamento

LANÇAMENTO
Campo	Identificador	Tipo	Descrição	Obrigatório	Observação
operationId	IDOPERACAO	Int	Identificador de Operação	Não	Uso interno do Sistema
reversal	ESTORNO	Boolean	Lançamento de Estorno	Não	Uso interno do Sistema
companyId	CODCOLIGADA	Int	Coligada	Sim
entryId	IDLANCAMENTO	Int	Id do Lançamento	Sim	No caso de Inserção de lançamento, o valor informado deve ser zero (0).
batchCode	CODLOTE	Int	Código do Lote	Sim
description	DESCRICAO	String	Descrição do Lançamento	Sim
accountEntry	PARTIDA	List	Partidas	Sim	Não é possível inserir lançamento sem partidas.

Informações

icon	false

Expandir

title	Partida

Âncora

	partida
	partida

PARTIDA (accountEntry)
Campo	Identificador	Tipo	Descrição	Obrigatório	Observação
entryNumberId	IDPARTIDA	Int	Identificador da Partida	Sim	No caso de Inserção de lançamento (POST), ou inserção de nova partida em lançamento já existente (PUT) o valor do campo deve ser zero (0).
branchId	CODFILIAL	Int	Filial	Sim
branchName	NOMEFILIAL	String	Descrição Filial	Não	Campo somente para leitura
date	DATA	DateTime	Data	Sim	A data deve estar dentro do período contábil atual.
dateInclusion	DATAINCLUSAO	DateTime	Data da inclusão do lançamento	Não	Uso interno do sistema, a data será preenchida com a data da inclusão do lançamento.
companyIdDebitAccount	CodColDebito	Int	Coligada da Conta a Débito	-	Obrigatório se tiver conta Débito
debitAccount	CodContaDebito	String	Cód. conta débito	-	Obrigatório pelo menos uma conta de débito ou crédito
debitDescription	DescricaoDebito	String	Descrição da Conta Débito	Não	Campo somente para leitura
companyIdCreditAccount	CodColCredito	Int	Coligada da Conta a Crédito	-	Obrigatório pelo menos uma conta de débito ou crédito
creditAccount	CodContaCredito	String	Cód. conta crédito	-	Obrigatório se tiver conta Crédito
creditDescription	DescricaoCredito	String	Descrição da Conta Crédito	Não	Campo somente para leitura
companyIdAgainstEntry	CodColContraPartida	Int	Coligada da Conta Contra Partida	Não
value	VALOR	Decimal	Valor	Sim	O valor informado deve ser maior que zero.
value2	VALOR2	Decimal	Segundo Valor	Não
date2	DATA2	Data	Data da Cotação do Segundo Valor	Não
integrateApplication	IntegraAplicacao	String	Aplicação que Gerou o Lançamento.	Não	Campo de controle interno.
generationType	TipoGeracao	String	Tipo de Geração	Não	Campo de controle interno.
user	Usuario	String	Usuário que incluiu lançamento	-	Será gravado o usuário que enviou a requisição.
complementaryFields	CamposComplementares	List	Complemento	-
apportionmentDebit	RateioDebito	List	Rateio Debito	-	Obrigatório para conta débito que exige rateio
apportionmentCredit	RateioCredito	List	Rateio Credito	-	Obrigatório para conta crédito que exige rateio
valuesCurrencies	MoedaValores	List	MultiMoedas	-
apportionmentValuesCurrencies	RateioMoedasValores	List	Rateio MultiMoedas	-

Informações

icon	false

Expandir

title	Campos Complementares

Âncora

	CamposComplementares
	CamposComplementares

Os campos complementares são adaptados para atender às necessidades específicas de cada sistema.
Abaixo, listamos somente os campos obrigatórios que devem ser preenchidos quando há informações adicionais.

CamposComplementares (complementaryFields)
Campo	Identificador	Tipo	Descrição	Obrigatório	Observação
codlote	CODLOTE	Int	Código do lote atual	Sim
lctref	LCTREF	Int	Referência do Lançamento	Sim
idpartida	IDPARTIDA	Int	Identificador da Partida	Sim

Informações

icon	false

Expandir

title	Rateios Credito/Debito

Âncora

	RateioDebito
	RateioDebito

Contas que exigem rateio devem ter a lista de rateio fornecida. Na inclusão (método POST), se uma conta possui um rateio padrão, o sistema utilizará esses dados automaticamente, caso a lista de rateio não seja enviada. No entanto, este comportamento não é aplicado durante alterações (método PUT); portanto. Portanto, o rateio deve ser explicitamente enviado na requisição para este caso.

RateioDebito (apportionmentDebit) / RateioCredito(apportionmentCredit)
Campo	Identificador	Tipo	Descrição	Obrigatório	Observação
companyId	CODCOLIGADA	Int	Coligada do Rateio	Sim
date	DATA	DateTime	Data do Lançamento do Rateio	Sim
companyIdAccountManagement	CODCOLCONTA	Int	Código da Coligada da Conta Contábil	Sim
accountManagementInactive	ATIVO	Int	Status	Sim
accountManagementCode	CODCONTA	String	Código da Conta	Sim
apportionmentId	IDRATEIO	Int	Identificador do Rateio	Sim
entryNumberId	IDPARTIDA	Int	Identificador da Partida	Sim
value	VALOR	Decimal	Valor	Sim
percentual	PERCENTUAL	String	Porcentagem do Rateio	Não	Campo calculado pelo sistema.

Informações

icon	false

Expandir

title	Multimoeda

Âncora

	Multimoeda
	Multimoeda

MoedaValores(valuesCurrencies)
Campo	Identificador	Tipo	Descrição	Observação
companyId	CODCOLIGADA	Int	Coligada Moeda	Obrigatório
entryNumberId	IDPARTIDA	Int	Identificador da Partida	Obrigatório
currency	MOEDA	String	Símbolo da Moeda	Obrigatório
value	VALOR	Decimal	Valor Moeda	Obrigatório

Informações

icon	false

Expandir

title	Rateio Multimoeda

Âncora

	RateioMultimoeda
	RateioMultimoeda

RateioMoedasValores(apportionmentValuesCurrencies)
Campo	Identificador	Tipo	Descrição	Observação
companyId	CODCOLIGADA	Int	Coligada	Obrigatório
apportionmentId	IDMULTIMOEDA	Int	Identificador de MultiMoeda	Obrigatório
currency	MOEDA	String	Moeda utlizada no rateio multi moeda.	Obrigatório
value	VALOR	Decimal	Valor do rateio convertido para moeda cadastrada.	Obrigatório

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 23

Nova versão 24

Chave