Exibir origem

CONTEÚDO

Visão Geral
Métodos
- Insert
- Reversal
- Delete
Tabelas utilizadas

01. VISÃO GERAL

Modelo de dados a ser seguido para consumo da API de lançamentos contábeis.

Header

Key

Value

Obrigatório

OBS:

Content-Type

application/json

*

N/A

tenantId

T1,D MG 01

*

(Empresa e Filial onde será inserido, estornado ou excluído o lançamento contábil)

Grupo de Empresa+','+Empresa+Unidade de Negócio+Filial

OBS: Header deve ser enviado para todos os métodos

02. Métodos

Insert

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

Body

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

Capa do Lote

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
CT2_DATA	Data Lançamento	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "29/08/2022"
CT2_LOTE
CT2_SBLOTE	Código da empresa	Caractere	2		Grupo de Empresa
ITENS	Linhas de lançamento contábil	Array de Object		X	cada Item corresponderá a uma linha de lançamento para a mesma capa de lote

Itens do Lote

Campo	Descrição	Tipo	Obrigatório	Observação
CT2_DC	Tipo do Lançamento	Caractere	X	1 → Débito 2 → Crédito 3→ Partida Dobrada
CT2_VALOR	Valor do Lançamento	Numérico	X	decimal deve ser enviado com o caractere ponto
CT2_HIST	Histórico Lançamento	Caractere	X	** tamanho Default no Protheus 40
CT2_DEBITO	Conta Debito	Caractere	X	Obrigatório para tipos de lançamento: Débito e Partida dobrada
CT2_CREDIT	Conta Credito	Caractere	X	Obrigatório para tipos de lançamento: Crédito e Partida dobrada
CT2_TPSALD	Tipo do Saldo	Caractere		Default = '1'
CT2_CONVER	Critério de Conversão	Caractere		Default = '1' . Define se será gerado lançamento contábil em outras moedas convertidos de acordo com o critério
CT2_ORIGEM	Origem do Lançamento	Caractere		Default = 'API ACCOUNTINGENTRY' .
CT2_HP	Histórico Padrão	Caractere		N/A
CT2_CCD	Centro de Custo Débito	Caractere		N/A
CT2_CCC	Centro de Custo Crédito	Caractere		N/A
CT2_ITEMD	Item Débito	Caractere		N/A
CT2_ITEMC	Item Crédito	Caractere		N/A
CT2_CLVLDB	Classe de Valor Débito	Caractere		N/A
CT2_CLVLCR	Classe de Valor Crédito	Caractere		N/A
CT2_EC05DB	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC05CR	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC06DB	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC06CR	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC07DB	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC07CR	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC08DB	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC08CR	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC09DB	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_EC09CR	Entidade Adicional (Sem Nomenclatura)	Caractere		N/A
CT2_KEY	Chave identificadora	Caractere		N/A

Exemplo de Envio

{ 
    "CT2_DATA":"01/09/2023" ,
    "CT2_LOTE":  "008960",
    "CT2_SBLOTE":  "001",
    "ITENS":[{
        "CT2_MOEDLC":  "01",
        "CT2_DC" :  "3",
        "CT2_CREDIT":  "CTBXATUC",
        "CT2_DEBITO":  "CTBXATUD",
        "CT2_VALOR":  1500.60 ,
        "CT2_HIST": "PARTIDA DOBRADA ",
    	},
		{
		"CT2_MOEDLC":  "01",
        "CT2_DC" :  "2",
        "CT2_CREDIT":  "CTBXATUC",
        "CT2_VALOR":  1600 ,
        "CT2_HIST": "PARTIDA DOBRADA ",
		}]
}

Reversal
Delete

gdg

Capa do Lote

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
COD_EMP	Código da empresa	Caractere	2	X	Grupo de Empresa
CT2_FILIAL	Código da Filial	Caractere	8	X	Concatenação dos campos Empresa , Unidade de Negócio e Filial
CT2_DATA	Data Lançamento	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "29/08/2022"
ID	Identificador de controle Gesplan	Caractere	10		Conteúdo apenas será retornado
EST	Identificador de controle Gesplan	Caractere	10		Conteúdo apenas será retornado

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

Reversal
Delete

Fomato de resposta:

{
    "specversion": "1.0",
    "time": "2022-10-18T11:04:03-03:00",
    "type": "CT2respXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "data": [
        {
			"ID": "1271"
			"EST":"REV"	
            "COD_EMP": "T1",
            "CT2_FILIAL": "D MG 01",
            "CT2_DOC": "000004",
            "CT2_KEY": "ITEM 1",
            "error": ""
        }
    ]
}

OBS: Caso houver algum erro a propriedade "error" será preenchida informando o motivo do erro no cadastro, nesses casos a propriedade "CT2_DOC" retornará em branco pois o lançamento não foi cadastrado.

03. Outras Informações_

Principais Campos e Parâmetros

Capa do Lote

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
COD_EMP	Código da empresa	Caractere	2	X	Grupo de Empresa
CT2_FILIAL	Código da Filial	Caractere	8	X	Concatenação dos campos Empresa , Unidade de Negócio e Filial
CT2_DATA	Data Lançamento	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "29/08/2022"
ID	Identificador de controle Gesplan	Caractere	10		Conteúdo apenas será retornado
EST	Identificador de controle Gesplan	Caractere	10		Conteúdo apenas será retornado

OBS: O código do Lote reservado para os lançamentos contábeis oriundos do Sistema Gesplan para o Protheus é 008950.

Itens do Lote

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
CT2_DC	Tipo do Lançamento	Caractere	1	X	1 → Débito 2 → Crédito 3→ Partida Dobrada
CT2_KEY	Chave identificadora	Caractere	200	X	SYSCODE (GESPLAN)
CT2_ROTINA	Rotina Geradora	Caractere	10	X	WFNFIN ou WFNCASH ou WFNLEAS
CT2_VALOR	Valor do Lançamento	Numérico	16	X	decimal deve ser enviado com o caractere ponto
CT2_HIST	Histórico Lançamento	Caractere	512	X	** tamanho Default no Protheus 40
CT2_EMPORI	Código da empresa de origem	Caractere	2	X	N/A
CT2_FILORI	Código da Filial de origem	Caractere	8	X	N/A
CT2_DEBITO	Conta Debito	Caractere	20	X	Obrigatório para tipos de lançamento: Débito e Partida dobrada
CT2_CREDIT	Conta Credito	Caractere	20	X	Obrigatório para tipos de lançamento: Crédito e Partida dobrada
CT2_CCD	Centro de Custo Débito	Caractere	9		N/A
CT2_CCC	Centro de Custo Crédito	Caractere	9		N/A
CT2_ITEMD	Item Débito	Caractere	9		N/A
CT2_ITEMC	Item Crédito	Caractere	9		N/A
CT2_CLVLDB	Classe de Valor Débito	Caractere	9		N/A
CT2_CLVLCR	Classe de Valor Crédito	Caractere	9		N/A
CT2_EC05DB	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC05CR	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC06DB	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC06CR	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC07DB	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC07CR	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC08DB	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC08CR	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC09DB	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_EC09CR	Entidade Adicional (Sem Nomenclatura)	Caractere	20		N/A
CT2_CONVER	Critério de Conversão	Caractere	5		Default = '1' . Define se será gerado lançamento contábil em outras moedas convertidos de acordo com o critério

OBS: Para cada capa de lote deve ser enviado 1 ou mais itens.

04. TABELAS UTILIZADAS

CT2- Lançamentos Contábeis
CT1- Plano de Contas
CTT- Centro de Custo
CTH- Classe de Valor
CTD - Item Contábil