Linha Microsiga Protheus

Árvore de páginas

CONTEÚDO

  1. Visão Geral
  2. Método
  3. Tabelas utilizadas

01. VISÃO GERAL

Essa documentação visa apresentar o modelo de dados a ser seguido para consumo da API Balancete Modelo1 (CTBR040).       

02. Método

Header

KeyValueObrigatórioOBS:
Content-Typeapplication/jsonXN/A
  • model1 @Post (Busca saldos de acordo com os parâmetros enviados)

EndPoint: Caminho do serviço REST Protheus + /api/ctb/balance/model1 Ex.: http://localhost:9090/api/ctb/balance/model1

Body

Deverá ser enviado no formato Json de acordo com modelo a seguir


CampoDescriçãoTipoObrigatórioObservação
GRUPO_EMPRESAGrupo de empresa que será realizada a extraçãoCaractereSIM

Grupo de empresa na qual serão extraídos os dados.

*Obrigatório somente quando não enviado CNPJ (TECHFIN).

CNPJCNPJ a qual o grupo de empresa pertenceCaractereSIM

tamanho 8 sem traços ou pontuação.

*Obrigatório somente quando não enviado GRUPO_EMPRESA.

**Os oito primeiros números representam a raiz do CNPJ. É a identificação única de cada empresa.

FILIALFilial ou filiais a ser consideradas na extraçãoCaractereSIM

Concatenação dos campos Empresa+Unidade de Negócio+Filial 

Enviadas separadas por caractere ";" 

Ex.: "D MG 01 "
Ex.2: "D MG 01 ;D MG 02 "

*Caso enviado Cnpj o campo não será obrigatório e a extração ocorrerá para todas as Filiais da inscrição do CNPJ (TECHFIN).

DATA_INICIAL Informe a Data Inicial a partir da qual deseja extrair os saldos.CaractereSIMData enviada em formato caractere ddmmaaaa ex: "01/01/2023"
DATA_FINALInforme a Data Final a partir da qual deseja extrair os saldos.CaractereSIMData enviada em formato caractere ddmmaaaa ex: "31/10/2023"
CONTA_INICIALInforme a conta Inicial a partir da qual deseja extrair os saldos.CaractereNÃO" "→ default 
CONTA_FINALInforme a conta final até a qual deseja extrair os saldos.CaractereNÃO"ZZZZZZZZZZ"→ default 
IMPRIME_CONTASInforme se deseja imprimir as ContasNuméricoNÃO

Enviar somente o número identificador:

1              (Sintéticas)
2              (Analíticas)
3              (Ambas)  → default 

COD_CONFIG_LIVROSDetermine qual a configuração de Livro será utilizada.CaractereNÃO

Se não desejar nenhuma configuração específica deixe este campo em branco.

Se o Livro escolhido tiver uma Visão Gerencial associada, a Visão é que será impressa.

SALDOS_ZERADOSInforme se deseja que as contas com     saldos zerados sejam impressas ou não.NuméricoNÃO

Enviar somente o número identificador:

1              (Sim) → default

2              (Não)

MOEDAInforme o código da moeda na qual deseja extrair os saldos.CaractereNÃO01 → default
TIPO_DE_SALDOInforme qual o tipo de saldo que deseja extrair os saldos.CaractereNÃO1 → default
FILTRA_SEGMENTO_NOInforme qual o segmento da máscara contábil que se deseja filtrarCaractereNÃO

Se não for informado nenhum "Cod Conf Livros", não será possível filtrar o segmento da máscara.

Os próximos 3 parâmetros são dependentes deste.
Se na pergunta "Cod Conf Livros" for escolhida uma Configuração que possua uma Visão Gerencial associada, esta pergunta será desprezada.

CONTEUDO_INI_SEGMENInforme o conteúdo inicial do segmento de máscara contábil a ser filtrado na extração dos saldos.CaractereNÃOEsta pergunta depende da resposta da pergunta "Filtra Segmento No.?"
CONTEUDO_FIM_SEGMENInforme o conteúdo final do segmento de máscara contábil a ser filtrado na extração dos saldos.CaractereNÃOEsta pergunta depende da resposta da pergunta "Filtra Segmento No.?"
CONTEUDO_CONTIDO_EMInforme quais os conteúdos a serem filtrados.CaractereNÃO

Esta opção é válida para casos onde os conteúdos a serem filtrados não são sequenciais. Separe-os por "/".
Ex: 001/004/010

Se for preenchida esta pergunta as perguntas "Conteúdo Ini Segmen" e "Conteúdo Fim Segmen" serão desprezadas.

Esta pergunta depende da resposta de "Filtra Segmento No.?"

IMPRIME_COLUNA_MOVInforme se deseja que a coluna de Movimento do períodoNuméricoNÃO

Enviar somente o número identificador:

1              (Sim) → default

2              (Não)

IMPRIME_CODIGOFormato de extração do código da entidadeNuméricoNÃO

Enviar somente o número identificador:

1         (Normal) → default
2         (Reduzido)

DIVIDE_PORInforme se deseja que os valores dos saldos sejam divididos NuméricoNÃO

Enviar somente o numero identificador:

1          (Não se aplica (não divide)) → default

2          (Cem)
3          (Mil)
4          (Milhão)

POSICAO_ANT_L_PIndique se deseja que os valores a serem extraídos irão considerar ou não os lançamentos da Apuração de ResultadosNuméricoNÃO

Enviar somente o numero identificador:

1          (Sim)

2          (Não)  → default 

DATA_LUCROS_PERDASInforme a data de Apuração de Resultado que deseja desconsiderarCaractereNÃO

Data enviada em formato caractere ddmmaaaa ex: "29/08/2022"

Esta pergunta depende da resposta à pergunta "Posição Ant L/P?".

IGNORA_SL_ANT_REC_DESInforme se deseja ignorar o saldo anterior das contas de receitas/despesas de acordo com o grupo e a data escolhida nos dois parâmetros abaixoNuméricoNÃO

Enviar somente o número identificador:

1              (Sim) 

2              (Não) → default

GRUPOS_RECEITAS_DESPESASInforme quais os grupos de receitas/ despesas que deverão ter seus saldos anteriores ignorados. CaractereNÃOEssa pergunta será considerada somente se a pergunta 'Ignora Sl Ant. Rec/Desp' estiver preenchida com 'Sim'.
DATA_SLD_ANT_RECEITAS_DESPInforme qual a data que as contas de receitas/despesas terão seus saldos anteriores ignorados. CaractereNÃO

Data enviada em formato caractere ddmmaaaa ex: "29/08/2022"

Essa pergunta será considerada somente se a pergunta 'Ignora Sl Ant.Rec/Desp?' estiver preenchida com 'Sim'.

PAGENúmero da página de resultadosNuméricoNÃOPor default será enviado o resultado geral do relatório sem filtros de paginação
PAGESIZEQuantidade total da página de resultadosNuméricoNÃOPor default será enviado o resultado geral do relatório sem filtros de paginação
TECHFINIdentificador se a requisição é da integração TECHFIN  NuméricoNÃO

Enviar somente o número identificador:

1              (Sim) 

2              (Não) → default

QUEBRA_POR_NATUREZANÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
IMP_QUADROS_CONTABEISNÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
IMPRIME_CODIGONÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
IMPRIME_VALOR_0NÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
SALTA_LINHA_SINTNÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
IMPRIMIR_ATE_O_SEGNÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
DESCRICAO_NA_MOEDANÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
FOLHA_INICIALNÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
NUM_LINHAS_P_O_BALANCETENÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API
SELECIONA_FILIAISNÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA APINÃO UTILIZADO VIA API


Exemplo de Envio

Exemplo de Envio
{	
    "CNPJ":"53113791",
    "DATA_INICIAL": "01/01/2023",
	"DATA_FINAL": "31/12/2023",
	"TECHFIN" : 1
}

Exemplo de Resposta

Exemplo de resposta 
{
    "items": [
        {
            "conta": "CTBXATUC",
            "condicao_normal": "2",
            "superior": "",
            "classe": "2",
            "natureza": "01",
            "descricao": "REAL",
            "saldo_anterior": 0,
            "debito": 0,
            "credito": 1600.6,
			"conta_referencial": "",
            "descricao_referencial": "",
            "saldo_atual": 1600.6,
            "movimento": 1600.6,
		 	"competencia": "12/2023",
			"status": "Aberto"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0,
    "po_sync_date": "2023-09-29T19:13:15Z"
}

OBS.: *Parâmetros competência e status retornaram somente para a integração Techfin.

Importante

(TECHFIN*)  Ao enviar mais de uma filial o sistema irá retornar as informações referentes a status e contas referenciais com base na filial logada e com base no plano referencial ativo que atenda a data inicial e final enviada (Primeira Filial enviada no parâmetro FILIAL).


OBS: Será lançado para o release 12.1.2310

03. TABELAS UTILIZADAS

  • CT1- Plano de Contas
  • CQ0- Saldo por Conta no Mês
  • CQ1- Saldo por Conta no Dia        
  • CVN - Plano de Contas Referencial
  • CVD - Plano de Contas Referenciais  
  • CTG - Calendário Contábil