Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO

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


Nota
titleAtenção

Essa funcionalidade está em construção e será liberada a partir do release 12.1.2310

01. VISÃO GERAL

Modelo Essa documentação visa apresentar o modelo de dados a ser seguido para consumo da API de lançamentos contábeis.       

02. Métodos 

Header

KeyValueObrigatórioOBS:
Content-Typeapplication/json
*
XN/A
tenantIdT1,D MG 01 
*
X

(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

...


  • INSERT @Post (Inserção de Lançamento Contábil)
    Âncora
    insert
    insert

02. Métodos 

  • Insert

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

...

Capa do Lote

CampoDescriçãoTipoTamanho(MAX)ObrigatórioObservação
CT2_DATAData do LançamentoCaractere10X

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

Default = Data base do sistema.

CT2_LOTENúmero do Lote Caractere
Default = '000001' 
CT2_SBLOTECódigo da empresaNúmero do SubLote Caractere2Grupo de Empresa 
Default = '001' 
ITENSLinhas de lançamento contábilArray de ObjectXcada Cada Item corresponderá a uma linha de lançamento para a mesma capa de lote

...

CampoDescriçãoTipoObrigatórioObservação
CT2_DCTipo do LançamentoCaractereX1 → Débito 2 → Crédito 3→ Partida Dobrada
CT2_VALORValor do LançamentoNuméricoXdecimal deve ser enviado com o caractere ponto
CT2_HISTHistórico LançamentoCaractereX

** tamanho Default no Protheus 40

CT2_DEBITOConta Debito             CaractereXObrigatório para tipos de lançamento: Débito e Partida dobrada 
CT2_CREDITConta Credito            CaractereXObrigatório para tipos de lançamento: Crédito e Partida dobrada 
CT2_TPSALDTipo do SaldoCaractere
Default = '1' 
CT2_CONVERCrité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_HPHistórico Padrão         Caractere
N/A
CT2_CCD   Centro de Custo Débito   Caractere
N/A
CT2_CCC   Centro de Custo CréditoCaractere
N/A
CT2_ITEMDItem DébitoCaractere
N/A
CT2_ITEMCItem CréditoCaractere
N/A
CT2_CLVLDBClasse de Valor DébitoCaractere
N/A
CT2_CLVLCRClasse de Valor CréditoCaractere
N/A
CT2_EC05DBEntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC05CREntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC06DBEntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC06CREntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC07DBEntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC07CREntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC08DBEntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC08CREntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC09DBEntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_EC09CREntidade Adicional (Sem Nomenclatura)Caractere
N/A
CT2_KEYChave identificadoraCaractere
N/A

OBS.:

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

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

***Número de linhas será gerado automaticamente para cada item enviado.

Exemplo de Envio

Bloco de código
languagejava
titleExemplo de resposta 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_KEY":  "",
        "CT2_TPSALD": "1",
        "CT2_VALOR":  1500.60 ,
        "CT2_HIST": "PARTIDA DOBRADA ",
    	},
		{
		"CT2_MOEDLC":  "01",
        "CT2_DC" :  "32",
        "CT2_CREDIT":  "CTBXATUC",
        "CT2_DEBITO":  "CTBXATUD",
        "CT2_KEY":  "",
        "CT2_TPSALD": "1",
        "CT2_VALOR":  1600 ,
        "CT2_HIST": "PARTIDA DOBRADA ",
        "CT2_EMPORI":  "T2",
        "CT2_FILORI":  "M PR 02",
        "CT2_ORIGEM":  "API LAN"
		}]
}
  • Reversal
  • Delete

gdg

Capa do Lote

...

Exemplo de Resposta

...

Bloco de código
languagejava
titleExemplo de resposta
{
    "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 brancovazio caso a inclusão ocorra com sucesso, em caso de erro será retornado a descrição do erro.
}
  1. Reversal
  2. Delete

...


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
TituloIMPORTANTE!


  • REVERSAL @Post (Estorno de Lançamento Contábil)
    Âncora
    reversal
    reversal

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

Body

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

CampoDescriçãoTipoObrigatórioObservação
CT2_DATAData LançamentoCaractereX

Data do lançamento que será estornado.

Enviada em formato caractere ddmmaaaa ex: "29/08/2022"

CT2_LOTENúmero do Lote CaractereXNúmero do Lote do lançamento a ser estornado.
CT2_SBLOTENúmero do SubLote CaractereXNúmero do SubLote do lançamento a ser estornado.
CT2_DOCNúmero do DocumentoCaractereXNúmero do Documento do lançamento a ser estornado.
CT2_LOTESTNúmero do Lote para o Lançamento de estornoCaractere
Caso não informado será gerado com mesmo número de lote do lançamento origem.
CT2_SBLOTESTNúmero do SubLote para o Lançamento de estornoCaractere
Caso não informado será gerado com mesmo número de Sublote do lançamento origem.

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


Exemplo de Envio

Bloco de código
languagejava
titleExemplo de resposta Envio
{ 
    "specversionCT2_DATA": "1.0"01/09/2023" ,
    "timeCT2_LOTE": "2022-10-18T11:04:03-03:00 "THIAGO",
    "typeCT2_SBLOTE":  "CT2respXGsp001",
    "tenantIdCT2_DOC" :  "000003",
	"CT2_LOTEST":"EST001",
	"CT2_SBLOTEST":"001"
}

Exemplo de Resposta

Bloco de código
languagejava
titleExemplo de resposta
{
    "GrupoEmpresac6486a57-3447-461d-bcdf-d66b94226f69",
    "data": [
        {
			"ID": "1271"
			"EST":"REV"	
            "COD_EMP": "T1",
           		// grupo de empresa no qual o lançamento de estorno foi inserido.
    "CT2_FILIAL": "D MG 01 ",
 	// Filial no qual o lançamento de estorno foi inserido. 
    "CT2_DOC": "000004000001",
 		// Número de documento de estorno gerado. 
    "CT2_KEYerror": "ITEM 1",
  				// Erro será retornado em vazio caso o estorno ocorra "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

com sucesso, em caso de erro será retornado a descrição do erro.
}


  • Âncora
    delete
    delete
    DELETE @Post (Exclusão de Lançamento Contábil)

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

    Body

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

    CampoDescriçãoTipo

...

  • ObrigatórioObservação

...

...

  • CT2_

...

  • DATAData LançamentoCaractere

...

  • X

    Data

...

  • do lançamento que será excluído.

    Enviada em formato caractere ddmmaaaa ex: "29/08/2022"

...

  • CT2_LOTENúmero do Lote 

...

  • Caractere

...

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

Itens do Lote

...

** tamanho Default no Protheus 40

...

  • XNúmero do Lote do lançamento a ser excluído.
    CT2_SBLOTENúmero do SubLote CaractereXNúmero do SubLote do lançamento a ser excluído.
    CT2_DOCNúmero do DocumentoCaractereXNúmero do Documento do lançamento a ser excluído.


    Exemplo de Envio

    Bloco de código
    languagejava
    titleExemplo de Envio
    { 
        "CT2_DATA": "01/09/2023" ,
        "CT2_LOTE":  "000001",
        "CT2_SBLOTE":  "001",
        "CT2_DOC" :  "000005"
    }

    Exemplo de Resposta

    Bloco de código
    languagejava
    titleExemplo de resposta
    {
        "GrupoEmpresa": "T1",  		// grupo de empresa no qual o lançamento foi excluído.
        "CT2_FILIAL": "D MG 01 ", 	// Filial no qual o lançamento foi excluído. 
        "CT2_DOC": "000005", 		// Número de documento excluído. 
        "error": ""  				// Erro será retornado em vazio caso a exclusão ocorra com sucesso, em caso de erro será retornado a descrição do erro.
    }

03

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

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
TituloIMPORTANTE!

...

. TABELAS UTILIZADAS

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

...