Histórico da Página
...
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
- InsertINSERT (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
...
Capa do Lote
Campo | Descrição | Tipo | Tamanho(MAX) | Obrigatório | Observação | |
---|---|---|---|---|---|---|
CT2_DATA | Data do Lançamento | Caractere | 10 | X | Data enviada em formato caractere ddmmaaaa ex: "29/08/2022" Default = Data base do sistema. | |
CT2_LOTE | Número do Lote | Caractere | Default = '000001' | |||
CT2_SBLOTE | Código da empresaNúmero do SubLote | Caractere | 2 | Grupo de Empresa | Default = '001' | |
ITENS | Linhas de lançamento contábil | Array de Object | X | cada Cada Item corresponderá a uma linha de lançamento para a mesma capa de 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 |
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 | ||||
---|---|---|---|---|
| ||||
{ "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
...
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.
} |
- REVERSAL (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
Campo | Descrição | Tipo | Obrigatório | Observação |
---|
CT2_DATA | Data Lançamento | Caractere |
X | Data |
do lançamento a ser estornado. 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 estornado. |
CT2_SBLOTE | Número do SubLote | Caractere | X | Número do SubLote do lançamento a ser estornado. |
CT2_DOC | Número do Documento | Caractere | X | Número do Documento do lançamento a ser estornado. |
CT2_LOTEST | Número do Lote para o Lançamento de estorno | Caractere | Caso não informado será gerado com mesmo número de lote do lançamento origem. | |
CT2_SBLOTEST | Número do SubLote para o Lançamento de estorno | Caractere | Caso não informado será gerado com mesmo número de Sublote do lançamento origem. |
- DELETE (Exclusão de Lançamento Contábil)
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 branco caso a inclusão ocorra com sucesso, em caso de erro será retornado a descrição do erro. } |
...