API 1 Perseo Software
El ApiRest, ayuda a la integración del sistema contable Perseo, a cualquier desarrollo que necesite el cliente.
Para tener acceso a este beneficio, se debe instalar y configurar el Api (Este proceso solo se realiza por el personal del sistema contable).
Datos para la Autenticación
Para la autenticación, se debe incluir el api_key dentro del JSON. Para obtener esta clave, siga estos pasos dentro del Sistema Contable Perseo:
En el menú, haga clic en Administración.
Seleccione la opción Administrador de Integraciones (en Perseo PC) o Integraciones (en Perseo Web).
Haga clic en el botón Nuevo.
En la opción de Integraciones, seleccione API Key.
Haga clic en el botón Generar API Key.
El api_key aparecerá en la parte inferior del botón.
EndFragment
Sintaxis general para el llamado de los diferentes procedimientos:
Perseo PC
https://ip_publica_servidor:puerto/api/nombre_procedimiento
Perseo Web
https://url_servidor/api/nombre_procedimiento
Ejemplo: https://perseo-data-c1.app/api/facturas_crear
Facturación
POSTCreacion de Factura
localhost/api/facturas_crear
Procedimiento para insertar una nueva factura en el sistema contable de acuerdo con los datos que se envía en formato JSON.
Sintaxis:
Perseo PC
Conexión Remota
https://ip_publica_servidor:puerto/api/facturas_crear
Conexión local
https://ip_local_servidor/api/facturas_crear
Perseo Web
https://ip_local_servidor/api/facturas_crear https://url_servidor/api/facturas_crear
Ejemplo: https://perseo-data-c1.app/api/facturas_crear
Parámetros requeridos
encabezado de la factura
| Parámetro | Tipo | Descripción |
|---|---|---|
| sucursalesid | bigint(20) | Identificar si el cliente tiene sucursales (por defecto va 1) |
| secuenciasid | int(11) | Id para identificar la secuencia de facture con la que se está trabajando (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/secuencias_consulta |
| () | Para extraer las secuencias activas) | |
| sri_documentoscodigo | varchar(3) | Indica el tipo de documento, por defecto debe especificar (01 = factura) |
| forma_pago_empresaid | int(11) | El tipo de pago que va a tener la factura (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/ formapagoempresa_consulta |
| () | Para extraer el listado de forma de pagos activas) | |
| forma_pago_sri_codigo | varchar(2) | Tipo de pago del SRI (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/formapagosri_consulta Para extraer el listado de forma de pagos SRI activas) |
| cajasid | int(11) | Id de la caja que va afectar esta factura(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/cajas_consulta Para extraer el listado de las cajas activas) |
| centros_costosid | int(11) | Id del centro de costos que desea especificar a la factura. Los centros de costos son utilizados para clasificar las sucursales en contabilidad. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/centrocosto_consulta Para extraer el listado de los centros de costos existentes) |
| almacenesid | int(11) | Id del almacén que va afectar esta factura(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/almacenes_consulta Para extraer el listado de los almacenes activos) |
| facturadoresid | int(11) | Id del facturador correspondiente (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/facturadores_consulta Para extraer el listado de agentes de ventas) |
| vendedoresid | int(11) | Id del vendedor correspondiente (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/facturadores_consulta Para extraer el listado de agentes de ventas) |
| clientesid | bigint(20) | Corresponde al id del cliente. Vea referencia del procedimiento consultar_clientes, para extraer la información necesaria. |
| tarifasid | bigint(20) | Indica el precio general con el que se va a facturar. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/tarifas_consulta Para extraer el listado, caso contrario especificar el 1 correspondiente a la tarifa por defecto en el sistema.) |
| establecimiento | varchar(3) | Corresponde a los primeros 3 números de la secuencia de la factura. Ejemplo: 001-001-000000001 |
| puntoemision | varchar(3) | Corresponde a los primeros 3 números de la secuencia de la factura. Ejemplo: 001-001-000000001 |
| secuencial | varchar(15) | Indica el número de facture generada. Ejemplo: 001-001-000000001. También puede extraer esta información con el procedimiento secuencias_consulta(Vea referencia del procedimiento) |
| emision | date(0) | Fecha en la que emitió la factura. |
| vence | date(0) | Fecha de vencimiento de la factura. |
| subtotal | decimal(20) | Valor total de la factura sin incluir el IVA, ni el descuento. |
| total_descuento | decimal(20) | Total del descuento en valor, se obtiene sumando el descuento aplicado a cada precio sin IVA de cada producto. |
| subtotalconiva | decimal(20) | Valor total de los productos con IVA, sin incluir el IVA y restado el descuento. |
| subtotalsiniva | decimal(20) | Valor total de los productos que no tienen IVA, restado el descuento. |
| subtotalneto | decimal(20) | Valor total sin IVA y restando el descuento correspondiente. |
| total_ice | decimal(20) | Valor total del ICE (si algún producto aplica ICE) |
| total_iva | double(0) | Valor total del IVA. |
| concepto | varchar(75) | Breve reseña de la facture, opcional; si desea aplicar alguna explicación u observación de la factura. |
| total | decimal(20) | Valor total de la factura. |
| totalneto | decimal(20) | Valor total de la factura. |
| totalretenidoiva | decimal(14) | Solo si existe retenciones |
| totalretenidorenta | decimal(14) | Solo si existe retenciones |
| puntoemisionretencion | varchar(3) | Solo si existe retenciones |
| establecimientoretencion | varchar(3) | Solo si existe retenciones |
| emisionretencion | date(0) | Solo si existe retenciones |
| secuenciaretencion | varchar(10) | Solo si existe retenciones |
| observacion | varchar(1500) | Se puede especificar una descripción mas extensa de la factura |
| numeroautorizacion | varchar(49) | Si la factura está autorizada, debe especificar el numero de autorización. |
| autorizacionfecha | datetime | Especificar la fecha de autorización de la factura. |
| de_enviado | tinyint | Especificar 1: si la factura autorizada, ya se envio al correo del cliente; caso contrario con el valor 0. |
Detalle de la factura
| Parámetro | Tipo | Descripción |
|---|---|---|
| centros_costosid | int(11) | Id del centro de costos que desea especificar a la factura. Los centros de costos son utilizados para clasificar las sucursales en contabilidad. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/centrocosto_consulta Para extraer el listado de los centros de costos existentes) |
| facturasid | bigint(20) | Id generada al inserter el encabezado de la factura. |
| almacenesid | int(11) | Id del almacén que va afectar esta factura(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/almacenes_consulta Para extraer el listado de los almacenes activos) |
| productosid | bigint(20) | Corresponde al id de los productos a facturar. Vea referencia del procedimiento consultar_productos, para extraer la información necesaria. |
| medidasid | int(11) | Id de la unidad de medida con la que se va a facturar el producto (Caso contrario, especificar 1 medida por defecto del sistema.) |
| cantidaddigitada | decimal(14) | Cantidad del producto a facturar. |
| cantidadfactor | decimal(20) | Valor que se genera si se está trabajando con multimedidas, caso contrario por defecto enviar 1 |
| cantidad | decimal(20) | Resultado que se obtiene al multiplicar cantidaddigitada*cantidadfactor. Es la cantidad real que se va a facturar en base a la medida con la que se está trabajando. |
| precio | decimal(20) | Precio sin IVA del producto. |
| preciovisible | decimal(20) | Precio que se va a visulizar en el sistema, depende de los parámetros que esté configurado. Por defecto asignar el precioIVA |
| precioiva | decimal(20) | Precio incluido IVA del producto. |
| descuento | decimal(11) | Porcentaje de descuento que se va a aplicar a cada producto. |
| costo | decimal(20) | Costo promedio del producto, se puede extraer con el procedimiento consulta_producto |
| iva | decimal(4) | Porcentaje de IVA que tiene el producto; 12% o 0% |
| descuentovalor | decimal(20) | Descuento en valor que se aplicó a cada producto. |
| servicio | tinyint(4) | Identifica si el producto es un artículo o un servicio, se puede extraer con el procedimiento consulta_producto. Ejemplo: 1: es servicio, 0 es artículo. |
| informacion | varchar(1500) | Información adicional del artículo, para que se visualice en el reporte. |
| informaciondetalle | varchar(300) | Nombre que se le asigna a un servicio para que muestre en el reporte. |
Datos adicionales en facturas de contado
Esta información solo se debe especificar si la factura no es a crédito.
| Parámetro | Tipo | Descripción |
|---|---|---|
| forma_pago_empresaid | int(11) | El tipo de pago que va a tener la factura (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/ formapagoempresa_consulta |
| forma_pago_sri | varchar(2) | Especifica el codigo de la forma de pago SRI. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/formapagosri_consulta |
| cajasid | int | Id de la caja que va afectar esta factura, este campo solo se utiliza si la forma de pago es: efectivo, tarjeta o cheque (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/cajas_consulta Para extraer el listado de las cajas activas) |
| bancoid | int | id del banco, este campo solo se lo utiliza si la forma de pago es deposito. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/bancos_consulta Para extraer el listado de las cajas activas) |
| documentoorigen | varchar(15) | Número de secuencia de la factura |
| importe | date | Valor total del cobro en relación a la factura |
| bancotarjetaid | bigint(20) | Corresponde al id del banco al que pertenece el cheque si la forma de pago corresponde a cheque, ó id de la tarjeta de crédito si el cobro se realizó con tarjeta de crédito |
| fechamovimiento | date | Fecha en la que se realizo el cobro |
| fechavence | date | Fecha de vencimiento(Este campo es importante si se realiza el cobro con cheque posfechado) |
| comprobante | varchar(15) | Numero de secuencia interna que genera el sistema contable |
| numerochequevoucher | varchar(20) | Este campo es utilizado en las formas de cobro en cheque, tarjeta o depósito para almacenar el numero de comprobante correspondiente |
Bodyraw (json)
json
{
"api_key":"RQdiflkM__8nT1_gA9tEmkKcQ5EPUg9ImZLIgGV.aUc-",
"controlexistencia":true,
"registro":
[
{
"facturas":
{
"secuenciasid":1,
"sri_documentoscodigo":"01",
"forma_pago_empresaid":1,
"forma_pago_sri_codigo":"01",
"cajasid":2,
"centros_costosid":1,
"almacenesid":1,
"facturadoresid":6,
"vendedoresid":4,
"clientesid":5,
"clientes_sucursalesid":1,
"tarifasid":1,
"establecimiento":"001",
"puntoemision":"901",
"secuencial":"000000609",
"emision":"20250109",
"vence":"20250109",
"subtotal":8.4348,
"total_descuento":0,
"subtotalconiva":0.4348,
"subtotalconiva2":0,
"subtotalsiniva":8,
"subtotalneto":8.4348,
"total_ice":0,
"total_iva":0.07,
"total_iva2":0,
"total":8.5,
"totalneto":8.5,
"concepto":"Venta m\u00f3vil: 001-901-000000609 Con el Total de: 8.25",
"observacion":"",
"empresaid":2,
"usuarioid":4,
"dispositivo":"SM-A307G f2ca6478a0e4f3b8",
"uui":"71ec6879-3a0e-4b63-8c33-7b951a003477",
"fechacreacion":"2025-01-09T16:45:34.699",
"usuariocreacion":"IMOVIL",
"detalles":
[
{
"productosid":1201,
"centros_costosid":1,
"almacenesid":1,
"medidasid":1,
"cantidaddigitada":10,
"cantidadfactor":1,
"cantidad":10,
"CtrlNegativos":true,
"precio":0.043478,
"preciovisible":0.05,
"precioiva":0.05,
"descuento":0,
"descuentovalor":0,
"costo":0.03,
"iva":15,
"servicio":false,
"informacion":"",
"informaciondetalle":""
},
{
"productosid":1023,
"centros_costosid":1,
"almacenesid":1,
"medidasid":1,
"cantidaddigitada":1,
"cantidadfactor":1,
"cantidad":1,
"CtrlNegativos":true,
"precio":8,
"preciovisible":8,
"precioiva":8,
"descuento":0,
"descuentovalor":0,
"costo":0.7838191,
"iva":0,
"servicio":false,
"informacion":"",
"informaciondetalle":""
}
],
"movimiento":
[
{
"forma_pago_empresaid":1,
"forma_pago_sri":"01",
"cajasid":2,
"documentoorigen":"000000609",
"importe":8.5,
"bancotarjetaid":0,
"fechamovimiento":"20250109",
"numerochequevoucher":"{93a37e8f-6d82-",
"fechavence":"20250109"
}
]
}
}
]
}POSTCreacion de Nota de crédito
localhost/api/facturas_crear
Procedimiento para insertar una nota de crédito o devolución en el sistema contable de acuerdo con los datos que se envía en formato JSON.
Nota: El campo sri_documentoscodigo debe tener siempre el valor 04 que corresponde al tipo Nota de crédito.
Para insertar la nota de crédito debe tener el id de la factura generado en el sistema perseo.
Sintaxis:
Perseo PC
Conexión Remota
Perseo Web
https://url_servidor/api/facturas_crear
Ejemplo: https://perseo-data-c1.app/api/facturas_crear
Parámetros requeridos
encabezado de la Nota de crédito
| Parámetro | Tipo | Descripción |
|---|---|---|
| sucursalesid | bigint(20) | Identificar si el cliente tiene sucursales (por defecto va 1) |
| secuenciasid | int(11) | Id para identificar la secuencia de facture con la que se está trabajando (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/secuencias_consulta |
| () | Para extraer las secuencias activas) | |
| sri_documentoscodigo | varchar(3) | Indica el tipo de documento, por defecto debe especificar (04 = nota de crédito) |
| forma_pago_empresaid | int(11) | El tipo de pago que va a tener la NC (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/ formapagoempresa_consulta |
| () | Para extraer el listado de forma de pagos activas) | |
| forma_pago_sri_codigo | varchar(2) | Tipo de pago del SRI (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/formapagosri_consulta Para extraer el listado de forma de pagos SRI activas) |
| cajasid | int(11) | Id de la caja que va afectar la NC(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/cajas_consulta Para extraer el listado de las cajas activas) |
| centros_costosid | int(11) | Id del centro de costos que desea especificar a la NC. Los centros de costos son utilizados para clasificar las sucursales en contabilidad. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/centrocosto_consulta Para extraer el listado de los centros de costos existentes) |
| almacenesid | int(11) | Id del almacén que va afectar la NC (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/almacenes_consulta Para extraer el listado de los almacenes activos) |
| facturadoresid | int(11) | Id del facturador correspondiente (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/facturadores_consulta Para extraer el listado de agentes de ventas) |
| vendedoresid | int(11) | Id del vendedor correspondiente (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/facturadores_consulta Para extraer el listado de agentes de ventas) |
| clientesid | bigint(20) | Corresponde al id del cliente. Vea referencia del procedimiento consultar_clientes, para extraer la información necesaria. |
| tarifasid | bigint(20) | Indica el precio general con el que se va a devolver. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/tarifas_consulta Para extraer el listado, caso contrario especificar el 1 correspondiente a la tarifa por defecto en el sistema.) |
| establecimiento | varchar(3) | Corresponde a los primeros 3 números de la secuencia de la NC. Ejemplo: 001-001-000000001 |
| puntoemision | varchar(3) | Corresponde a los primeros 3 números de la secuencia de la NC siguientes. Ejemplo: 001-001-000000001 |
| secuencial | varchar(15) | Indica el número de NC generada. Ejemplo: 001-001-000000001. También puede extraer esta información con el procedimiento secuencias_consulta(Vea referencia del procedimiento) |
| emision | date(0) | Fecha en la que emitió la NC. |
| vence | date(0) | Fecha de vencimiento de la NC. Por defecto corresponde la misma fecha de emisión |
| subtotal | decimal(20) | Valor total de la NC sin incluir el IVA, ni el descuento. |
| total_descuento | decimal(20) | Valor total del descuento correspondiente, se obtiene sumando el descuento aplicado a cada precio sin IVA de cada producto. |
| subtotalconiva | decimal(20) | Valor sin incluir el IVA total de los productos que apliquen IVA. |
| subtotalsiniva | decimal(20) | Valor sin incluir el IVA total de los productos que no apliquen IVA. |
| subtotalneto | decimal(20) | Valor total sin incluir IVA pero restando el descuento correspondiente. |
| total_ice | decimal(20) | Valor total del ICE (si algún producto aplica ICE) |
| total_iva | double(0) | Valor total del IVA. |
| concepto | varchar(75) | Breve reseña de la NC, opcional; si desea aplicar alguna explicación u observación de la factura. |
| total | decimal(20) | Valor total de la NC. |
| totalneto | decimal(20) | Valor total sin IVA, incluyendo el descuento. |
| relaciondocumentoid | bigint(20) | Datos de referencia extraídos de la factura que se esta afectando (id generado en el sistema perseo de la factura) |
| relacionemision | date | Datos de referencia extraídos de la factura que se esta afectando(fecha de emisión de la factura) |
| relacionestablecimiento | varchar(3) | Datos de referencia extraídos de la factura que se esta afectando(numero de establecimiento de la factura) |
| relacionpuentoemision | varchar(3) | Datos de referencia extraídos de la factura que se esta afectando(punto de emisión de la factura) |
| relacionsecuencia | varchar(10) | Datos de referencia extraídos de la factura que se esta afectando(secuencia de la factura) |
Detalle de la Notas de crédito
| Parámetro | Tipo | Descripción |
|---|---|---|
| centros_costosid | int(11) | Id del centro de costos que desea especificar a la NC. Los centros de costos son utilizados para clasificar las sucursales en contabilidad. (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/centrocosto_consulta Para extraer el listado de los centros de costos existentes) |
| facturasid | bigint(20) | Id generada al inserter el encabezado de la NC. |
| almacenesid | int(11) | Id del almacén que va afectar esta NC (Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/almacenes_consulta Para extraer el listado de los almacenes activos) |
| productosid | bigint(20) | Corresponde al id de los productos a devolver. Vea referencia del procedimiento consultar_productos, para extraer la información necesaria. |
| medidasid | int(11) | Id de la unidad de medida con la que se va a devolver el producto (Caso contrario, especificar 1 medida por defecto del sistema.) |
| cantidaddigitada | decimal(14) | Cantidad del producto. |
| cantidadfactor | decimal(20) | Valor que se genera si se está trabajando con multimedidas, caso contrario por defecto 1 |
| cantidad | decimal(20) | Resultado que se obtiene al multiplicar cantidaddigitada*cantidadfactor. Es la cantidad real que se va a devolver en base a la medida con la que se está trabajando. |
| precio | decimal(20) | Precio sin IVA del producto. |
| preciovisible | decimal(20) | Precio que se va a visulizar en el sistema, depende de los parámetros que esté configurado. Por defecto asignar el precioIVA |
| precioiva | decimal(20) | Precio incluido IVA del producto. |
| descuento | decimal(11) | Porcentaje de descuento que se va a aplicar a cada producto. |
| costo | decimal(20) | Costo promedio del producto, se puede extraer con el procedimiento consulta_producto |
| iva | decimal(4) | Porcentaje de IVA que tiene el producto; sea 12% o 0% |
| descuentovalor | decimal(20) | Descuento en valor que se aplicó a cada producto. |
| servicio | tinyint(4) | Identifica si el producto es un artículo o un servicio, se puede extraer con el procedimiento consulta_producto. Ejemplo: 1: es servicio, 0 es artículo. |
Datos adicionales en el pago de la Nota de crédito
| Parámetro | Tipo | Descripción |
|---|---|---|
| forma_pago_empresaid | int(11) | El tipo de pago que va a tener la nota de crédito(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/ formapagoempresa_consulta |
| cajasid | int | Id de la caja que va afectar la nota de crédito(Ref. existe el procedimiento https://ip_publica_servidor:puerto/api/cajas_consulta Para extraer el listado de las cajas activas) |
| documentoorigen | varchar(15) | Número de secuencia de la factura afectada por la nota de crédito |
| importe | date | Valor total del cobro en relación a la factura |
| bancotarjetaid | bigint(20) | Tiene un valor por defecto de 0, ya que las notas de crédito solo tienen dos formas de pago(efectivo y crédito) |
| fechamovimiento | date | Fecha en la que se realizo la devolución |
| fechavence | date | Por defecto la misma fecha del movimiento |
| comprobante | varchar(15) | Numero de secuencia interna que genera el sistema contable |
| numerochequevoucher | varchar(20) | Tiene un valor por defecto de vacío, ya que las notas de crédito solo tienen dos formas de pago(efectivo y crédito) |
Bodyraw (json)
json
{
"api_key":"RQdiflkM__8nT1_gA9tEmkKcQ5EPUg9ImZLIgGV.aUc-",
"registro":
[
{
"facturas":
{
"facturasid":2,
"secuenciasid":13,
"sri_documentoscodigo":"04",
"forma_pago_empresaid":1,
"forma_pago_sri_codigo":"01",
"cajasid":3,
"bancosid":0,
"centros_costosid":1,
"almacenesid":2,
"facturadoresid":4,
"vendedoresid":5,
"clientesid":643,
"clientes_sucursalesid":0,
"tarifasid":1,
"establecimiento":"001",
"puntoemision":"003",
"secuencial":"000000001",
"emision":"20211020",
"vence":"20211020",
"subtotal":0.72,
"total_descuento":0,
"subtotalconiva":0,
"subtotalsiniva":0.72,
"subtotalneto":0.72,
"total_ice":0,
"total_iva":0,
"propina":0,
"total":0.72,
"totalneto":0.72,
"totalretenidoiva":0,
"totalretenidorenta":0,
"puntoemisionretencion":"",
"establecimientoretencion":"",
"emisionretencion":"",
"secuenciaretencion":"",
"claveacceso":"2010202104171186007000120010030000000011234567810",
"concepto":"Devoluci\u00f3n m\u00f3vil: 001-003-000000001 Con el Total de: 0.72",
"empresaid":2,
"usuarioid":2,
"uui":"7c9d37b8-f030-4694-b76e-428368235246",
"fechacreacion":"20211020103742",
"usuariocreacion":"IMOVIL",
"relaciondocumentoid":16600,
"relacionemision":"20211020",
"relacionestablecimiento":"001",
"relacionpuentoemision":"003",
"relacionsecuencia":"000002939",
"detalles":
[
{
"centros_costosid":1,
"almacenesid":2,
"productosid":63,
"medidasid":1,
"cantidaddigitada":1,
"cantidadfactor":1,
"cantidad":1,
"precio":0.72,
"preciovisible":0.72,
"precioiva":0.72,
"descuento":0,
"costo":0.6,
"iva":0,
"descuentovalor":0,
"servicio":false
}
],
"movimiento":
[
{
"forma_pago_empresaid":1,
"cajasid":3,
"documentoorigen":"000002939",
"importe":-0.72,
"bancotarjetaid":0,
"fechamovimiento":"20211020",
"fechavence":"20211020",
"comprobante":"CE00000554",
"numerochequevoucher":""
}
]
}
}
]
}Loading