As tabelas abaixo são divididas da seguinte maneira: - Campo: Identificação do campo no Json.
- Identificador: Identificação do campo no banco de dados RM correspondente ao campo Json.
- Tipo: Tipo de valor aceito no campo, podendo ser numérico (Int, Decimal), condicionais (Boolean), texto (String, Datetime), além do tipo List, para esse último, é esperado uma nova sequência de dados (Bloco interno).
- Descrição: Fornece uma descrição do campo.
- Obrigatório: Especifica se a informação é obrigatória durante operações de envio (POST, PUT, PATCH). Caso a informação seja obrigatória condicionalmente essa informação será descrita no campo Observação.
- Observação: Informações condicionais ou importantes para o funcionamento da API serão apresentadas nesse campo.
| Informações |
|---|
| | Expandir |
|---|
| | LANÇAMENTO |
|---|
| Campo | Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
| operationId | IDOPERACAO | Int | Identificador de Operação | | Uso interno do Sistema | | reversal | ESTORNO | Boolean | Lançamento de Estorno | - | Uso interno do Sistema | | companyId | CODCOLIGADA | Int | Coligada | POST, PUT, PATCH |
| | entryId | IDLANCAMENTO | Int | Id do Lançamento | POST, PUT, PATCH | No caso de Inserção de lançamento, o valor informado deve ser zero (0). | | batchCode | CODLOTE | Int | Código do Lote | POST, PUT, PATCH |
| | description | DESCRICAO | String | Descrição do Lançamento | POST, PUT |
| | approvalUserId | CODUSUARIOAPROVACAO | String(20) | Código do usuário que aprovou o lançamento (para o lote 0[zero]) | - | Apenas informativo e não poderá ser valorado via inclusão e/ou alteração então caso informado (métodos POST, PUT, PATCH o sistema o desconsiderará). | | approvalDate | DATAAPROVACAO | DateTime | Data em que o lançamento foi aprovado (para o lote 0[zero]) | - | Apenas informativo e não poderá ser valorado via inclusão e/ou alteração então caso informado (métodos POST, PUT, PATCH o sistema o desconsiderará). | | accountEntry | PARTIDA | List | Partidas | POST, PUT | Não é possível inserir lançamento sem partidas. |
|
|
| Informações |
|---|
| | Expandir |
|---|
| No método PUT (Alteração de lançamento), é possível realizar inclusões, alterações e exclusões de partidas. Para isso, é necessário seguir os seguintes procedimentos: - Alteração: Deve-se informar a chave da partida (entryNumberId) que deseja modificar.
- Inclusão: Ao passar a chave (entryNumberId) com o valor zero (0), o sistema interpretará como uma inserção de nova partida.
- Exclusão: As partidas não incluídas na requisição do método PUT serão removidas do lançamento.
PARTIDA (accountEntry) |
|---|
Campo | Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
| entryNumberId | IDPARTIDA | Int | Identificador da Partida | POST, PUT, PATCH | 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 | POST, PUT |
| | branchName | NOMEFILIAL | String | Descrição Filial | - | Campo somente para leitura | | costCenterCode | CODCCUSTO | String | Código do Centro de Custo | - |
| | document | DOCUMENTO | String | Documento | Condicional | Obrigatório quando parametrizado. | | date | DATA | DateTime | Data | POST, PUT | A data deve estar dentro do período contábil atual. | | dateInclusion | DATAINCLUSAO | DateTime | Data da inclusão do lançamento | - | 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 | Condicional | Obrigatório se tiver conta Débito | | debitAccount | CodContaDebito | String | Cód. conta débito | Condicional | Obrigatório pelo menos uma conta de débito ou crédito | | debitDescription | DescricaoDebito | String | Descrição da Conta Débito | - | Campo somente para leitura | | companyIdCreditAccount | CodColCredito | Int | Coligada da Conta a Crédito | Condicional | Obrigatório pelo menos uma conta de débito ou crédito | | creditAccount | CodContaCredito | String | Cód. conta crédito | Condicional | Obrigatório se tiver conta Crédito | | creditDescription | DescricaoCredito | String | Descrição da Conta Crédito | - | Campo somente para leitura | | companyIdAgainstEntry | CodColContraPartida | Int | Coligada da Conta Contra Partida | - |
| | value | VALOR | Decimal | Valor | POST, PUT | O valor informado deve ser maior que zero. | | value2 | VALOR2 | Decimal | Segundo Valor | - |
| | date2 | DATA2 | Data | Data da Cotação do Segundo Valor | - |
| | integrateApplication | IntegraAplicacao | String | Aplicação que Gerou o Lançamento. | - | Campo de controle interno. | | generationType | TipoGeracao | String | Tipo de Geração | - | Campo de controle interno. | | historicCode | CODHISTP | String | Histórico | - |
| | 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 | Condicional | Obrigatório para conta débito que exige rateio | | apportionmentCredit | RateioCredito | List | Rateio Credito | Condicional | Obrigatório para conta crédito que exige rateio | | valuesCurrencies | MoedaValores | List | MultiMoedas | - |
| | apportionmentValuesCurrencies | RateioMoedasValores | List | Rateio MultiMoedas | - |
|
|
|
| Informações |
|---|
| | 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 | PUT, PATCH | Deve ser suprimido nas inserções, o sistema irá gerar automaticamente. Veja exemplo no método POST. | | lctref | LCTREF | Int | Referência do Lançamento | PUT, PATCH | Deve ser suprimido nas inserções, o sistema irá gerar automaticamente. Veja exemplo no método POST. | | idpartida | IDPARTIDA | Int | Identificador da Partida | PUT, PATCH | Deve ser suprimido nas inserções, o sistema irá gerar automaticamente. Veja exemplo no método POST. | | ? | ? | ? | Campo Complementar | PUT, POST, PATCH | O campo complementar deve ser informado no arquivo JSON tal como está cadastrado no RM, o seu valor deve respeitar o tipo definido. |
|
|
| Informações |
|---|
| | Expandir |
|---|
| title | Rateios Credito/Debito |
|---|
| 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, o rateio deve ser explicitamente enviado na requisição para este caso. No método PUT (Alteração de lançamento), é possível realizar inclusões, alterações e exclusões de rateios. Para isso, é necessário seguir os seguintes procedimentos: - Alteração: Deve-se informar a chave do rateio (apportionmentId) que deseja modificar.
- Inclusão: Ao passar a chave (apportionmentId) com o valor zero (0), o sistema interpretará como uma inserção de novo rateio.
- Exclusão: Os rateios não incluídos na requisição do método PUT serão removidos do lançamento.
| RateioDebito (apportionmentDebit) / RateioCredito(apportionmentCredit) |
|---|
| Campo | Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
| companyId | CODCOLIGADA | Int | Coligada do Rateio | POST, PUT |
| | date | DATA | DateTime | Data do Lançamento do Rateio | POST, PUT |
| | companyIdAccountManagement | CODCOLCONTA | Int | Código da Coligada da Conta Contábil | POST, PUT |
| | accountManagementInactive | ATIVO | Int | Status | - |
| | accountManagementCode | CODCONTA | String | Código da Conta | POST, PUT |
| | apportionmentId | IDRATEIO | Int | Identificador do Rateio | POST, PUT, PATCH | Na inserção, pode ser enviado como zero (0) ou suprimir. | | entryNumberId | IDPARTIDA | Int | Identificador da Partida | PUT | Na inserção, pode ser enviado como zero (0) ou suprimir. | | value | VALOR | Decimal | Valor | POST, PUT |
| | percentual | PERCENTUAL | String | Porcentagem do Rateio | - | Campo calculado pelo sistema. |
|
|
| Informações |
|---|
| | Expandir |
|---|
| Para contas que possuem configurações de conversão de multimoeda, como Taxa Histórica, Taxa Média Histórica e Taxa de Fechamento, os valores de multimoeda são automaticamente gerados com base na cotação correspondente. No caso de conversão multimoeda do tipo Fixa, o valor deve ser informado manualmente. | MoedaValores(valuesCurrencies) |
|---|
| Campo | Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
| companyId | CODCOLIGADA | Int | Coligada Moeda | POST, PUT, PATCH |
| | entryNumberId | IDPARTIDA | Int | Identificador da Partida | POST, PUT, PATCH |
| | currency | MOEDA | String | Símbolo da Moeda | POST, PUT, PATCH |
| | value | VALOR | Decimal | Valor Moeda | POST, PUT, PATCH |
|
|
|
| Informações |
|---|
| | Expandir |
|---|
| | Âncora |
|---|
| RateioMultimoeda |
|---|
| RateioMultimoeda |
|---|
|
Os campos abaixo não podem ser manipulados pelo requisitante, eles são calculados de acordo com o rateio gerencial da conta. | RateioMoedasValores(apportionmentValuesCurrencies) |
|---|
| Campo | Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
| companyId | CODCOLIGADA | Int | Coligada | - | Gerado pelo sistema | | apportionmentId | IDMULTIMOEDA | Int | Identificador de MultiMoeda | - | Gerado pelo sistema | | currency | MOEDA | String | Moeda utlizada no rateio multi moeda. | - | Gerado pelo sistema | | value | VALOR | Decimal | Valor do rateio convertido para moeda cadastrada. | - | Calculado pelo sistema |
|
|
|
