Pular para conteúdo

Rascunho de resposta — carga do eCosIF AV (VB6) → eCosIF QW4

Boa tarde,

Seguem os esclarecimentos sobre o fluxo recomendado para carregar no eCosIF QW4 os lançamentos provenientes do eCosIF AV (versão VB6).


1. O QW4 já possui endpoint/API de carga compatível com os dados do AV?

Não no sentido de um endpoint que consuma o formato/exportação nativa do AV (VB6) ou que receba tudo de uma vez (cadastros + saldos + lançamentos do período em um único payload).

Para a carga diária de lançamentos, o QW4 possui API de importação no contrato do eCosIF atual, inclusive em JSON (item 2). Os dados saídos do AV precisam ser transformados para esse contrato.


2. Endpoint, documentação, payload, validações e pré-requisitos

Item Valor
Endpoint POST /importMovimentJson?fileName={NOME}.IPL
Serviço moviments ({base-moviments})
Content-Type application/json
Auth Authorization: Bearer <token> (serviço a serviço)
Unidade um dia de movimento por chamada
fileName obrigatório; padrão FUNDO_YYYYMMDD.IPL (fundo 5–8 caracteres). Ex.: FND01_20260302.IPL

Pré-requisitos: empresa/filial existentes no QW4; contas e históricos do payload cadastrados; calendário/competência abertos; token válido.

Validações principais: data única e coerente com o fileName; conta/histórico existentes; tipo 1 (simples, com D/C) ou 2 (com contrapartida). Recusa → HTTP 400.

No fluxo atual, o conteúdo do arquivo IPL é transformado em JSON e a importação é executada a partir desse JSON. Após gravar os lançamentos válidos, a mesma chamada executa consolidação, cota e fechamento do dia.

Para a integração sem gerar/guardar o arquivo IPL, basta chamar diretamente POST /importMovimentJson, enviando vários lançamentos em um único JSON no padrão abaixo:

POST {base-moviments}/importMovimentJson?fileName=FND01_20260302.IPL
Authorization: Bearer eyJhbGciOi...
Content-Type: application/json

Exemplo de payload (fictício):

{
  "company": "000000001",
  "branch": "000000001",
  "lots": [
    {
      "lotCode": "000001",
      "year": "2026",
      "month": "03",
      "documents": [
        {
          "entrys": [
            {
              "entryCode": "1",
              "lineNo": 1,
              "movimentDate": "2026-03-02",
              "typeEntry": "2",
              "debitCredit": " ",
              "contaNo": "111010",
              "history": "0001",
              "conterpartNo": "211010",
              "conterpartHistory": "0001",
              "value": 1000.00
            }
          ]
        }
      ]
    }
  ],
  "rejectedLines": []
}

Campos principais: company/branch; lotCode; movimentDate (AAAA-MM-DD, única na carga); typeEntry (1 = simples com D/C, 2 = com contrapartida); contaNo, history, value; no tipo 2, conterpartNo e conterpartHistory.

Alternativa equivalente (quando a origem já produz o arquivo texto): POST /importMoviment/{empresa}/{filial}/{arquivo} com corpo text/plain (layout IPL posicional — formato histórico de carga do eCosIF). Internamente esse caminho também converte o IPL em JSON e segue o mesmo processamento.

3. Caso não exista API pronta para o formato do AV, qual a abordagem recomendada?

Não há API que aceite o export/layout nativo do AV (VB6). A abordagem recomendada é:

  1. Preparar o fundo no QW4 (cadastros, calendário, saldos iniciais se necessário — item 4).
  2. Extrair do AV os lançamentos do dia (contas, históricos, valores, data, lote).
  3. Transformar esses dados para o JSON do item 2.2 (ou, se preferirem arquivo, para o IPL texto do item 2.1).
  4. Enviar com POST /importMovimentJson?fileName=... um dia por vez.
  5. Tratar HTTP 400 e rejeições por linha/conta/histórico; repetir ou corrigir cadastro conforme o erro.

Para volume e integração sistema a sistema, não recomendamos Digitação (lote/documento/lançamento um a um): a importação JSON (ou IPL) já grava o movimento e processa saldos/cota/fechamento do dia na mesma chamada.

4. Além dos lançamentos — 1ª inclusão no QW4

Sim. A importação não cria fundo, plano de contas nem históricos no QW4.

Atalho (bootstrap)

POST {base-masterdata}/company
Content-Type: application/json

{
  "fiscalName": "Fundo Exemplo FIC FI",
  "communName": "Fundo Exemplo",
  "createBranchAndOptions": true,
  "initialYearMonth": "03/2026"
}

Cria empresa, filial, opções, calendário, configs básicas e saldos iniciais zerados.

Passo a passo (1ª inclusão)

# Objetivo Path
1 Empresa POST {base-masterdata}/company
2 Filial POST {base-masterdata}/branch
3 Opções do fundo POST {base-masterdata}/company/options
4 Calendário POST {base-masterdata}/calendar/{company}/{branch}
5 Cota / patrimônio POST {base-masterdata}/quotacalculation/
6 Parâmetros de fundo / COSIF POST {base-masterdata}/fund/settings
7 Plano de contas (se faltar) POST {base-masterdata}/chartOfAccounts
8 Históricos POST {base-masterdata}/history
9 Mês corrente (se necessário) POST {base-masterdata}/monthOpening/{company}/{branch}
10 Movimento do dia POST {base-moviments}/importMovimentJson?fileName=...

Se a migração/carga partir de fundo já em andamento no AV, alinhar saldo inicial no QW4 antes da 1ª importação. Contas/históricos do JSON precisam existir antes do passo 10.


5. Processamento após a importação

Na importação bem-sucedida, não há ação operacional extra no dia: consolidação, saldos, cota e fechamento do dia rodam na mesma API.

Na virada de mês: POST .../monthOpening/{company}/{branch} antes de importar o novo mês.
POST .../runconsolidation = consolidação avulsa/correção (não é o fluxo diário normal).


6. Ordem obrigatória

Sim.

1ª inclusão: cadastro do fundo / opções → calendário → (plano e históricos, se faltarem) → saldos iniciais (se aplicável) → mês corrente → lançamentos via importação → processamento (embutido na importação).

Dia a dia: extrair do AV → transformar → importMovimentJson.


7. Resumo — o que obter do AV e o que executar no QW4

Do AV (VB6), por dia: data, contas (débito/crédito ou conta + contrapartida), históricos, valores e identificação de lote/lançamento — o necessário para montar o JSON do item 2.
Na carga inicial: também o saldo de abertura (se não partir do zero) e a garantia de que plano/históricos usados no AV existem (ou serão cadastrados) no QW4.

No QW4:
1. 1ª inclusão / abertura do fundo (itens 4 e 6);
2. transformação AV → JSON;
3. POST /importMovimentJson por dia;
4. na virada de mês, abertura da competência.


Fechamento

O contrato da integração deve contemplar não só o lançamento, e sim: pré-cadastro no QW4, mapeamento/transformação a partir do AV (VB6), carga diária autenticada e processamento já embutido na importação.

Podemos enviar em seguida o OpenAPI e exemplos de sucesso/rejeição, e alinhar os hosts {base-masterdata} / {base-moviments} do ambiente de vocês.

Atenciosamente,
José


Notas internas (não enviar)

  • AV = eCosIF VB6; QW4 = eCosIF atual (não é “sistema Regente externo” — ajustar menção a “Regente” se for só nome de ambiente/cliente)
  • [ ] Confirmar hosts e se o gateway expõe importMovimentJson ou só o IPL texto
  • [ ] Política de saldo inicial na migração AV → QW4