Histórico da Página

CONTEÚDO

Visão Geral
Método
- model1@Post
Demais Informações
Tabelas utilizadas

01. VISÃO GERAL

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

02. Método

Header

Key	Value	Obrigatório	OBS:
Content-Type	application/json	X	N/A

...

model1 @Get@Post (Busca saldos de acordo com os parâmetros enviados)
Âncora
insert
insert

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

Body

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

X29082022X29082022N/AN/A numero numero numero numero numero

Campo	Descrição	Tipo	Obrigatório	Observação
GRUPO_EMPRESA	Grupo de empresa que será realizada a extração	Caractere	SIM	Grupo de empresa na qual serão extraídos os dados. *Obrigatório somente quando não enviado CNPJ (TECHFIN).
CNPJ	CNPJ a qual o grupo de empresa pertence	Caractere	SIM	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*.
FILIALFILIAIS	Filial ou filiais a ser consideradas na extração	CaractereX	SIM	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.	Caractere	SIM	Data enviada em formato caractere ddmmaaaa ex: "	01/	01/	2023"
DATA_FINAL	Informe a Data Final a partir da qual deseja extrair os saldos.	Caractere	SIM	Data enviada em formato caractere ddmmaaaa ex: "	31/	10/	2023"
CONTA_INICIAL	Informe a conta Inicial a partir da qual deseja extrair os saldos.	Caractere	X	NÃO	" "→ default
CONTA_FINAL	Informe a conta final até a qual deseja extrair os saldos.	Caractere	X	NÃO	"ZZZZZZZZZZ"→ default
IMPRIME_CONTAS	Informe se deseja imprimir as Contas	Numérico	NÃO	Enviar somente o	número identificador: 1 (Sintéticas) 2 (Analíticas) 3 (Ambas) → default
COD_CONFIG_LIVROS	Determine qual a configuração de Livro será utilizada.	Caractere	NÃ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_ZERADOS	Informe se deseja que as contas com saldos zerados sejam impressas ou não.	Numérico	NÃO	Enviar somente o	número identificador: 1 (Sim) → default 2 (Não)
MOEDA	Informe o código da moeda na qual deseja extrair os saldos.	Caractere	NÃO	01 → default
TIPO_DE_SALDO	Informe qual o tipo de saldo que deseja extrair os saldos.	Caractere	NÃO	1 → default
FILTRA_SEGMENTO_NO	Informe qual o segmento da máscara contábil que se deseja filtrar	Caractere	NÃ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_SEGMEN	Informe o conteúdo inicial do segmento de máscara contábil a ser filtrado na extração dos saldos.	Caractere	NÃO	Esta pergunta depende da resposta da pergunta "Filtra Segmento No.?"
CONTEUDO_FIM_SEGMEN	Informe o conteúdo final do segmento de máscara contábil a ser filtrado na extração dos saldos.	Caractere	NÃO	Esta pergunta depende da resposta da pergunta "Filtra Segmento No.?"
CONTEUDO_CONTIDO_EM	Informe quais os conteúdos a serem filtrados.	Caractere	NÃ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_MOV	Informe se deseja que a coluna de Movimento do período	Numérico	NÃO	Enviar somente o	número identificador: 1 (Sim) → default 2 (Não)
IMPRIME_CODIGO	Formato de extração do código da entidade	Numérico	NÃO	Enviar somente o	número identificador: 1 (Normal) → default 2 (Reduzido)
DIVIDE_POR	Informe se deseja que os valores dos saldos sejam divididos	Numérico	NÃ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_P	Indique se deseja que os valores a serem extraídos irão considerar ou não os lançamentos da Apuração de Resultados	Numérico	NÃO	Enviar somente o numero identificador: 1 (Sim) 2 (Não) → default
DATA_LUCROS_PERDAS	Informe a data de Apuração de Resultado que deseja desconsiderar	Caractere	NÃ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_DES	Informe se deseja ignorar o saldo anterior das contas de receitas/despesas de acordo com o grupo e a data escolhida nos dois parâmetros abaixo	Numérico	NÃO	Enviar somente o	número identificador: 1 (Sim) 2 (Não) → default
GRUPOS_RECEITAS_DESPESAS	Informe quais os grupos de receitas/ despesas que deverão ter seus saldos anteriores ignorados.	Caractere	NÃO	Essa pergunta será considerada somente se a pergunta 'Ignora Sl Ant. Rec/Desp' estiver preenchida com 'Sim'.
DATA_SLD_ANT_RECEITAS_DESP	Informe qual a data que as contas de receitas/despesas terão seus saldos anteriores ignorados.	Caractere	NÃ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'.
PAGE	Número da página de resultados	Numérico	NÃO	Por default será enviado o resultado geral do relatório sem filtros de paginação
PAGESIZE	Quantidade total da página de resultados	Numérico	NÃO	Por default será enviado o resultado geral do relatório sem filtros de paginação
TECHFIN	Identificador se a requisição é da integração TECHFIN	Numérico	NÃO	Enviar somente o número identificador: 1 (Sim) 2	CVN_CODPLA	Código do plano referencial	Caractere	Caso queira extrair as contas referenciais os parâmetros CVN_CODPLA e CVN_ENTREF serão obrigatórios	CVN_ENTREF	Código da entidade referencial	Caractere	Caso queira extrair as contas referenciais os parâmetros CVN_CODPLA e CVN_ENTREF serão obrigatórios	CVN_VERSAO	Versão	Caractere	default vazio (Não) → default
QUEBRA_POR_NATUREZA	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
IMP_QUADROS_CONTABEIS	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
IMPRIME_CODIGO	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
IMPRIME_VALOR_0	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
SALTA_LINHA_SINT	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
IMPRIMIR_ATE_O_SEG	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
DESCRICAO_NA_MOEDA	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
FOLHA_INICIAL	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
NUM_LINHAS_P_O_BALANCETE	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API
SELECIONA_FILIAIS	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API	NÃO UTILIZADO VIA API

OBS.:

...

Bloco de código

language	java
title	Exemplo de Envio
collapse	true

{ 	
    "CT2_DATACNPJ":"01/09/202353113791" ,
    "CT2DATA_LOTEINICIAL":  "00896001/01/2023",
    "CT2_SBLOTE	"DATA_FINAL":  "00131/12/2023",
	"TECHFIN" : 1
}

Bloco de código

language	java
title	Exemplo de resposta
collapse	true

{
    "ITENSitems": [{
        "CT2_MOEDLC":{
    "01",
        "CT2_DCconta" :  "3CTBXATUC",
            "CT2condicao_CREDITnormal":  "CTBXATUC2",
            "CT2_DEBITOsuperior":  "CTBXATUD",
            "CT2_VALORclasse":  1500.60 "2",
        "CT2_HIST": "PARTIDA DOBRADA ",
    	},
		{
		"CT2_MOEDLC"natureza":  "01",
            "CT2_DCdescricao" :  "2REAL",
            "CT2saldo_CREDITanterior":  "CTBXATUC"0,
        "CT2_VALOR    "debito": 0,
  1600  ,
        "CT2_HISTcredito": "PARTIDA DOBRADA "1600.6,
			}]
}

Exemplo de Resposta

Bloco de código

language	java
title	Exemplo de resposta

{
    "GrupoEmpresa"conta_referencial": "T1",
  		// grupo de empresa no qual o lançamento foi inserido.
    "CT2descricao_FILIALreferencial": "D MG 01 ", 	// Filial no qual o lançamento foi inserido. 
    "CT2_DOC": "000003", 		// Número de documento gerado. 
    "error": ""  				// Erro será retornado em vazio caso a inclusão ocorra com sucesso, em caso de erro será retornado a descrição do erro.
}

Card documentos

Informacao	** Caso o conteúdo do campo CT2_HIST enviado seja maior que o tamanho campo no Protheus o sistema irá gerar de forma automática, linhas de continuação de histórico (CT2_DC = 4) de acordo com o tamanho do campo CT2_HIST
Titulo	IMPORTANTE!

OBS.: *Número de documento será gerado automaticamente com o próximo disponível para a chave: Data, Lote , Sublote.

03. TABELAS UTILIZADAS

...

"",
            "saldo_atual": 1600.6,
            "movimento": 1600.6,
		 	"competencia": "12/2023",     //somente para integração Techfin
		    "status": "Aberto"            //somente para integração Techfin
         }
    ],
    "hasNext": false,
    "remainingRecords": 0,
    "po_sync_date": "2023-09-29T19:13:15Z"
}

Nota

title	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: os campos e parâmetros devem ser passados conforme padrão Padrão CloudEvents/Modo Estruturado .

03. DEMAIS INFORMAÇÕES

Integração Techfin Balancete Modelo 1 via Smartlink

04. TABELAS UTILIZADAS

CT1- Plano de Contas
CTT- Centro de Custo
CQ0- Saldo por Conta no Mês
CQ1- Saldo por Conta no Dia CTH- Classe de Valor
CVN - Plano de Contas Referencial
CVD - Plano de Contas Referenciais
CTG - Calendário Contábil

Árvore de páginas

Versões comparadas

Versão antiga 16

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. Método

03. TABELAS UTILIZADAS

03. DEMAIS INFORMAÇÕES

04. TABELAS UTILIZADAS