...
ÍNDICE
- Visão GeralVisión general
- Métodos
- Tabelas Tablas utilizadas
Nota |
---|
|
Essa funcionalidade está em construção e Esta funcionalidad está en construcción y será liberada a partir do del release 12.1.2310
|
01.
...
VISIÓN GENERAL
...
Modelo de dados a ser seguido para consumo da API de lançamentos contábeis.
Esta documentación tiene como propósito mostrar el modelo de datos que se utilizará para el consumo de la API de asientos contables.
02. Métodos
Header
ObrigatórioObligatorio | 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ábily sucursal donde se incluirá, revertirá o borrará el asiento contable) Grupo de |
EmpresaUnidade NegócioFilial OBS: Header deve ser enviado para todos os métodos
...
El header debe enviarse a todos los métodos
- INSERT @Post (Inserção Inclusión de Lançamento Contábilasiento contable)
EndPoint: Caminho do serviço Camino del servicio REST Protheus + /api/ctb/accountingentry/insert Ex.: http://localhost:9090/api/ctb/accountingentry/insert
Body
Deverá ser enviado no Debe enviarse en formato Json de acordo com modelo a seguir, de acuerdo con el siguiente modelo
Portada de loteCapa do Lote
ObrigatórioObservação do Lote CaractereCaractereITENSLinhas lançamento contábil Item uma linha lançamento para a mesma capa Campo | Descrição Descripción | Tipo | Obligatorio | Observación |
---|
CT2_DATA | Data do Lançamento | Caractere | Fecha de asiento | Carácter |
| Fecha enviada en formato carácter ddmmaaaa ejData enviada em formato caractere ddmmaaaa ex: "29/08/2022" Default = Data Fecha base do del sistema. |
CT2_LOTE | Número | de lote | Carácter |
| Default = '000001' |
CT2_SBLOTE | Número do SubLote de sublote | Carácter |
| Default = '001' |
ÍTEMS | Línea de | asiento contable | Array de Object | X | Cada | Ítem corresponderá a | una línea de | asiento para la misma portada de lote |
Itens do LoteÍtems de lote
ObrigatórioObservação do LançamentoCaractere Dobrada do Lançamento deve ser enviado com o caractere pontoCaractere tamanho no Conta Debito CaractereObrigatório lançamento e dobrada Conta Credito CaractereObrigatório lançamento e dobrada do SaldoCaractereOrigem do Lançamento CaractereHistórico Padrão Caractere Custo Débito Caractere Custo CréditoCaractereItem CréditoCaractereClasse Valor CréditoCaractereEntidade Adicional (Sem NomenclaturaCaractereCampo | Descrição Descripción | Tipo | Obligatorio | Observación |
---|
CT2_DC | Tipo | de asiento | Carácter | X | 1 → Débito 2 → Crédito 3→ Partida | doble |
CT2_VALOR | Valor | de asiento | Numérico | X | decimal | debe enviarse con el carácter punto |
CT2_HIST | Histórico Lançamento | Historial del asiento | Carácter | X | ** | tamaño Default | en el Protheus 40 |
CT2_DEBITO | Cuenta débito | Carácter | X | Obligatorio para tipos de | asiento: Débito | y Partida | doble |
CT2_CREDIT | Cuenta crédito | Carácter | X | Obligatorio para tipos de | asiento: Crédito | y Partida | doble |
CT2_TPSALD | Tipo | de saldo | Carácter |
| Default = '1' |
CT2_CONVER | Critério Criterio de Conversão conversión | Caractere Carácter |
| Default = '1' . Define se será gerado lançamento contábil em outras moedas convertidos de acordo com o critériosi se generará asiento contable en otras monedas convertidos de acuerdo con el criterio |
CT2_ORIGEM | Origen del asiento | Carácter |
| Default = 'API ACCOUNTINGENTRY' . |
CT2_HP | Historial estándar | Carácter |
| N/A |
CT2_CCD | Centro de | costo débito | Carácter |
| N/A |
CT2_CCC | Centro de | costo crédito | Carácter |
| N/A |
CT2_ITEMD | Item Débito Ítem débito | Caractere Carácter |
| N/A |
CT2_ITEMC | Ítem crédito | Carácter |
| N/A |
CT2_CLVLDB | Classe Clase de Valor Débitovalor débito | Caractere Carácter |
| N/A |
CT2_CLVLCR | Clase de | valor crédito | Carácter |
| N/A |
CT2_EC05DB | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC05CR | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC06DB | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC06CR | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC07DB | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC07CR | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC08DB | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC08CR | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC09DB | Entidade Adicional (Sem Nomenclatura Entidad adicional (Sin nomenclatura) | Caractere Carácter |
| N/A |
CT2_EC09CR | Entidad adicional (Sin nomenclatura) | Carácter |
| N/A |
CT2_KEY | Chave Clave identificadora | Caractere Carácter |
| N/A |
OBS.:
*Para A cada capa portada de lote deve ser enviado 1 ou mais itensdebe enviarse 1 o más ítems.
**Número de documento será gerado automaticamente com o próximo disponível para a chave: Datase generará automáticamente con el próximo disponible para la clave: Fecha, Lote, Sublote.
***Número de linhas será gerado automaticamente líneas se generará automáticamente para cada item ítem enviado.
Exemplo Ejemplo de Envioenvío
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de Envioenvío |
---|
|
{
"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 DOBRADADOBLE ",
},
{
"CT2_MOEDLC": "01",
"CT2_DC" : "2",
"CT2_CREDIT": "CTBXATUC",
"CT2_VALOR": 1600 ,
"CT2_HIST": "PARTIDA DOBRADADOBLE ",
}]
} |
Exemplo Ejemplo de Respostarespuesta
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de resposta respuesta |
---|
|
{
"GrupoEmpresa": "T1", // grupoGrupo de empresa noen el qualcual ose lançamentoincluyó foiel inseridoasiento.
"CT2_FILIAL": "D MG 01 ", // FilialSucursal en nola qualcual ose lançamentoincluyó foiel inseridoasiento.
"CT2_DOC": "000003", // Número de documento geradogenerado.
"error": "" // ErroEl seráerror retornadose emdevolverá vaziovacío casosi ala inclusãoinclusión ocorraocurriera comcon sucessoéxito, emen caso de erroerror seráse retornadodevolverá ala descriçãodescripción dodel erroerror.
} |
Card documentos |
---|
Informacao | ** Caso o conteúdo do Si el contenido del campo CT2_HIST enviado seja maior que o tamanho campo no Protheus o sistema irá gerar fuera mayor que el tamaño del campo en el Protheus, el sistema generará de forma automática, linhas líneas de continuação continuación de histórico historial (CT2_DC = 4) de acordo com o tamanho do acuerdo con el tamaño del campo CT2_HIST |
---|
Titulo | IMPORTANTE! |
---|
|
- REVERSAL @Post (Estorno Reversión de Lançamento Contábilasiento contable)
EndPoint: Caminho do serviço Camino del servicio REST Protheus + /api/ctb/accountingentry/reversal Ex.: http://localhost:9090/api/ctb/accountingentry/reversal
Body
Deverá ser enviado no Debe enviarse en formato Json de acordo com modelo a seguir, de acuerdo con el siguiente modelo
ObrigatórioObservação do Lote Caractere do Lote do lançamento a ser estornadoCaractere do SubLote do lançamento a ser estornado do DocumentoCaractere do Documento do lançamento a ser estornado do Lote para o Lançamento de estornoCaso não informado será gerado com mesmo número de lote do lançamento origem do SubLote para o Lançamento de estornoCaso não informado será gerado com mesmo número de Sublote do lançamento origemCampo | Descrição Descripción | Tipo | Obligatorio | Observación |
---|
CT2_DATA | Data Lançamento Fecha asiento | Caractere Carácter | X | Fecha del asiento que se revertirá. Se envía en formato carácter ddmmaaaa ej Data do lançamento que será estornado. Enviada em formato caractere ddmmaaaa ex: "29/08/2022" |
CT2_LOTE | Número | del lote | Carácter | X | Número | de lote del asiento que se revertirá. |
CT2_SBLOTE | Número do SubLote de sublote | Carácter | X | Número | de sublote del asiento que se revertirá. |
CT2_DOC | Número | de documento | Carácter | X | Número | de documento del asiento que se revertirá. |
CT2_LOTEST | Número | Caractere | de lote para el asiento de reversión | Carácter |
| Si no se informa se generará con el mismo número de lote del asiento origen. |
CT2_SBLOTEST | Número | Caractere | de sublote para el asiento de reversión | Carácter |
| Si no se informa se generará con el mismo número de sublote del asiento origen. |
OBS.: *Número de documento será gerado automaticamente com o próximo disponível para a chave: Datase generará automáticamente con el próximo disponible para la clave: Fecha, Lote, Sublote.
Exemplo Ejemplo de Envioenvío
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de Envioenvío |
---|
|
{
"CT2_DATA": "01/09/2023" ,
"CT2_LOTE": "THIAGO",
"CT2_SBLOTE": "001",
"CT2_DOC" : "000003",
"CT2_LOTEST":"EST001",
"CT2_SBLOTEST":"001"
} |
Exemplo Ejemplo de Respostarespuesta
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de resposta respuesta |
---|
|
{
"GrupoEmpresa": "T1", // grupoGrupo de empresa noen el qualcual ose lançamentoincluyó deel estornoasiento foide inseridoreversión.
"CT2_FILIAL": "D MG 01 ", // Sucursal Filialen nola qualcual ose lançamentoincluyó deel estornoasiento foide inseridoreversión.
"CT2_DOC": "000001", // Número de documento de estornoreversión geradogenerado.
"error": "" // ErroEl seráerror retornadose emdevolverá vaziovacío casosi ola estornoreversión ocorraocurriera comcon sucessoéxito, emen caso de erroerror seráse retornadodevolverá ala descriçãodescripción dodel erroerror.
} |
- DELETE @Post (Exclusão Borrado de Lançamento Contábilasiento contable)
EndPoint: Caminho do serviço Camino del servicio REST Protheus + /api/ctb/accountingentry/delete Ex.: http://localhost:9090/api/ctb/accountingentry/delete
Body
Deverá ser enviado no Debe enviarse en formato Json de acordo com modelo a seguir, de acuerdo con el siguiente modelo
ObrigatórioObservação do Lote Caractere do Lote do lançamento a ser excluídoCaractere do SubLote do lançamento a ser excluído do DocumentoCaractere do Documento do lançamento a ser excluídoCampo | Descrição Descripción | Tipo | Obligatorio | Observación |
---|
CT2_DATA | Data Lançamento Fecha asiento | Caractere Carácter | X | Fecha del asiento que se borrará. Se envía en formato carácter ddmmaaaa ej Data do lançamento que será excluído. Enviada em formato caractere ddmmaaaa ex: "29/08/2022" |
CT2_LOTE | Número | de lote | Carácter | X | Número | de lote del asiento que se borrará. |
CT2_SBLOTE | Número do SubLote de sublote | Carácter | X | Número | de sublote del asiento que se borrará. |
CT2_DOC | Número | del documento | Carácter | X | Número | de documento del asiento que se borrará. |
Exemplo Ejemplo de Envioenvío
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de Envioenvío |
---|
|
{
"CT2_DATA": "01/09/2023" ,
"CT2_LOTE": "000001",
"CT2_SBLOTE": "001",
"CT2_DOC" : "000005"
} |
Exemplo Ejemplo de Respostarespuesta
Bloco de código |
---|
language | java |
---|
title | Exemplo Ejemplo de resposta respuesta |
---|
|
{
"GrupoEmpresa": "T1", // grupoGrupo de empresa noen el qualcual ose lançamentoborró foiel excluídoasiento.
"CT2_FILIAL": "D MG 01 ", // Sucursal Filialen nola qualcual ose lançamentoborró foiel excluídoasiento.
"CT2_DOC": "000005", // Número de documento excluídoborrado.
"error": "" // ErroEl seráerror retornadose emdevolverá vaziovacío casosi ael exclusãoborrado ocorraocurriera comcon sucessoéxito, emen caso de erroerror seráse retornadodevolverá ala descriçãodescripción dodel erroerror.
} |
03.
...
TABLAS UTILIZADAS
- CT2- Lançamentos ContábeisAsientos contables
- CT1- Plano Plan de Contascuentas
- CTT- Centro de Custocosto
- CTH- Classe Clase de Valorvalor
- CTD - Item ContábilÍtem contable