Histórico da Página
CONTEÚDO
- Visão Geral
- Métodos
- Insert INSERT @Post
- Reversal REVERSAL @Post
- Delete DELETE @Post
- Tabelas utilizadas
Nota | ||
---|---|---|
| ||
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
Key | Value | Obrigatório | OBS: |
---|---|---|---|
Content-Type | application/json | X | N/A |
tenantId | T1,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
02. Métodos
- INSERT @Post (Inserção de Lançamento Contábil)
Âncora insert insert
EndPoint: Caminho do serviço REST Protheus + /api/ctb/accountingentry/insert Ex.: http://localhost:9090/api/ctb/accountingentry/insert
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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. } |
Card documentos | ||||
---|---|---|---|---|
|
- 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
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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)Âncora delete delete 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
Bloco de código language java title Exemplo de Envio { "CT2_DATA": "01/09/2023" , "CT2_LOTE": "000001", "CT2_SBLOTE": "001", "CT2_DOC" : "000005" }
Exemplo de Resposta
Bloco de código language java title 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
...
Principais Campos e Parâmetros
Capa do Lote
...
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
...
OBS: Para cada capa de lote deve ser enviado 1 ou mais itens.
Card documentos | ||||
---|---|---|---|---|
|
...
. TABELAS UTILIZADAS
- CT2- Lançamentos Contábeis
- CT1- Plano de Contas
- CTT- Centro de Custo
- CTH- Classe de Valor
- CTD - Item Contábil
...