...
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 |
...
...
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.
Header
Key | Value |
---|
Obligatorio | OBS: | ||
---|---|---|---|
Content-Type | application/json | X | N/A |
tenantId | T1,D MG 01 | X | (Empresa |
y sucursal donde se incluirá, revertirá o borrará el asiento contable) Grupo de |
empresa+','+Empresa+ |
Unidad de |
negocio+ |
Sucursal |
OBS: Header deve ser enviado para todos os métodos
...
El header debe enviarse a todos los métodos
Âncora | ||||
---|---|---|---|---|
|
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
Campo | Descrição Descripción | Tipo | ObrigatórioObligatorio | ObservaçãoObservació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 | do Lote de lote | CaractereCarácter | Default = '000001' | ||||
CT2_SBLOTE | Número do SubLotede sublote | CaractereCarácter | Default = '001' | ITENS|||||
ÍTEMS | Linhas Línea de | lançamento contábilasiento contable | Array de Object | X | Cada | Item Ítem corresponderá a | uma linha una línea de | lançamento para a mesma capa asiento para la misma portada de lote |
Itens do LoteÍtems de lote
Campo | Descrição Descripción | Tipo | ObrigatórioObligatorio | ObservaçãoObservación | |||
---|---|---|---|---|---|---|---|
CT2_DC | Tipo | do Lançamentode asiento | CaractereCarácter | X | 1 → Débito 2 → Crédito 3→ Partida | Dobradadoble | |
CT2_VALOR | Valor | do Lançamentode asiento | Numérico | X | decimal | deve ser enviado com o caractere pontodebe enviarse con el carácter punto | |
CT2_HIST | Histórico Lançamento | CaractereHistorial del asiento | Carácter | X | ** | tamanho tamaño Default | no en el Protheus 40 |
CT2_DEBITO | Conta Debito Cuenta débito | CaractereCarácter | X | Obrigatório Obligatorio para tipos de | lançamentoasiento: Débito | e y Partida | dobrada doble |
CT2_CREDIT | Conta Credito Cuenta crédito | CaractereCarácter | X | Obrigatório Obligatorio para tipos de | lançamentoasiento: Crédito | e y Partida | dobrada doble |
CT2_TPSALD | Tipo | do Saldode saldo | CaractereCarácter | Default = '1' | |||
CT2_CONVER | Critério Criterio de Conversãoconversió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 | Origem do Lançamento Origen del asiento | CaractereCarácter | Default = 'API ACCOUNTINGENTRY' . | ||||
CT2_HP | Histórico Padrão Historial estándar | CaractereCarácter | N/A | ||||
CT2_CCD | Centro de | Custo Débito costo débito | CaractereCarácter | N/A | |||
CT2_CCC | Centro de | Custo Créditocosto crédito | CaractereCarácter | N/A | |||
CT2_ITEMD | Item Débito Ítem débito | Caractere Carácter | N/A | ||||
CT2_ITEMC | Item CréditoÍtem crédito | CaractereCarácter | N/A | ||||
CT2_CLVLDB | Classe Clase de Valor Débitovalor débito | Caractere Carácter | N/A | ||||
CT2_CLVLCR | Classe Clase de | Valor Créditovalor crédito | CaractereCará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 | Entidade Adicional (Sem NomenclaturaEntidad adicional (Sin nomenclatura) | CaractereCará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 | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
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
Campo | Descrição Descripción | Tipo | ObrigatórioObligatorio | ObservaçãoObservació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 | do Lote del lote | CaractereCarácter | X | Número | do Lote do lançamento a ser estornadode lote del asiento que se revertirá. |
CT2_SBLOTE | Número do SubLotede sublote | CaractereCarácter | X | Número | do SubLote do lançamento a ser estornadode sublote del asiento que se revertirá. | |
CT2_DOC | Número | do Documentode documento | CaractereCarácter | X | Número | do Documento do lançamento a ser estornadode documento del asiento que se revertirá. |
CT2_LOTEST | Número | do Lote para o Lançamento de estornoCaractere | Caso não informado será gerado com mesmo número de lote do lançamento origemde 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 | do SubLote para o Lançamento de estornoCaractere | Caso não informado será gerado com mesmo número de Sublote do lançamento origemde 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 | ||||
---|---|---|---|---|
| ||||
{ "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 | ||||
---|---|---|---|---|
| ||||
{ "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. } |
Âncora | ||||
---|---|---|---|---|
|
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
Campo | Descrição Descripción | Tipo | ObrigatórioObligatorio | ObservaçãoObservació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 | do Lote de lote | CaractereCarácter | X | Número | do Lote do lançamento a ser excluídode lote del asiento que se borrará. |
CT2_SBLOTE | Número do SubLotede sublote | CaractereCarácter | X | Número | do SubLote do lançamento a ser excluídode sublote del asiento que se borrará. | |
CT2_DOC | Número | do Documentodel documento | CaractereCarácter | X | Número | do Documento do lançamento a ser excluídode documento del asiento que se borrará. |
Exemplo Ejemplo de Envioenvío
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "CT2_DATA": "01/09/2023" , "CT2_LOTE": "000001", "CT2_SBLOTE": "001", "CT2_DOC" : "000005" } |
Exemplo Ejemplo de Respostarespuesta
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "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. } |
...