API - Balance parcial Modelo 1

ÍNDICE

Visión general
Método
- model1@Post
Tablas utilizadas

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 Balance parcial Modelo1 (CTBR040).

02. Método

Header

Key	Value	Obligatorio	OBS:
Content-Type	application/json	X	N/A

model1 @Post (Busca saldos de acuerdo con los parámetros enviados)

EndPoint: Camino del servicio REST Protheus + /api/ctb/balance/model1 Ej.: http://localhost:9090/api/ctb/balance/model1

Body

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

Campo	Descripción	Tipo	Obligatorio	Observación
GRUPO_EMPRESA	Grupo de empresa de la cual se realizará la extracción	Carácter	SÍ	N/A
CNPJ	RCPJ (Registro de Contribuyente Persona Jurídica) al cual pertenece el grupo de la empresa	Carácter	SÍ	Tamaño 8 sin guiones y puntaje. Obligatorio solamente cuando no se envía GRUPO_EMPRESA. Los ocho primeros números representan la raíz del RCPJ. Es la identificación única de cada empresa*.
FILIAL	Sucursal o sucursales que se considerarán en la extracción	Carácter	SÍ	Concatenación de los campos Empresa+Unidad de negocio+Sucursal Enviadas separadas por carácter ";" Ej.: "D MG 01 " Ej.2: "D MG 01 ;D MG 02 " *Si se envía el RCPJ, el campo no será obligatorio y la extracción ocurrirá para todas las Sucursales de la inscripción del RCPJ (TECHFIN).
DATA_INICIAL	Informe la Fecha inicial a partir de la cual desea extraer los saldos.	Carácter	SÍ	Fecha enviada en formato carácter ddmmaaaa ej: "01/01/2023"
DATA_FINAL	Informe la Fecha final a partir de la cual desea extraer los saldos.	Carácter	SÍ	Fecha enviada en formato carácter ddmmaaaa ej: "31/10/2023"
CONTA_INICIAL	Informe la cuenta inicial a partir de la cual desea extraer los saldos.	Carácter	NO	" "→ default
CONTA_FINAL	Informe la cuenta final hasta la cual desea extraer los saldos.	Carácter	NO	"ZZZZZZZZZZ"→ default
IMPRIME_CONTAS	Informe si desea imprimir las Cuentas	Numérico	NO	Enviar solamente el número identificador: 1 (Sintéticas) 2 (Analíticas) 3 (Ambas) → default
COD_CONFIG_LIVROS	Determine qué configuración de Libro se utilizará.	Carácter	NO	Si no deseara ninguna configuración específica, deje este campo en blanco. Si el Libro seleccionado tuviera una Visión de gestión vinculada, se imprimirá la Visión.
SALDOS_ZERADOS	Informe si desea que se impriman o no las cuentas con saldos en cero.	Numérico	NO	Enviar solamente el número identificador: 1 (Sí) → default 2 (No)
MOEDA	Informe el código de la moneda en la que desea extraer los saldos.	Carácter	NO	01 → default
TIPO_DE_SALDO	Informe el tipo de saldo que desea extraer.	Carácter	NO	1 → default
FILTRA_SEGMENTO_NO	Informe qué segmento de la máscara contable desea filtrar	Carácter	NO	Si no se informara ningún "Cód Conf Libros", no será posible filtrar el segmento de la máscara. Los próximos 3 parámetros son dependientes de este. Si en la pregunta "Cód Conf Libros" se seleccionara una Configuración que tenga una Visión de gestión vinculada, esta pregunta no se considerará.
CONTEUDO_INI_SEGMEN	Informe el contenido inicial del segmento de máscara contable que se filtrará en la extracción de los saldos.	Carácter	NO	Esta pregunta depende de la respuesta de la pregunta "¿Filtra Segmento Nº?"
CONTEUDO_FIM_SEGMEN	Informe el contenido final del segmento de máscara contable que se filtrará en la extracción de los saldos.	Carácter	NO	Esta pregunta depende de la respuesta de la pregunta "¿Filtra Segmento Nº?"
CONTEUDO_CONTIDO_EM	Informe qué contenidos se filtrarán.	Carácter	NO	Esta opción es válida para casos donde los contenidos que se filtrarán no son secuenciales. Sepárelos por "/". Ej: 001/004/010 Si se completara esta pregunta, las preguntas "Contenido Ini Segmen" y "Contenido Fin Segmen" no se considerarán. Esta pregunta depende de la respuesta de "¿Filtra Segmento Nº?"
IMPRIME_COLUNA_MOV	Informe se desea que la columna de Movimiento del período	Numérico	NO	Enviar solamente el número identificador: 1 (Sí) → default 2 (No)
IMPRIME_CODIGO	Formato de extracción del código del ente	Numérico	NO	Enviar solamente el número identificador: 1 (Normal) → default 2 (Reducido)
DIVIDE_POR	Informe si desea que los valores de los saldos se dividan	Numérico	NO	Enviar solamente el número identificador: 1 (No se aplica (no divide) → default 2 (Cien) 3 (Mil) 4 (Millón)
POSICAO_ANT_L_P	Indique si desea que los valores que se extraerán considerarán o no los asientos de Cálculo de resultados	Numérico	NO	Enviar solamente el número identificador: 1 (Sí) 2 (No) → default
DATA_LUCROS_PERDAS	Informe la fecha de Cálculo de resultado que no desea considerar	Carácter	NO	Fecha enviada en formato carácter ddmmaaaa ej: "29/08/2022" Esta pregunta depende de la respuesta a la pregunta "¿Situación Ant A/E?".
IGNORA_SL_ANT_REC_DES	Informe si desea ignorar el saldo anterior de las cuentas de ingresos/gastos de acuerdo con el grupo y fecha seleccionada en los dos parámetros siguientes	Numérico	NO	Enviar solamente el número identificador: 1 (Sí) 2 (No) → default
GRUPOS_RECEITAS_DESPESAS	Informe qué grupos de ingresos/ gastos que deben tener sus saldos anteriores ignorados.	Carácter	NO	Esta pregunta se considerará solamente si la pregunta 'Ignora Sl Ant. Ing/Gast' estuviera completada con 'Sí'.
DATA_SLD_ANT_RECEITAS_DESP	Informe qué fecha que las cuentas de ingresos/gastos tendrán sus saldos anteriores ignorados.	Carácter	NO	Fecha enviada en formato carácter ddmmaaaa ej: "29/08/2022" Esta pregunta se considerará solamente si la pregunta '¿Ignora Sl Ant.Ing/Gast?' estuviera completada con 'Sí'.
PAGE	Número de la página de resultados	Numérico	NO	Por estándar se enviará el resultado general del informe sin filtros de paginación
PAGESIZE	Cantidad total de la página de resultados	Numérico	NO	Por estándar se enviará el resultado general del informe sin filtros de paginación
TECHFIN	Identificador si la requisición es de la integración TECHFIN	Numérico	NO	Enviar solamente el número identificador: 1 (Sí) 2 (No) → default
QUEBRA_POR_NATUREZA	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
IMP_QUADROS_CONTABEIS	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
IMPRIME_CODIGO	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
IMPRIME_VALOR_0	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
SALTA_LINHA_SINT	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
IMPRIMIR_ATE_O_SEG	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
DESCRICAO_NA_MOEDA	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
FOLHA_INICIAL	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
NUM_LINHAS_P_O_BALANCETE	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API
SELECIONA_FILIAIS	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API	NO SE UTILIZA VÍA API

Ejemplo de envío

Ejemplo de envío

{	
    "RCPJ":"53113791",
    "FECHA_INICIAL": "01/01/2023",
	"FECHA_FINAL": "31/12/2023",
	"TECHFIN" : 1
}

Ejemplo de respuesta

Ejemplo de respuesta

{
    "items": [
        {
            "cuenta": "CTBXATUC",
            "condicion_normal": "2",
            "superior": "",
            "clase": "2",
            "modalidad": "01",
            "descripcion": "REAL",
            "saldo_anterior": 0,
            "debito": 0,
            "credito": 1600.6,
			"cuenta_referencial": "",
            "descripcion_referencial": "",
            "saldo_actual": 1600.6,
            "movimiento": 1600.6,
		 	"vigencia": "12/2023",
			"estatus": "Abierto"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0,
    "po_sync_date": "2023-09-29T19:13:15Z"
}

OBS.: *Parámetros vigencia y estatus solamente devolverán a la integración Techfin.

Importante

(TECHFIN*) Al enviar más de una sucursal, el sistema devolverá la información referente a estatus y cuentas referenciales con base en la sucursal conectada y con base en el plan referencial activo que atiende a la fecha inicial y final enviada (Primera sucursal enviada en el parámetro SUCURSAL).

OBS: Se registrará para el release 12.1.2310

03. TABLAS UTILIZADAS

CT1- Plan de cuentas
CQ0- Saldo por cuenta en el mes
CQ1- Saldo por cuenta en el día
CVN - Plan de cuentas referencial
CVD - Plan de cuentas referenciales
CTG - Calendario contable

Atalhos

Árvore de páginas

ÍNDICE

01. VISIÓN GENERAL

02. Método

03. TABLAS UTILIZADAS