CONTEÚDO

1. Visão Geral
2. Métodos 
   • INSERT @Post
   • REVERSAL @Post
   • DELETE @Post
3. Tabelas utilizadas
   
   
   

01. VISÃO GERAL

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

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

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

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

Itens do Lote

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

{ 
    "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 ",
		}]
}

Exemplo 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 vazio caso a inclusão ocorra com sucesso, em caso de erro será retornado a descrição do erro.
}

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

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

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

Exemplo de Envio

{ 
    "CT2_DATA": "01/09/2023" ,
    "CT2_LOTE":  "THIAGO",
    "CT2_SBLOTE":  "001",
    "CT2_DOC" :  "000003",
	"CT2_LOTEST":"EST001",
	"CT2_SBLOTEST":"001"
}

Exemplo de Resposta

{
    "GrupoEmpresa": "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": "000001", 		// Número de documento de estorno gerado. 
    "error": ""  				// Erro será retornado em vazio caso o estorno ocorra com sucesso, em caso de erro será retornado a descrição do erro.
}

• 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

  Campo	Descrição	Tipo	Obrigatório	Observação
  CT2_DATA	Data Lançamento	Caractere	X	Data do lançamento que será excluído. Enviada em formato caractere ddmmaaaa ex: "29/08/2022"
  CT2_LOTE	Número do Lote	Caractere	X	Número do Lote do lançamento a ser excluído.
  CT2_SBLOTE	Número do SubLote	Caractere	X	Número do SubLote do lançamento a ser excluído.
  CT2_DOC	Número do Documento	Caractere	X	Número do Documento do lançamento a ser excluído.

  
  

  Exemplo de Envio

  Exemplo de Envio

  { 
      "CT2_DATA": "01/09/2023" ,
      "CT2_LOTE":  "000001",
      "CT2_SBLOTE":  "001",
      "CT2_DOC" :  "000005"
  }

  Exemplo de Resposta

  Exemplo 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. TABELAS UTILIZADAS

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