NAV
shell python javascript

Introducción

Bienvenido a la API de Gael Cloud 👋

Tenemos ejemplos en distintos lenguajes (Shell, Python y JavaScript). Puedes revisar los códigos de ejemplo en el área oscura de la derecha y puedes cambiar el lenguaje de programación haciendo click en los tabs de la barra superior derecha.

Esta api está compuesta de dos secciones:

Todos los endpoints de carácter público presentados en la sección Pública, pueden ser utilizados libremente en cualquier entorno, sin propósitos comerciales.

Para interactuar con cualquiera de los endpoints que no estén presentes en la sección Pública, es necesario ser cliente activo de Gael Cloud y contar con una ApiKey. Para más información revisar la sección Autenticación

Si vas a utilizar nuestra API, es importante que tengas en consideración los siguientes puntos:

La documentación de esta API fué creada utilizando Slate.

Pública

⚠️ Rate Limiting

Los endpoints referentes a la a sección Pública están protegidos con rate limiting.

Esto significa que tu ip quedará baneada por una hora si es que realizas más de 9 requests en un intervalo de 10 segundos.

Si tu IP queda baneada... a esperar no más. La API retornará el código 429 y el JSON mostrado en el ejemplo

Si tu IP queda baneada por realizar demasiados requests seguidos, la api retornará el siguiente JSON:

{
  "error": {
    "type": "rate_limiting_error",
    "code": 0,
    "message": "Cantidad de requests excedido"
  }
}

💲 Todas las monedas

Obtener valores actuales de cambio nominal (CLP) respecto a diversas monedas extranjeras.

Los valores de tipo de cambio se actualizan cada 30 minutos desde la web del BANCO CENTRAL DE CHILE.

import requests
response = requests.get("https://api.gael.cloud/general/public/monedas")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/monedas'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

[
  {
    "Codigo": "UF",
    "Nombre": "Unidad de Fomento",
    "Valor": "28708,80"
  },
  {
    "Codigo": "USD",
    "Nombre": "Dolar Americano",
    "Valor": "788,15"
  },
  {
    "Codigo": "UTM",
    "Nombre": "Unidad Tributaria Mensual",
    "Valor": "50372,00"
  },
  {
    "Codigo": "THB",
    "Nombre": "Baht tailandes",
    "Valor": "24,95"
  },
  .......
]

HTTPS Request

💲 Moneda por código

Obtener valor actual de cambio nominal (CLP) de la moneda específica. 

import requests
response = requests.get("https://api.gael.cloud/general/public/monedas/USD")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/monedas/USD'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "Codigo": "USD",
  "Nombre": "Dolar Americano",
  "Valor": "788,15",
  "Fecha": "2020-10-01T19:30:01.000Z"
}

HTTPS Request

🌤 Todos los climas

Datos climáticos procedentes de estaciones meteorológicas a lo largo del país.

Los datos climáticos se actualizan acorde a lo entregado por la web de la DIRECCIÓN METEOROLÓGICA DE CHILE.

import requests
response = requests.get("https://api.gael.cloud/general/public/clima")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/clima'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

[
  {
    "Codigo": "SCFA",
    "Estacion": "Antofagasta",
    "HoraUpdate": "17:00",
    "Temp": "15",
    "Humedad": "77",
    "Estado": "Nublado",
    "Icono": "parcial.png"
  },
  {
    "Codigo": "SCAR",
    "Estacion": "Arica",
    "HoraUpdate": "17:00",
    "Temp": "18",
    "Humedad": "73",
    "Estado": "Nubosidad parcial",
    "Icono": "parcialalta.png"
  },
  .......
]

HTTPS Request

🌤 Clima por código

Obtener valor actual del clima registrado por la estación meteorológica específica. 

import requests
response = requests.get("https://api.gael.cloud/general/public/clima/SCQN")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/clima/SCQN'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "Codigo": "SCQN",
  "Estacion": "Santiago Centro",
  "HoraUpdate": "17:20",
  "Temp": "18.0",
  "Humedad": "42",
  "Estado": "Despejado",
  "Icono": "despejado.png"
}

HTTPS Request

🚨 Sismos

Datos acerca de últimos sismos ocurridos en Chile.

Los datos sismológicos se actualizan cada 5 minutos según la web del CENTRO SISMOLÓGICO NACIONAL.

import requests
response = requests.get("https://api.gael.cloud/general/public/sismos")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/sismos'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

[
  {
    "Fecha": "2022-07-18 18:35:54",
    "Profundidad": "121",
    "Magnitud": "2.6",
    "RefGeografica": "43 km al O de Ollagüe",
    "FechaUpdate": "2022-07-18T23:10:00.830Z"
  },
  .......
]

HTTPS Request

👷‍♀️Indicadores Previred

Información previsional.

La información previsional se actualiza una vez al día, según la web de PREVIRED.

import requests
response = requests.get("https://api.gael.cloud/general/public/previred/012024")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/previred/012024'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
    "PreviredID": 8532,
    "Fecha": "2024-02-09T16:16:16.157Z",
    "PeriodoMY": "012024",
    "PeriodoYM": "2401",
    "UFDescPeriodo": "al 31 de Enero del 2024",
    "UFValPeriodo": "36733,04",
    "UFDescPeridoAnt": "al 31 de Diciembre del 2023",
    "UFValPeriodoAnt": "36789,36",
    "UTMDesc": "Enero 2024",
    "UTMVal": "64666",
    "UTAVal": "775992",
    "RTIAfpUF": "84,3",
    "RTIIpsUF": "60",
    "RTISegCesUF": "126,6",
    "RTIAfpPesos": "3096595",
    "RTIIpsPesos": "2207362",
    "RTISegCesPesos": "4650403",
    "RMITrabDepeInd": "460000",
    "RMIMen18May65": "343150",
    "RMITrabCasaPart": "460000",
    "RMINoRemu": "296511",
    "APVTopeMensUF": "50",
    "APVTopeAnuUF": "600",
    "APVTopeMensPesos": "1836652",
    "APVTopeAnuPesos": "22039824",
    "DepConvenidoUF": "900",
    "DepConvenidoPesos": "33059736",
    "AFCCpiEmpleador": "2,4",
    "AFCCpiTrabajador": "0,6",
    "AFCCpfEmpleador": "3,0",
    "AFCCpfTrabajador": "0",
    "AFCCpi11Empleador": "0,8",
    "AFCCpi11Trabajador": "0",
    "AFCTcpEmpleador": "3,0",
    "AFCTcpTrabajador": "0",
    "AFPCapitalTasaDep": "11,44",
    "AFPCapitalTasaSIS": "1,49",
    "AFPCapitalTasaInd": "12,93",
    "AFPCuprumTasaDep": "11,44",
    "AFPCuprumTasaSIS": "1,49",
    "AFPCuprumTasaInd": "12,93",
    "AFPHabitatTasaDep": "11,27",
    "AFPHabitatTasaSIS": "1,49",
    "AFPHabitatTasaInd": "12,76",
    "AFPPlanVitalTasaDep": "11,16",
    "AFPPlanVitalTasaSIS": "1,49",
    "AFPPlanVitalTasaInd": "12,65",
    "AFPProVidaTasaDep": "11,45",
    "AFPProVidaTasaSIS": "1,49",
    "AFPProVidaTasaInd": "12,94",
    "AFPModeloTasaDep": "10,58",
    "AFPModeloTasaSIS": "1,49",
    "AFPModeloTasaInd": "12,07",
    "AFPUnoTasaDep": "10,49",
    "AFPUnoTasaSIS": "1,49",
    "AFPUnoTasaInd": "11,98",
    "AFamTramoAMonto": "20328",
    "AFamTramoADesde": "0",
    "AFamTramoAHasta": "539328",
    "AFamTramoBMonto": "12475",
    "AFamTramoBDesde": "539328",
    "AFamTramoBHasta": "787746",
    "AFamTramoCMonto": "3942",
    "AFamTramoCDesde": "787746",
    "AFamTramoCHasta": "1228614",
    "AFamTramoDMonto": "0",
    "AFamTramoDDesde": "1228614",
    "AFamTramoDHasta": "9999999999",
    "TrabPesadoCalif": "4",
    "TrabPesadoEmpl": "2",
    "TrabPesadoTrabaj": "2",
    "TrabMenosPesadoCalif": "2",
    "TrabMenosPesadoEmpl": "1",
    "TrabMenosPesadoTrabaj": "1",
    "Dist7PorcCCAF": "3,1",
    "Dist7PorcFonasa": "3,9"
}

HTTPS Request

🏢Indicadores Impuesto Único

Información sobre impuesto único de 2da categoría.

La información sobre impuesto único se actualiza una vez al día, según la web del SII.

import requests
response = requests.get("https://api.gael.cloud/general/public/impunico/022024")
print(response.text)

curl -X GET --header 'Accept: application/json' \
'https://api.gael.cloud/general/public/impunico/022024'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
    "ImpUnicoID": 1051,
    "FechaUpdate": "2024-02-13T13:36:51.470Z",
    "PeriodoMY": "022024",
    "PeriodoYM": "2402",
    "PeriodoNombre": "Febrero 2024",
    "FechaDesde": "2024-02-01T00:00:00.000Z",
    "FechaHasta": "2024-02-29T00:00:00.000Z",
    "TR1Desde": "0",
    "TR1Hasta": "868630,50",
    "TR1Factor": "0",
    "TR1CReb": "0",
    "TR1TIEfectiva": "0",
    "TR2Desde": "868630,51",
    "TR2Hasta": "1930290,00",
    "TR2Factor": "0,04",
    "TR2CReb": "34745,22",
    "TR2TIEfectiva": "2,20",
    "TR3Desde": "1930290,01",
    "TR3Hasta": "3217150,00",
    "TR3Factor": "0,08",
    "TR3CReb": "111956,82",
    "TR3TIEfectiva": "4,52",
    "TR4Desde": "3217150,01",
    "TR4Hasta": "4504010,00",
    "TR4Factor": "0,135",
    "TR4CReb": "288900,07",
    "TR4TIEfectiva": "7,09",
    "TR5Desde": "4504010,01",
    "TR5Hasta": "5790870,00",
    "TR5Factor": "0,23",
    "TR5CReb": "716781,02",
    "TR5TIEfectiva": "10,62",
    "TR6Desde": "5790870,01",
    "TR6Hasta": "7721160,00",
    "TR6Factor": "0,304",
    "TR6CReb": "1145305,40",
    "TR6TIEfectiva": "15,57",
    "TR7Desde": "7721160,01",
    "TR7Hasta": "19946330,00",
    "TR7Factor": "0,35",
    "TR7CReb": "1500478,76",
    "TR7TIEfectiva": "27,48",
    "TR8Desde": "19946330,01",
    "TR8Hasta": "99999999",
    "TR8Factor": "0,4",
    "TR8CReb": "2497795,26",
    "TR8TIEfectiva": "27,48"
}

HTTPS Request

Autenticación

Para autenticar un request, usa el siguiente código:

#TO-DO

# Mediante shell, puedes pasar el header correcto en cada request
curl "https://api.gael.cloud/v2/todos_los_endpoints" \
  -H "ApiKey: xxxxxxxxxxxxxxxx"

//TO-DO

Asegurate de reemplazar xxxxxxxxxxxxxxxx por tu ApiKey.

La API de GAEL utiliza ApiKeys para conceder acceso a los diferentes endpoints ofrecidos por la API. Para obtener una ApiKey asociada a tu cuenta de cliente, debes enviar un correo electrónico a [email protected] o contactar directamente con tu agente.

La API espera que la ApiKey esté incluida en todos los requests hacia el servidor en un header que se compone de la siguiente manera:

ApiKey: xxxxxxxxxxxxxxxx

Manejo de errores

Códigos de error

La API de GAEL utiliza los siguientes códigos de error HTTP:

Código Significado
400 Bad Request - La solicitud contiene información errónea
401 Unauthorized - Tu ApiKey no es válida o no la estás enviando correctamente según la sección Autenticación
403 Forbidden - Baneo permanente por uso indebido de api
404 Not Found - El endpoint solicitado no existe
422 Unprocessable Entity - Existe un error de lógica (negocio)
429 Too Many Requests - IP baneada por demasiados requests seguidos
500 Internal Server Error - Error interno del servidor. Intenta nuevamente más tarde.
503 Service Unavailable - Api temporalmente fuera de servicio. Intenta nuevamente más tarde.

Objeto "error"

#TO-DO

# Vamos a enviar una ApiKey incorrecta en el header
curl "https://api.gael.cloud/v2/cuenta/login" \
  -H "ApiKey: Api_Key_Incorrecta"

//TO-DO

Si ocurre un error, la api retornará un objeto JSON similar a este:

{
  "error": {
    "type": "auth_error",
    "code": 1001,
    "message": "ApiKey no válida"
  }
}

Si la api retorna cualquier estado que no sea 200 OK, retornará además un objeto en formato JSON con mayor información acerca del error.

El objeto error esta compuesto de la siguiente manera: error: { type: type, code: code, message: msg }

Parámetro Tipo Descripción
type string Tipo de error (internal_error, auth_error, bad_request_error, logic_error, provider_error, rate_limiting_error)
code int Código interno del error
message string Mensaje descriptivo del error

Empresas

Lista de empresas

Lista de todas las empresas activas

#TO-DO

curl "https://api.gael.cloud/v2/empresa/lista" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 1,
      "nombre": "Empresa Pulenta",
      "rut": "76658632-5",
      "razon_social": "Empresa Pulenta SpA",
      "giro": "OTRAS ACTIVIDADES DE SERVICIOS INFORMÁTICOS"
    }
  ]
}

HTTPS Request

Detalle de empresa

Entrega detalle más completo de la empresa a consultar

Obtener detalle de la empresa con el id = 1

#TO-DO

curl "https://api.gael.cloud/v2/empresa/detalle?empresa_id=1" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 1,
      "nombre": "Empresa Pulenta",
      "rut": "76658632-5",
      "razon_social": "Empresa Pulenta SpA",
      "giro": "OTRAS ACTIVIDADES DE SERVICIOS INFORMÁTICOS",
      "activa": true,
      "url": "www.empresapulenta.cl",
      "direccion": "Av Las Condes #6541",
      "ciudad": "Santiago",
      "comuna": "Las Condes",
      "telefono": "21892-1258"
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empresa_id Obligatorio int Id de la empresa a consultar null

Usuarios

Detalle de un usuario

Listado de algunas características de un usuario

Obtener detalles de un usuario con id = 1:

#TO-DO

curl "https://api.gael.cloud/v2/usuario/detalle?usuario_id=1" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 1,
      "nombre": "Juán Perez",
      "nombre_corto": "Juanito",
      "email": "[email protected]",
      "creado_fecha": "2017-05-15T11:45:13.117Z"
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
usuario_id Obligatorio int Id del usuario a consultar null

Unidad de Control

Lista Unidades de Control

Lista de todas las unidades de control

Obtener todas las unidades de control para la empresa con id = 1:

#TO-DO

curl "https://api.gael.cloud/v2/ucontrol/lista?empresa_id=1" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 24,
  "data": [
    {
      "id": 39,
      "estado_id": 5,
      "nombre": "Proyecto X",
      "tipo": true,
      "unegocio_id": 9,
      "unegocio_nombre": "Negocio XYZ",
      "creado_por_id": 7,
      "creado_por": "Juán Perez",
      "empresa_nombre": "Empresa Pulenta",
      "empresa_id": 1
    },
    ......
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empresa_id Opcional int Id de la empresa a consultar null

Detalle Unidad de Control

Entrega detalle más completo de la unidad de control a consultar

Obtener detalle de la unidad de control con el id = 2046:

#TO-DO

curl "https://api.gael.cloud/v2/ucontrol/detalle?ucontrol_id=2046" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 2046,
      "estado_id": 1,
      "nombre": "Proyecto X",
      "creado_fecha": "2020-01-25T16:47:53.023Z",
      "descripcion": "Transformación Digital Proyecto X",
      "tipo": true,
      "unegocio_id": 12,
      "unegocio_nombre": "Desarrollos a Medida",
      "usuario_id": 2,
      "empresa_id": 1,
      "empresa_nombre": "Empresa Pulenta",
      "tipo_cliente": 2,
      "mext": true,
      "tercero_id": 2138,
      "activo_por_id": 2,
      "activo_por_nombre": "Juán Perez",
      "activo_fecha": "2020-01-25T16:55:22.000Z"
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
ucontrol_id Obligatorio int Id de la unidad de control a consultar

Categorías

Lista Categorías

Lista de todas las categorías

Obtener todas las categorías para la empresa con id = 1 y la unidad de negocio con el id = 2:

#TO-DO

curl "https://api.gael.cloud/v2/categoria/lista?empresa_id=1&unegocio_id=2" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

"count": 4,
  "data": [
    {
      "id": 32,
      "nombre": "Comisiones Bancarias",
      "tipo": true,
      "ucontrol_id": 4,
      "unegocio_id": 2,
      "empresa_id": 1
    },
    .....
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empresa_id Obligatorio int Id de la empresa a consultar null
unegocio_id Opcional int Id de la unidad de negocio null
ucontrol_id Opcional int Id de la unidad de control null

Detalle Categoría

Entrega detalle más completo de la categoría a consultar

Obtener detalle de la categoría con el id = 27:

#TO-DO

curl "https://api.gael.cloud/v2/categoria/detalle?categoria_id=27" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 27,
      "nombre": "Software",
      "tipo": true,
      "activo": true,
      "ucontrol_id": 1,
      "unegocio_id": 1,
      "empresa_id": 1,
      "asignada": true,
      "creado_por_id": 1,
      "creado_fecha": "2020-04-28T20:20:55.353Z"
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
categoria_id Obligatorio int Id de la categoría a consultar

Compras / Egresos

Lista de registros

Lista todas las compras y egresos presentes en el módulo de salidas de Gael Gestión, excepto transacciones asociadas a remuneraciones y costos internos.

Solamente podrás consultar:

Obtener todas las órdenes de compra para la empresa con el id = 1

#TO-DO

curl "https://api.gael.cloud/v2/comegr/lista?empresa_id=1&ttrans_id=1" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 13265,
      "correlativo": "C-0047-21",
      "ttrans_id": 1,
      "creado_por_id": 14,
      "creado_por_nombre": "Andrés Colombino",
      "creado_fecha": "2021-03-10T14:03:26.257Z",
      "estado_id": 4,
      "empresa_id": 1,
      "empresa_nombre": "Empresa XYZ",
      "area_id": 0,
      "area_nombre": null,
      "unegocio_id": 3,
      "unegocio_nombre": "Gastos de administración y venta",
      "ucontrol_id": 6,
      "ucontrol_nombre": "Gastos Generales",
      "categoria_id": 51,
      "categoria_nombre": "Arriendos",
      "operacion_id": 10,
      "operacion_nombre": "Compra Afecta en Otra Moneda",
      "tercero_id": 2177,
      "tercero_nombre": "Sociedad Alto Norte",
      "tercero_rut": "76132765-1",
      "presu_id": 0,
      "presu_nombre": null,
      "valor_iva": 185944,
      "valor_costo": 978652,
      "valor_final": 1164596,
      "rechazada": false,
      "emit_fecha": "2021-04-01T12:35:13.000Z",
      "per_cont": "2102",
      "cod_custom": "SM-965"
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Opcional int Id de la empresa a consultar null
ttrans_id Opcional int Tipo de transacciones a consultar null
estado_id_desde Opcional int Estado desde a consultar null
estado_id_hasta Opcional int Estado hasta a consultar null
fech_emit_desde Opcional date DD-MM-YYYY Fecha emisión desde a consultar null
fech_emit_hasta Opcional date DD-MM-YYYY Fecha emisión hasta a consultar hoy
area_id Opcional int Id de la unidad de negocio null
unegocio_id Opcional int Id de la unidad de negocio null
ucontrol_id Opcional int Id de la unidad de control null
categoria_id Opcional int Id de la categoría null
operacion_id Opcional int Id de la operación null
tercero_id Opcional int Id del proveedor null
con_detalle Opcional bool Incluir detalles de la transacción false

Detalle Registro

Entrega detalle más completo de la transacción a consultar

Se entregará la siguiente información:

Obtener detalle de la transacción con el id = 13262

#TO-DO

curl "https://api.gael.cloud/v2/comegr/detalle?id=13262" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 13262,
      "correlativo": "C-0038-21",
      "ttrans_id": 1,
      "ttrans_nombre": "Orden de Compra",
      "creado_por_id": 14,
      "creado_por_nombre": "Andrés Colombino",
      "creado_fecha": "2021-03-10T13:03:10.907Z",
      "estado_id": 7,
      "empresa_id": 1,
      "empresa_nombre": "Empresa Pulenta",
      "area_id": 0,
      "unegocio_id": 3,
      "unegocio_nombre": "Gastos de administración y venta",
      "ucontrol_id": 6,
      "ucontrol_nombre": "Gastos Generales",
      "categoria_id": 141,
      "categoria_nombre": "Dominios",
      "operacion_id": 10,
      "operacion_nombre": "Compra Afecta en Otra Moneda",
      "tercero_id": 32,
      "tercero_nombre": "Dominio Ahora",
      "tercero_rut": "76543817-1",
      "tercero_razsocial": "Dominio Ahora SPA",
      "tercero_direccion": "Av Las Perdices 3611",
      "tercero_comuna": "Peñalolén",
      "tercero_ciudad": "Santiago",
      "tercero_pais": "Chile",
      "contacto_id": 0,
      "contacto_nombre": null,
      "contacto_telefono": null,
      "contacto_email": null,
      "presu_id": 0,
      "presu_nombre": null,
      "tasa_iva": 19,
      "tasa_ret": 11.5,
      "valor_afecto": 12000,
      "valor_exento": 0,
      "valor_iva": 2280,
      "valor_ie": 0,
      "valor_ret": 0,
      "valor_costo": 12000,
      "valor_total": 14280,
      "rechazada": false,
      "per_cont_id": 51,
      "per_cont": "Mar-21",
      "cond_comercial": "30 días contra factura",
      "cond_comercial_detalle": "30 dias contra entrega de factura",
      "mext": true,
      "tasa_cambio": 674.5394,
      "curr_id": 1,
      "curr_nombre": "Dolar Americano",
      "valor_afecto_mext": 17.79,
      "valor_exento_mext": 0,
      "valor_iva_mext": 3.38,
      "valor_ret_mext": 0,
      "valor_total_mext": 21.17
    }
  ],
  "detalles": {
    "count": 1,
    "data": [
      {
        "id": 10898,
        "codigo": "",
        "detalle": "Dominio gael.es.pulento.cl",
        "cantidad": 1,
        "veces": 1,
        "precio_unit": 12000.0559,
        "precio_unit_mext": 17.79,
        "descuento_unit": 0,
        "precio_total": 12000.0559,
        "precio_total_mext": 17.79,
        "exento": false
      }
    ]
  },
  "pagos": {
    "count": 1,
    "data": [
      {
        "id": 12184,
        "estado_id": 7,
        "cuota": "1/1",
        "valor_comp": 21.17,
        "fecha_comp": "2021-04-09T13:03:25.000Z",
        "valor_pagado": 21.17,
        "fecha_pagado": "2021-03-15T11:56:01.000Z",
        "curr_nombre": "USD",
        "forma_pago": "Tarjeta de Crédito",
        "cta_origen": "TC BCI USD"
      }
    ]
  },
  "documentos": {
    "count": 1,
    "data": [
      {
        "id": 7763,
        "estado_id": 3,
        "numero": 765441,
        "documento_tipo": "Factura Electrónica",
        "dte_id": 5654,
        "recibido": true,
        "fecha_recibido": "2021-03-12T10:31:12.363Z"
      }
    ]
  }
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
id Obligatorio int Id de la transacción a consultar

Reporte Compras / Egresos

Muestra un informe del registro de Compra o de Egreso asociado en formato PDF o HTML

Obtener el reporte asociado al registro Compra/Egreso con id = 2490

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/comegr/reporte?id=2490&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output reporte_comegr.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/comegr/reporte?id=2490&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
id Obligatorio int Id del registro de salida a consultar null
formato Obligatorio string pdf html Formato del reporte null

Ventas / Ingresos

Reporte Ventas / Ingresos

Muestra un informe del registro de Venta o de Ingreso asociado en formato PDF o HTML

Obtener el reporte asociado al registro Venta/Ingreso con id = 62541

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/venting/reporte?id=62541&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output reporte_venting.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/venting/reporte?id=62541&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
id Obligatorio int Id del registro de entrada a consultar null
formato Obligatorio string pdf html Formato del reporte null

Crear Registro Venta

Crea transacción de venta / ingreso y obtiene el id de la transacción creada y de sus detalles relacionados

Para crear un registro, necesitas enviar la información en el body del request de la siguiente manera:

#TO-DO

  curl -X POST \
   -H "ApiKey: xxxxxxxxxxxxxxxx" \
   -H "Content-Type: application/json" \
   -d \
    '{
        "ttrans_id": 4,
        "empresa_id": 1,
        "status_id": 1,
        "usuario_id": 1,
        "tercero_id": 25749,
        "ucontrol_id": 5897,
        "categoria_id": null,
        "periodo": "0522",
        "operacion_id": 13,
        "mext": false,
        "total_afecto": 1763190.00,
        "total_exento": 0,
        "total_retencion": 0,
        "total_iva": 335006.00,
        "total_final": 2098196.00,
        "curr_id": 0,
        "tasa_cambio": 1,
        "notas": "Asociada a cotización XYZ",
        "detalles": {
          "data": [
            {
              "detalle": "Detalle 1",
              "cantidad": 1,
              "veces": 1,
              "precio_unit": 1100110.00,
              "descuento_unit": 0,
              "exento": false,
              "producto_id": 0
            },
            {
              "detalle": "Detalle 2",
              "cantidad": 1,
              "veces": 1,
              "precio_unit": 6565.00,
              "descuento_unit": 0,
              "exento": false,
              "producto_id": 0
            },
            {
              "detalle": "Detalle 3",
              "cantidad": 1,
              "veces": 1,
              "precio_unit": 656515.00,
              "descuento_unit": 0,
              "exento": false,
              "producto_id": 0
            }
          ]
        }
      }' \
  'https://api.gael.cloud/v2/venting/crear'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "nvid": 22506,
  "detalles": [
    {
      "nvdetid": 21257
    },
    {
      "nvdetid": 21258
    },
    {
      "nvdetid": 21259
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
ttrans_id Obligatorio int Tipo de transacción null
empresa_id Obligatorio int Id de la empresa null
status_id Obligatorio int Estado de la transacción 1
usuario_id Obligatorio int Propietario de la transacción null
tercero_id Obligatorio int Cliente asociado null
ucontrol_id Obligatorio int Unidad de control asociada null
categoria_id Opcional int Categoría asociada null
periodo Obligatorio string YYMM Período null
operacion_id Obligatorio int Operación para cálculo null
mext Opcional bool Si es en moneda extranjera false
total_afecto Opcional float Valor total afecto 0
total_exento Opcional float Valor total exento 0
total_retencion Opcional float Valor total retención 0
total_iva Opcional float Valor total IVA 0
total_final Opcional float Valor total final 0
curr_id Opcional int ID de moneda extranjera 0
tasa_cambio Opcional float Tasa de cambio de moneda extranjera 1
notas Opcional string (255) Notas o instrucciones adicionales null

El parámetro ttrans_id admite los siguientes valores:

El parámetro status_id admite los siguientes valores:

Parámetros Detalles

Parámetro Requerido Tipo Formato Descripción Default
detalle Obligatorio string (250) Descripción del item null
cantidad Obligatorio int Cantidad 0
veces Opcional int Veces 1
precio_unit Obligatorio float Precio unitario null
descuento_unit Opcional float % Descuento unitario 0
exento Opcional bool Item es exento false
producto_id Opcional int Producto asociado 0

Fondos por rendir

Reporte de fondos por rendir

Obtener el reporte del fondo por rendir indicado

Obtener el reporte del fondo por rendir con ID = 1234

#TO-DO

#El siguiente ejemplo retorna el reporte del fondo por rendir en formato PDF
curl "https://api.gael.cloud/v2/fondrend/reporte?id=1234&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output reporte_fondrend.pdf

#El siguiente ejemplo retorna el reporte del fondo por rendir en HTML
curl "https://api.gael.cloud/v2/fondrend/reporte?id=1234&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
id Obligatorio int Id del fondo por rendir null
formato Obligatorio string pdf html Formato del reporte

Presupuestos

Lista de presupuestos

Lista todos los presupuestos de Gastos o Ventas presentes en el módulo de presupuestos de Gael Gestión.

Se podrán consultar:

Obtener todos los presupuestos de Gastos para la empresa con el id = 5

#TO-DO

curl "https://api.gael.cloud/v2/presupuestos/lista?empresa_id=5&tipo=0" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
    "count": 9,
    "data": [
        {
            "id": 12345,
            "tipo_presupuesto": false,
            "presu_nombre": "Evento Juego Entretenido",
            "creado_por_id": 64,
            "creado_por_nombre": "George Lynch",
            "creado_fecha": "2021-08-03T17:54:35.027Z",
            "estado_id": 4,
            "estado": "Cerrado",
            "empresa_id": 1,
            "empresa_nombre": "Empresa XYZ",
            "area_id": 0,
            "area_nombre": null,
            "unegocio_id": 3,
            "unegocio_nombre": "Start Labs",
            "ucontrol_id": 123,
            "ucontrol_nombre": "Feria Start",
            "valor_proyectado": 4769000,
            "valor_ejecutado": 4769000,
            "valor_provisionado": null,
            "valor_neto_real": 4769000,
            "valor_iva": 637750.2,
            "valor_final": 11146502.2,
            "variacion_neto": 0,
            "variacion_bruto": 0,
            "porcentaje_variacion": 0,
            "emitido": true,
            "emitido_fecha": "2021-08-03T17:57:59.000Z",
            "emitido_por_id": 2,
            "aprobado": true,
            "aprobado_fecha": "2021-08-03T18:00:02.000Z",
            "aprobado_por_id": 2,
            "aprobado_por_nombre": "Andrés Colombino",
            "cerrado": true,
            "cerrado_fecha": "2021-08-05T18:13:56.000Z",
            "cerrado_por_id": 2,
            "cerrado_por_nombre": "Andrés Colombino",
            "archivado": true,
            "rechazado": false,
            "rechazado_fecha": null,
            "rechazado_por_id": 0,
            "razon_rechazo": null,
            "cantidad_cotiz_vinculada": 1,
            "ultima_cotiz_id_vinculada": 123456,
            "per_cont": "2108",
            "moneda_extranjera": false,
            "moneda_extr_nombre": null,
            "valor_moneda_extr": null
        },
        ......
    ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Opcional int Id de la empresa a consultar null
tipo Opcional int Tipo de presupuesto a consultar null
estado_id_desde Opcional int Estado desde a consultar null
estado_id_hasta Opcional int Estado hasta a consultar null
fech_creado_desde Opcional date DD-MM-YYYY Fecha creación desde a consultar null
fech_creado_hasta Opcional date DD-MM-YYYY Fecha creación hasta a consultar hoy
fech_emit_desde Opcional date DD-MM-YYYY Fecha emisión desde a consultar null
fech_emit_hasta Opcional date DD-MM-YYYY Fecha emisión hasta a consultar hoy
fech_aprob_desde Opcional date DD-MM-YYYY Fecha aprobación desde a consultar null
fech_aprob_hasta Opcional date DD-MM-YYYY Fecha aprobación hasta a consultar hoy
fech_cerrado_desde Opcional date DD-MM-YYYY Fecha cierre desde a consultar null
fech_cerrado_hasta Opcional date DD-MM-YYYY Fecha cierre hasta a consultar hoy
area_id Opcional int Id de la unidad de negocio null
unegocio_id Opcional int Id de la unidad de negocio null
ucontrol_id Opcional int Id de la unidad de control null
tercero_id Opcional int Id del proveedor null
con_detalle Opcional bool Incluir detalles de la transacción false

Detalle Presupuesto

Entrega detalle más completo del presupuesto a consultar

Se entregará la siguiente información:

Obtener detalle del presupuesto con el id = 12345

#TO-DO

curl "https://api.gael.cloud/v2/presupuestos/detalle?id=12345" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
    "count": 1,
    "data": [
        {
            "id": 12345,
            "tipo_presupuesto": false,
            "presu_nombre": "Evento Juego Entretenido",
            "creado_por_id": 64,
            "creado_por_nombre": "George Lynch",
            "creado_fecha": "2021-08-03T17:54:35.027Z",
            "estado_id": 4,
            "estado": "Cerrado",
            "empresa_id": 1,
            "empresa_nombre": "Empresa XYZ",
            "area_id": 0,
            "area_nombre": null,
            "unegocio_id": 3,
            "unegocio_nombre": "Start Labs",
            "ucontrol_id": 123,
            "ucontrol_nombre": "Feria Start",
            "valor_proyectado": 4769000,
            "valor_ejecutado": 4769000,
            "valor_provisionado": null,
            "valor_neto_real": 4769000,
            "valor_iva": 637750.2,
            "valor_final": 11146502.2,
            "variacion_neto": 0,
            "variacion_bruto": 0,
            "porcentaje_variacion": 0,
            "emitido": true,
            "emitido_fecha": "2021-08-03T17:57:59.000Z",
            "emitido_por_id": 2,
            "aprobado": true,
            "aprobado_fecha": "2021-08-03T18:00:02.000Z",
            "aprobado_por_id": 2,
            "aprobado_por_nombre": "Andrés Colombino",
            "cerrado": true,
            "cerrado_fecha": "2021-08-05T18:13:56.000Z",
            "cerrado_por_id": 2,
            "cerrado_por_nombre": "Andrés Colombino",
            "archivado": true,
            "rechazado": false,
            "rechazado_fecha": null,
            "rechazado_por_id": 0,
            "razon_rechazo": null,
            "cantidad_cotiz_vinculada": 1,
            "ultima_cotiz_id_vinculada": 123456,
            "per_cont": "2108",
            "moneda_extranjera": false,
            "moneda_extr_nombre": null,
            "valor_moneda_extr": null,
            "detalles":
            {
                "count": 14,
                "data": [
                    {
                        "id": 123,
                        "detalle": "Consolas Videojuegos",
                        "prev_cantidad": 10,
                        "prev_veces": 1,
                        "prev_precio_unit": 5200000,
                        "prev_precio_total": 5298800,
                        "prev_valor_iva": 98800,
                        "ejec_cantidad": 10,
                        "ejec_veces": 1,
                        "ejec_precio_unit": 5200000,
                        "ejec_precio_total": 5298800,
                        "ejec_valor_iva": 98800,
                        "variacion": 0,
                        "ttrans_id": 1,
                        "nombre_transaccion": "Compra",
                        "codigo": null,
                        "categoria": "Equipos",
                        "categoria_id": 15,
                        "operacion": "Compra Afecta",
                        "operacion_id": 1,
                        "proveedor_nombre": null,
                        "proveedor_id": null,
                        "grupo_id": 122,
                        "grupo_nombre": "122 | Equipos",
                        "observaciones": null
                    },
                    ......
                ]
            }
        }
    ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
id Obligatorio int Id del presupuesto a consultar

Documentos

Lista de documentos de compra

Entrega una lista de documentos de compra, con o sin listado de movimientos, según parámetros de entrada

Obtener la lista de documentos, con listado de movimientos, para la empresa con id = 1 y fechas desde 01-05-2021, hasta 02-05-2021

#TO-DO

#El siguiente ejemplo retorna la lista de documentos según los filtros indicados
curl "https://api.gael.cloud/v2/documentos/compra/lista?id_empresa=1&fech_emit_desde=01-05-2021&fech_emit_hasta=02-05-2021&con_detalle=true" \
  -H "ApiKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 12351,
      "numero_documento": 223144,
      "fecha_emision": "2021-05-02T00:00:00.000Z",
      "fecha_vencimiento": null,
      "total_afecto": 0,
      "total_exento": 6400,
      "total_iva": 0,
      "total_final": 6400,
      "tasa_iva": 19,
      "es_documento_parcial": true,
      "id_tipo_doc": 4,
      "recibido_ok": true,
      "id_recibido_por": 6,
      "fecha_recepcion": "2021-06-07T12:53:36.120Z",
      "es_moneda_extranjera": false,
      "nombre_documento": "Factura Exenta Electrónica",
      "descripcion_moneda": "Peso Chileno",
      "nombre_emitido_por": "Clark Kent",
      "id_periodo_contable": 21,
      "periodo_contable": "May-21",
      "id_tercero": 581,
      "rut_tercero": "76574879-8",
      "razon_social": "Supermen of America suc. Chile",
      "observacion": null,
      "id_operacion": 2,
      "id_moneda": 0,
      "nombre_moneda": "CLP",
      "id_categoria": 15,
      "nombre_categoria": "Trajes",
      "id_tipo_transaccion": 1,
      "id_unidad_control": 30,
      "unidad_control": "Vestimenta",
      "tipo_unidad_control": true,
      "id_unidad_negocio": 1,
      "id_area": 0,
      "id_status": 3,
      "id_dte": 123144,
      "id_oc": 65477,
      "correlativo_oc": "C-4535-21",
      "id_status_oc": 7,
      "id_empresa": 1,
      "empresa_nombre": "Sastres DC",
      "tipo_venta": "Afecta",
      "id_tipo_compra": 1,
      "anticipo": false,
      "es_factura_cedida": false,
      "id_tercero_cesion": 0,
      "cod_custom": null,
      "detalles": {
        "count": 1,
        "data": [
          {
            "NroLinDet": "1",
            "IndExe": "1",
            "NmbItem": "TRJ",
            "DscItem": "Traje anti kriptonita",
            "QtyItem": "1.0",
            "PrcItem": "6400.0",
            "MontoItem": "6400"
          }
        ]
      }
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
id_empresa Opcional int Id de la empresa null
id_tipo_transaccion Opcional int Id tipo transacción null
estado_id_desde Opcional int 0 a 6 Id de estado desde 0
estado_id_hasta Opcional int 0 a 6 Id de estado hasta 0
fech_emit_desde Opcional date DD-MM-YYYY Fecha emisión de documento, desde null
fech_emit_hasta Opcional date DD-MM-YYYY Fecha emisión de documento, hasta hoy
id_area Opcional int Id del área 0
id_unidad_negocio Opcional int Id de la unidad de negocio 0
id_unidad_control Opcional int Id de la unidad de control 0
id_categoria Opcional int Id de la categoría 0
id_operacion Opcional int Id de la operación 0
id_tercero Opcional int Id del tercero 0
con_detalle Opcional bool Indica si se muestran los detalles del documento false

Lista de documentos de venta

Entrega una lista de documentos de venta, con o sin listado de movimientos, según parámetros de entrada

Obtener la lista de documentos, con listado de movimientos, para la empresa con id = 1 y fechas desde 01-02-2021, hasta 02-02-2021

#TO-DO

#El siguiente ejemplo retorna la lista de documentos según los filtros indicados
curl "https://api.gael.cloud/v2/documentos/venta/lista?id_empresa=1&fech_emit_desde=01-02-2021&fech_emit_hasta=02-02-2021&con_detalle=true" \
  -H "ApiKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "id": 646,
      "numero_documento": 34532,
      "fecha_documento": "2021-02-02T00:00:00.000Z",
      "fecha_vencimiento": null,
      "total_afecto": 3302344,
      "total_exento": 0,
      "total_iva": 627445,
      "total_final": 3929789,
      "tasa_iva": 19,
      "anticipo": false,
      "descuento_documento": 0,
      "descuento_documento_porcent": 0,
      "es_documento_parcial": false,
      "id_tipo_doc": 653,
      "emitido_ok": true,
      "id_emitido_por": 5,
      "nombre_emitido_por": "Elmer Figueroa",
      "fecha_emision": "2021-02-02T11:09:08.837Z",
      "es_moneda_extranjera": false,
      "nombre_documento": "Factura Electrónica",
      "id_periodo_contable": 34,
      "periodo_contable": "Feb-21",
      "id_tercero": 233,
      "rut_tercero": "76100200-K",
      "razon_social": "Torero S A",
      "tercero": false,
      "observacion": null,
      "id_operacion": 12314,
      "id_moneda": 1,
      "nombre_moneda": "CLP",
      "descripcion_moneda": "Peso Chileno",
      "id_nv": 6436,
      "id_status_nv": 7,
      "id_categoria": 76,
      "nombre_categoria": "Venta Cliente",
      "id_tipo_transaccion": 34,
      "id_unidad_control": 768,
      "tipo_unidad_control": true,
      "id_unidad_negocio": 81,
      "id_area": 0,
      "id_status": 3,
      "correlativo_nv": "V-0098-13",
      "recibido_ok": false,
      "id_recibido_por": 2,
      "fecha_recepcion": "2021-02-02T11:09:08.837Z",
      "id_empresa": 1,
      "empresa_nombre": "ONU",
      "id_comprobante_contable": 1231,
      "id_dte": 887,
      "codigo_referencia": null,
      "id_dte_referencia1": 24266,
      "dte_referencia1": "87345379977",
      "fecha_dte_referencia1": "2021-02-02T00:00:00.000Z",
      "razon_dte_referencia1": "ORDEN DE COMPRA CLIENTE",
      "id_dte_referencia2": null,
      "dte_referencia2": null,
      "fecha_dte_referencia2": "2021-02-02T00:00:00.000Z",
      "razon_dte_referencia2": null,
      "id_dte_referencia3": null,
      "dte_referencia3": null,
      "fecha_dte_referencia3": "2021-02-02T00:00:00.000Z",
      "razon_dte_referencia3": null,
      "acteco": 429000,
      "tipo_despacho": null,
      "cedido": false,
      "cedido_a_nombre": null,
      "cedido_a_rut": null,
      "id_tipo_prod_vta": 0,
      "detalles": {
        "count": 1,
        "data": [
          {
            "NroLinDet": "1",
            "NmbItem": "Rosas y motos",
            "DscItem": "Rosas frescas y motos choperas para grabar vídeo clip musical",
            "QtyItem": "1.00",
            "PrcItem": "3302344.00",
            "MontoItem": "3302344"
          }
        ]
      }
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
id_empresa Opcional int Id de la empresa null
id_tipo_transaccion Opcional int Id tipo transacción null
estado_id_desde Opcional int 0 a 6 Id de estado desde 0
estado_id_hasta Opcional int 0 a 6 Id de estado hasta 0
fech_emit_desde Opcional date DD-MM-YYYY Fecha emisión de documento, desde null
fech_emit_hasta Opcional date DD-MM-YYYY Fecha emisión de documento, hasta hoy
id_area Opcional int Id del área 0
id_unidad_negocio Opcional int Id de la unidad de negocio 0
id_unidad_control Opcional int Id de la unidad de control 0
id_categoria Opcional int Id de la categoría 0
id_operacion Opcional int Id de la operación 0
id_tercero Opcional int Id del tercero 0
con_detalle Opcional bool Indica si se muestran los detalles del documento false

Reporte DTE

Entrega el DTE asociado al documento en formato PDF, XML, JSON o HTML

Obtener el DTE asociado al documento de compra con id = 6484

#TO-DO

#El siguiente ejemplo retorna el DTE con su copia cedible en formato PDF
curl "https://api.gael.cloud/v2/documentos/reporte?doc_id=6484&is_doc_venta=false&formato=pdf&cedible=2&tipo_papel=0" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output dte_cedible.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/documentos/reporte?folio=313830&tipo_doc=52&id_empresa=5&formato=html&tipo_papel=0" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

#El siguiente ejemplo retorna el DTE en formato JSON
curl "https://api.gael.cloud/v2/documentos/reporte?doc_id=6484&is_doc_venta=false&formato=json" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "DTE": {
    "version": "1.0",
    "Documento": {
      "ID": "MiPE76385871-16758",
      "Encabezado": {
        "IdDoc": {
          "TipoDTE": "33",
          "Folio": "666",
          "FchEmis": "2021-04-01",
          "TpoTranCompra": "1",
          "TpoTranVenta": "1",
          "FmaPago": "1"
        },
        "Emisor": {
          "RUTEmisor": "76658541-0",
          "RznSoc": "GRUPO PULENTO SPA",
          "GiroEmis": "SERVICIOS INTEGRALES DE INFORMATICA",
          "Telefono": "2 23466527",
          "CorreoEmisor": "[email protected]",
          "Acteco": "611090",
          "CdgSIISucur": "078817192",
          "DirOrigen": "AVENIDA NUEVA PROVIDENCIA 3652",
          "CmnaOrigen": "PROVIDENCIA",
          "CiudadOrigen": "SANTIAGO"
        },
        "Receptor": {
          "RUTRecep": "76698536-7",
          "RznSocRecep": "EMPRESA XYZ",
          "GiroRecep": "ACTIVIDADES DE CONSULTORIA",
          "DirRecep": "AV LAS CONDES 16751",
          "CmnaRecep": "LAS CONDES",
          "CiudadRecep": "SANTIAGO"
        },
        "Totales": {
          "MntNeto": "60000",
          "TasaIVA": "19.00",
          "IVA": "11400",
          "MntTotal": "71400"
        }
      },
      "Detalle": {
        "NroLinDet": "1",
        "NmbItem": "23096",
        "DscItem": "Ionizador termonuclear marca ACME",
        "QtyItem": "1.00",
        "PrcItem": "60000.00",
        "MontoItem": "60000"
      },
      "TED": {
        "version": "1.0",
        "DD": {
          "RE": "76658541-0",
          "TD": "33",
          "F": "666",
          "FE": "2021-04-01",
          "RR": "76698536-7",
          "RSR": "EMPRESA XYZ",
          "MNT": "71400",
          "IT1": "23096",
          "CAF": {
            "version": "1.0",
            "DA": {
              "RE": "76658541-0",
              "RS": "GRUPO PULENTO SPA",
              "TD": "33",
              "RNG": {
                "D": "666",
                "H": "666"
              },
              "FA": "2021-04-01",
              "RSAPK": {
                "M": "...",
                "E": "Aw=="
              },
              "IDK": "300"
            },
            "FRMA": {
              "_": "...",
              "algoritmo": "SHA1withRSA"
            }
          },
          "TSTED": "2021-04-01T09:32:56"
        },
        "FRMT": {
          "_": "...",
          "algoritmo": "SHA1withRSA"
        }
      },
      "TmstFirma": "2021-04-01T09:32:56"
    },
    "Signature": {
      "xmlns": "http://www.w3.org/2000/09/xmldsig#",
      "SignedInfo": {
        "CanonicalizationMethod": {
          "Algorithm": "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
        },
        "SignatureMethod": {
          "Algorithm": "http://www.w3.org/2000/09/xmldsig#rsa-sha1"
        },
        "Reference": {
          "URI": "#MiPE76385871-16758",
          "Transforms": {
            "Transform": {
              "Algorithm": "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
            }
          },
          "DigestMethod": {
            "Algorithm": "http://www.w3.org/2000/09/xmldsig#sha1"
          },
          "DigestValue": "..."
        }
      },
      "SignatureValue": "...",
      "KeyInfo": {
        "KeyValue": {
          "RSAKeyValue": {
            "Modulus": "...",
            "Exponent": "AQAB"
          }
        },
        "X509Data": {
          "X509Certificate":"..."
        }
      }
    }
  }
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
doc_id Condicional int Id del documento a consultar null
posvta_id Condicional int Id de la venta a consultar null
is_doc_venta Obligatorio bool Documento es de compra o de venta null
formato Obligatorio string pdf html json xml Formato del reporte null
cedible Opcional int 0 1 2 Copia cedible o no 0
folio Condicional int Número de Folio del DTE
tipo_doc Condicional int Tipo de DTE a consultar
id_empresa Condicional int Id de la empresa emisora
tipo_papel Opcional int 0 1 Formato Papel para el reporte 0

Existen 3 formas diferentes de consultar este endpoint. Para identificar el DTE, puedes hacer el request:

incluyendo además los parámetros obligatorios

El parámetro cedible admite los valores 0 1 2. Estos configuran el reporte de la siguiente manera:

El parámetro tipo_papel admite los valores 0 1. Dichos valores configuran el reporte de la siguiente manera:

SII

Lista BHE

Entrega lista de boletas de honorarios electrónicas recibidas en el SII

Obtener la lista de BHE recibidas, para la empresa con id = 1 durante marzo del 2020

#TO-DO

#El siguiente ejemplo retorna la lista de BHE recibidas
curl "https://api.gael.cloud/v2/integrations/sii/bhe_resumen?empresa_id=1&periodo=0320" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 2,
  "data": [
    {
      "numero": "44",
      "estado": "Vigente",
      "estado_cod": "N",
      "estado_id": 1,
      "fecha": "2020-03-30T03:00:00.000Z",
      "rut_emisor": "11111111-1",
      "nombre_emisor": "RICHIE SAMBORA",
      "es_soc_profesional": false,
      "cod_barras": "1111111100044F6C75GA",
      "honorarios_brutos": 111111,
      "honorarios_retenidos": 11944,
      "honorarios_liquidos": 99167
    },
    {
      "numero": "6",
      "estado": "Vigente",
      "estado_cod": "N",
      "estado_id": 1,
      "fecha": "2020-03-31T03:00:00.000Z",
      "rut_emisor": "55555555-5",
      "nombre_emisor": "NUNO BETTENCOURT",
      "es_soc_profesional": false,
      "cod_barras": "5555555500006M821E3B",
      "honorarios_brutos": 616246,
      "honorarios_retenidos": 66246,
      "honorarios_liquidos": 550000
    }
  ],
  "totales": {
    "honorarios": 727357,
    "retencion_emisor": 0,
    "retencion_receptor": 78190,
    "liquido": 649167
  }
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Opcional int Id de la empresa null
periodo Obligatorio string MMYY Período a consultar null

Reporte BHE

Entrega el reporte en PDF (base64) de la boleta de honorarios electrónica recibida en el SII

Obtener el reporte de la BHE con el código de barras 1111111100044F6C75GA

#TO-DO

#El siguiente ejemplo retorna la BHE en formato PDF (base64)
curl "https://api.gael.cloud/v2/integrations/sii/bhe_reporte?empresa_id=1&codigo=1111111100044F6C75GA" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data": [
    {
      "pdf": "JVBERi0xLjMKxOGE4MGJkMzc2YmE..."
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Opcional int Id de la empresa null
codigo Obligatorio string Código de barras null

Remuneraciones

Reporte Liquidación de sueldo

Obtener la liquidación de sueldo de un trabajador en formato PDF o HTML

Obtener el reporte de liquidación de sueldo de la remuneración con id = 13018:

#TO-DO

#El siguiente ejemplo retorna el reporte de liquidación de sueldo en formato PDF
curl "https://api.gael.cloud/v2/remuneraciones/reporte?remun_id=13018&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output reporte_remuneracion.pdf

#El siguiente ejemplo retorna el reporte de liquidación de sueldo en HTML
curl "https://api.gael.cloud/v2/remuneraciones/reporte?remun_id=13018&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
remun_id Obligatorio int Id de la liquidación de sueldo null
formato Obligatorio string pdf html Formato del reporte

Reporte Liquidación de sueldo masivo

Obtener todas las liquidaciones de sueldo para una empresa y período determinado.

Obtener las liquidaciones de sueldo de Enero 2021 para la empresa con el id = 1:

#TO-DO

curl "https://api.gael.cloud/v2/remuneraciones/reporte_masivo?periodo=2101&empresa_id=1" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output Remuneraciones_Enero21.zip

//TO-DO

El ejemplo anterior retorna un archivo .zip con el siguiente contenido:


|-Proyecto A1
 | |- Johnny Gioeli.pdf
 | |- Jarzombek Bobby.pdf
 | |- Pesch Doro.pdf
 | |- Lynch George.pdf
 | |- Van Halen Alex.pdf
 |-Proyecto A2
 | |- Gossow Angela.pdf
 | |- Becker Jason.pdf
 |-Proyecto A3
 | |- Allen Russell.pdf
 | |- Rullo Jason.pdf

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
periodo Obligatorio string YYMM Período a consultar null
empresa_id Obligatorio int Id de la empresa a consultar null

Detalle Liquidación de sueldo

Entrega detalle completo de la liquidación de sueldo solicitada

Este endpoint posee tres posibles combinaciones de parámetros, todas devolviendo la información de una sola liquidación:

Obtener detalle de la liquidación para el usuario RUT = 13866125-5, ID empresa = 1 y período contable = febrero de 2021

#TO-DO

curl "https://api.gael.cloud/v2/remuneraciones/detalle?periodo=0221&empresa_id=1&rut_empl=13866125-5" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "count": 1,
  "data":[
    {
      "OCID": 12305,
      "correlativo": "S-0069-21",
      "per_cont": "Feb-21",
      "empresa_nombre": "Stark Industries",
      "empresa_rut": "76845691-0",
      "trabajador_nombre": "James Rhodes",
      "trabajador_cargo": "War Machine",
      "trabajador_rut": "13866125-5",
      "trabajador_trab_desde": "2001-07-13T00:00:00.000Z",
      "trabajador_contrato": "Indefinido",
      "trabajador_email": "[email protected]",
      "dias_base": 30,
      "ausencias": 0,
      "dias_trabajados": 30,
      "afp": "AFP Avengers",
      "afp_tasa_porc": 11.45,
      "salud": "Stark",
      "utm": 52005,
      "uf": 29709.83,
      "cargas": 2,
      "apv": null,
      "cotiz": 0,
      "mutual": "ISL (Sin Mutual)",
      "ccaf": null,
      "sueldo_base": 1500000,
      "sueldo_proporcional": 1500000,
      "atrasos": 0,
      "horas_extra": 0,
      "horas_extra_monto": 0,
      "gratifcacion_legal": 129240,
      "total_bonificaciones": 0,
      "sueldo_imponible": 1629240,
      "movilizacion": 50000,
      "colacion": 50000,
      "viatico": 0,
      "asignacion_familiar": 0,
      "total_no_imponible": 100000,
      "total_haberes": 1729240,
      "sueldo_tributable": 1263214,
      "prevision": 186548,
      "apv_monto": 0,
      "salud_monto": 114047,
      "adicional_salud": 60944,
      "impuesto_unico": 22446,
      "seguro_cesantia": 9775,
      "total_descs_prev": 393760,
      "sueldo_liquido": 1335480,
      "total_remuneracion": 1335480,
      "anticipos": 0,
      "prestamos": 0,
      "otros_descs": 0,
      "remuneracion_liquida": 1335480,
      "desc_fondo_rendir": 0,
      "total_descs_final": 0,
      "liquido_pago": 1335480,
      "costo_empresa": 1815101,
      "fecha_emision": "2021-02-28T16:22:54.000Z",
      "nombre_emisor": "Pepper Pots",
      "unegocio_nombre": "Gastos de administración y venta",
      "categoria_nombre": "Remuneraciones",
      "ucontrol_nombre": "Remuneraciones",
      "bonifs_descs":{
        "count": 0,
        "data":[
        ]
      },
      "pagos":{
        "count": 1,
        "data":[
          {
            "estado": "Cobrado",
            "monto": 1335480,
            "fecha_pago": "2021-02-28T15:43:49.000Z",
            "detalle": "Transf. Masiva cta. Banco  N°972981206"
          }
        ]
      }
    }
  ]
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
remun_id Obligatorio* int Id de la remuneración a consultar
periodo Obligatorio* int Período contable en el formato MMYY
empresa_id Obligatorio* int Id de la empresa a consultar
rut_empl Obligatorio* string RUT del empleado a consultar, sin puntos con guión

Contabilidad

Reporte Auxiliar

Muestra un informe de los comprobantes en formato PDF o HTML

Obtener comprobantes entre las fechas 21-06-2021 al 21-07-2021

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/auxiliar_reporte?empresa_id=2&cuenta_contable=5&tipo_auxiliar=1&agrupado_documento=false&solo_saldo=false&fecha_desde=21-06-2021&fecha_hasta=21-07-2021&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output reporte_auxiliar.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/auxiliar_reporte?empresa_id=2&cuenta_contable=5&tipo_auxiliar=1&agrupado_documento=false&solo_saldo=true&fecha_desde=21-06-2021&fecha_hasta=21-07-2021&id_tercero=32&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
formato Obligatorio string pdf html Formato del reporte null
cuenta_contable Obligatorio int Cuenta Contable a consultar 0
tipo_auxiliar Obligatorio int Tipo auxiliar en relación a la cuenta contable a consultar 0
solo_saldo Obligatorio bool Indica si se muestra sólo el saldo false
agrupado_documento Obligatorio bool Indica si se muestran los registros agrupado por documento false
id_tercero Opcional int Id del tercero 0
fecha_desde Opcional date DD-MM-YYYY Fecha desde null
fecha_hasta Opcional date DD-MM-YYYY Fecha hasta null

Reporte Libro de Compras / Ventas

Muestra un informe de los registros, ya sea documentos de Compra o Venta, en formato PDF o HTML

Obtener registros de libro de Compras con período May-21.

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/libcompravta?empresa_id=15&periodo=2105&tipo_libro=1&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output libro_compra.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/libcompravta?empresa_id=15&periodo=2105&tipo_libro=0&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
periodo Obligatorio string YYMM Período a consultar null
formato Obligatorio string pdf html Formato del reporte null
tipo_libro Obligatorio int 0 1 Tipo de libro contable a consultar 0

El parámetro tipo_libro admite los valores 0 1. Estos configuran el reporte de la siguiente manera:

Reporte Libro de Remuneraciones

Muestra un informe de renumeraciones de sueldo de los trabajdores de la empresa según período en formato PDF o HTML

Obtener registros de libro de Remuneraciones con período Ene-21.

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/libremun?empresa_id=3&periodo=2101&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output libro_remuneraciones.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/libremun?empresa_id=3&periodo=2101&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
periodo Obligatorio string YYMM Período a consultar null
formato Obligatorio string pdf html Formato del reporte null

Reporte Libro de Honorarios

Obtiene un informe de todos los honorarios según período en formato PDF o HTML

Obtener registros de libro de Honorarios con período Jul-21.

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/libreten?empresa_id=7&periodo=2107&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output libro_honorarios.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/libreten?empresa_id=7&periodo=2107&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
periodo Obligatorio string YYMM Período a consultar null
formato Obligatorio string pdf html Formato del reporte null

Certificados

Muestra los registros, ya sea certificado de sueldo u honorarios, por año de un trabajador en formato PDF o HTML

Obtener certficado de sueldo del trabajador Jason Becker en el año 2021.

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/certificados?empresa_id=2&tercero_id=21&certificado=0&anio=2021&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output certificado.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/certificados?empresa_id=2&tercero_id=21&certificado=1&anio=2021&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
tercero_id Obligatorio int Id del trabajador null
certificado Obligatorio int Certificado a consultar null
anio Obligatorio string YYYY Año a consultar null
formato Obligatorio string pdf html Formato del reporte null

El parámetro certificado admite los valores 0 1. Estos configuran el reporte de la siguiente manera:

Declaraciones Juradas

Obtiene los registros, ya sea para declaración jurada sobre sueldos u honorarios, por año en formato PDF o HTML

Obtener DJ 1887 sobre Sueldos en el año 2021.

#TO-DO

#El siguiente ejemplo retorna el reporte en formato PDF
curl "https://api.gael.cloud/v2/contabilidad/decjuradas?empresa_id=3&formulario=1887&anio=2021&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output declaracion_jurada.pdf

#El siguiente ejemplo retorna el reporte en formato HTML
curl "https://api.gael.cloud/v2/contabilidad/decjuradas?empresa_id=3&formulario=1887&anio=2021&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET  

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Formato Descripción Default
empresa_id Obligatorio int Id de la empresa null
formulario Obligatorio int DecTipo formulario DJ a consultar null
anio Obligatorio string YYYY Año a consultar null
formato Obligatorio string pdf html Formato del reporte null

El parámetro formulario admite los siguientes valores:

Recursos humanos

Comprobante de vacaciones

Obtiene el comprobante de vacaciones de una solicitud específica en formato PDF o HTML

Obtener el comprobante de vacaciones para la solicitud id = 26

#TO-DO

#El siguiente ejemplo retorna el comprobante de vacaciones en formato PDF
curl "https://api.gael.cloud/v2/rrhh/vacaciones/comprobante?id=26&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output comprobante_vacaciones.pdf

#El siguiente ejemplo retorna el comprobante de vacaciones en formato HTML
curl "https://api.gael.cloud/v2/rrhh/vacaciones/comprobante?id=26&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
id Obligatorio int Id de la solicitud de vacaciones null
formato Obligatorio string pdf html Formato del comprobante

Certificado de vacaciones

Obtiene el certificado de vacaciones, ya sea de un trabajador o de toda la planta de la empresa, en formato PDF o HTML

Obtener el certificado de vacaciones para el empleado id = 26 de la empresa id = 2

#TO-DO

#El siguiente ejemplo retorna el certificado de vacaciones en formato PDF
curl "https://api.gael.cloud/v2/rrhh/vacaciones/certificado?empleado_id=26&empresa_id=2&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output certificado_vacaciones.pdf

#El siguiente ejemplo retorna el certificado de vacaciones en formato HTML
curl "https://api.gael.cloud/v2/rrhh/vacaciones/certificado?empleado_id=26&empresa_id=2&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empleado_id Opcional int Id del trabajador null
empresa_id Obligatorio int Id de la empresa null
formato Obligatorio string pdf html Formato del certificado

Certificado de antigüedad laboral

Obtiene el certificado de antigüedad laboral para un empleado específico, en formato PDF o HTML

Obtener el certificado de antigüedad laboral para el empleado id = 43

#TO-DO

#El siguiente ejemplo retorna el comprobante de vacaciones en formato PDF
curl "https://api.gael.cloud/v2/rrhh/certificado_laboral?empleado_id=43&formato=pdf" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET \
  --output certificado_antiguedad_laboral.pdf

#El siguiente ejemplo retorna el comprobante de vacaciones en formato HTML
curl "https://api.gael.cloud/v2/rrhh/certificado_laboral?empleado_id=43&formato=html" \
  -H "ApiKey: xxxxxxxxxxxxxxxx" \
  -X GET

//TO-DO

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empleado_id Obligatorio int Id del empleado null
formato Obligatorio string pdf html Formato del comprobante

Firma electrónica simple

Firma de documento individual

Firma electrónicamente un documento en formato PDF, recibido en formato base64.

Empleado con id = 3 va a firmar el documento con id = 1453, en ambiente de pruebas:

#TO-DO

curl -X POST \
   -H "ApiKey: xxxxxxxxxxxxxxxx" \
   -d \
    '{
      "empleado_id": "3"
      "id_doc_firma": "1453",
      "sandbox": "true",
      "documento": "JVBERi0xLjcKKCjQgMCBvYmoKPDwKL0JpdHNQZXJD........ydHhyZWYKMTc1NzQ0CiUlRU9GCg=="
    }' \
 'https://api.gael.cloud/v2/fes/firma_documento'

//TO-DO

El ejemplo anterior retorna el siguiente JSON:

{
  "cantidad_firmas": 1,
  "mensaje": "Documento firmado exitosamente",
  "codigo_paquete_fes": "FES-5154",
  "firmas_restantes": 485,
  "es_adicional": false,
  "documento_firmado": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0JpdHNQZXJD........ydHhyZWYKMTc1NzQ0CiUlRU9GCg=="
}

HTTPS Request

Parámetros

Parámetro Requerido Tipo Descripción Default
empleado_id Opcional int Id del empleado firmante del documento null
usuario_id Opcional int Id del usuario firmante del documento null
id_doc_firma Obligatorio int Id del documento a firmar null
sandbox Opcional bool Indica si el request se realizará a un ambiente productivo o de pruebas false
documento Obligatorio string Cadena de carateres en base64. Documento a firmar, en PDF. null
shell python javascript