ÍNDICE

  1. Visión general
  2. Métodos 
  3. Tablas utilizadas


Atención

Esta funcionalidad está en construcción y será liberada a partir del release 12.1.2310

01. VISIÓN GENERAL

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

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: El header debe enviarse a todos los métodos


  • INSERT @Post (Inclusión de asiento contable)

EndPoint: Camino del servicio REST Protheus + /api/ctb/accountingentry/insert Ex.: http://localhost:9090/api/ctb/accountingentry/insert

Body

Debe enviarse en formato Json, de acuerdo con el siguiente modelo

Portada de lote

Campo

Descripción

Tipo

Obligatorio

Observación

CT2_DATA

Fecha de asiento

Carácter


Fecha enviada en formato carácter ddmmaaaa ej: "29/08/2022"

Default = Fecha base del sistema.

CT2_LOTE

Número de lote 

Carácter


Default = '000001' 

CT2_SBLOTE

Número 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

Ítems de lote

Campo

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

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

Criterio de conversión  

Carácter


Default = '1' . Define si 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

Ítem débito

Carácter


N/A

CT2_ITEMC

Ítem crédito

Carácter


N/A

CT2_CLVLDB

Clase de valor débito

Carácter


N/A

CT2_CLVLCR

Clase de valor crédito

Carácter


N/A

CT2_EC05DB

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC05CR

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC06DB

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC06CR

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC07DB

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC07CR

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC08DB

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC08CR

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC09DB

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_EC09CR

Entidad adicional (Sin nomenclatura)

Carácter


N/A

CT2_KEY

Clave identificadora

Carácter


N/A

OBS.:

*A cada portada de lote debe enviarse 1 o más ítems.

**Número de documento se generará automáticamente con el próximo disponible para la clave: Fecha, Lote, Sublote.

***Número de líneas se generará automáticamente para cada ítem enviado.

Ejemplo de envío

Ejemplo de enví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 DOBLE ",
    	},
		{
		"CT2_MOEDLC":  "01",
        "CT2_DC" :  "2",
        "CT2_CREDIT":  "CTBXATUC",
        "CT2_VALOR":  1600 ,
        "CT2_HIST": "PARTIDA DOBLE ",
		}]
}

Ejemplo de respuesta

Ejemplo de respuesta
{
    "GrupoEmpresa": "T1",  		// Grupo de empresa en el cual se incluyó el asiento.
    "CT2_FILIAL": "D MG 01 ", 	// Sucursal en la cual se incluyó el asiento. 
    "CT2_DOC": "000003", 		// Número de documento generado. 
    "error": ""  				// El error se devolverá vacío si la inclusión ocurriera con éxito, en caso de error se devolverá la descripción del error.
}


IMPORTANTE

** Si el contenido del campo CT2_HIST enviado fuera mayor que el tamaño del campo en el Protheus, el sistema generará de forma automática, líneas de continuación de historial (CT2_DC = 4) de acuerdo con el tamaño del campo CT2_HIST


  • REVERSAL @Post (Reversión de asiento contable)

EndPoint: Camino del servicio REST Protheus + /api/ctb/accountingentry/reversal Ex.: http://localhost:9090/api/ctb/accountingentry/reversal

Body

Debe enviarse en formato Json, de acuerdo con el siguiente modelo

Campo

Descripción

Tipo

Obligatorio

Observación

CT2_DATA

Fecha asiento

Carácter

X

Fecha del asiento que se revertirá.

Se envía en formato carácter ddmmaaaa ej: "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 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 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 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 se generará automáticamente con el próximo disponible para la clave: Fecha, Lote, Sublote.


Ejemplo de envío

Ejemplo de envío
{ 
    "CT2_DATA": "01/09/2023" ,
    "CT2_LOTE":  "THIAGO",
    "CT2_SBLOTE":  "001",
    "CT2_DOC" :  "000003",
	"CT2_LOTEST":"EST001",
	"CT2_SBLOTEST":"001"
}

Ejemplo de respuesta

Ejemplo de respuesta
{
    "GrupoEmpresa": "T1",  		// Grupo de empresa en el cual se incluyó el asiento de reversión.
    "CT2_FILIAL": "D MG 01 ", 	// Sucursal en la cual se incluyó el asiento de reversión. 
    "CT2_DOC": "000001", 		// Número de documento de reversión generado. 
    "error": ""  				// El error se devolverá vacío si la reversión ocurriera con éxito, en caso de error se devolverá la descripción del error.
}


  • DELETE @Post (Borrado de asiento contable)

    EndPoint: Camino del servicio REST Protheus + /api/ctb/accountingentry/delete Ex.: http://localhost:9090/api/ctb/accountingentry/delete

    Body

    Debe enviarse en formato Json, de acuerdo con el siguiente modelo

    Campo

    Descripción

    Tipo

    Obligatorio

    Observación

    CT2_DATA

    Fecha asiento

    Carácter

    X

    Fecha del asiento que se borrará.

    Se envía en formato carácter ddmmaaaa ej: "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 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á.


    Ejemplo de envío

    Ejemplo de envío
    { 
        "CT2_DATA": "01/09/2023" ,
        "CT2_LOTE":  "000001",
        "CT2_SBLOTE":  "001",
        "CT2_DOC" :  "000005"
    }

    Ejemplo de respuesta

    Ejemplo de respuesta
    {
        "GrupoEmpresa": "T1",  		// Grupo de empresa en el cual se borró el asiento.
        "CT2_FILIAL": "D MG 01 ", 	// Sucursal en la cual se borró el asiento. 
        "CT2_DOC": "000005", 		// Número de documento borrado. 
        "error": ""  				// El error se devolverá vacío si el borrado ocurriera con éxito, en caso de error se devolverá la descripción del error.
    }

03. TABLAS UTILIZADAS

  • CT2- Asientos contables
  • CT1- Plan de cuentas
  • CTT- Centro de costo
  • CTH- Clase de valor
  • CTD - Ítem contable