HELISA/API

Estructura de envío

Consulta de cuentas

El modo de envío será por medio de un formulario.

Url: /KansasWS/get/accountList

Parámetros de entrada:

  • int type: Tipo de contabilidad (0: Local, 1: Niif).
  • int year: Año de trabajo a consultar.
  • String id: Código de la empresa a consultar.
  • long date: Fecha y hora de petición (Milisegundos).
  • String sign: Firma de seguridad, lo firmado será la concatenación en string de type, year y date separados por pipe (|).

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Envío de cuentas)
  • 400 Solicitud Incorrecta:

    • Type inválido: {“error”: {“code”:1, message: “Invalid accounting type”}}
    • Year inválido: {“error”: {“code”:2, message: “Invalid year”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}

Ejemplo de salida json:


{
    "accounts": [{
        "thirdParty": true,
        "nature": {
            "tag": "D"
        },
        "level": 4,
        "costCenter": false,
        "name": "Caja general",
        "account": "110505",
        "affectable": true,
        "taxUsed": true,
        "IFRSaccount": "110505"
    }, {
        "thirdParty": true,
        "nature": {
            "tag": "D"
        },
        "level": 3,
        "costCenter": false,
        "name": "Caja general",
        "account": "1105",
        "affectable": false,
        "taxUsed": true,
        "IFRSaccount": "1105"
    }]
}
                            
  • Naturaleza (nature):

    • D: Débito
    • C: Crédito

Consulta de existencias de un producto

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/productStock

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y tipo de contabilidad (ver Estructura de envío, Consulta balance general y estado de resultados)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "date": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "productCode": 123,
    "measure": 254454
}
                            

Campos obligatorios: date, productCode, measure

Ejemplo de salida json:


{
    "productStock": [{
        "stock": 29
    }, {
        "warehouse": 2,
        "stock": 4,
        "warehouseName": "BODEGA 2 DISPENSARIO"
    }, {
        "warehouse": 3,
        "stock": 9,
        "warehouseName": "BODEGA 3 PET CENTER"
    }, {
        "warehouse": 4,
        "stock": 16,
        "warehouseName": "BODEGA 4 PET COLINA"
    }]
}
                            

Consulta estado de cartera de cliente

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/portfolioByClient

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y tipo de contabilidad (ver Estructura de envío, Consulta balance general y estado de resultados)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message:“Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "date": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "nit": "130505"
}
                            

Campos obligatorios: date, nit

Ejemplo de salida json:


{
    "clientPortfolio": [{
        "documentDate": {
            "month": 12,
            "year": 2012,
            "day": 31
        },
        "idClient": 1,
        "document": {
            "number": "O00001",
            "type": "SIC"
        },
        "concept": "Cuota 1. Vence 30/01/2013",
        "fee": 1,
        "value": 0,
        "account": "13050505",
        "expirationDate": {
            "month": 1,
            "year": 2013,
            "day": 30
        }
    }]
}
                            

Consulta movimiento de inventario

El modo de envío será por medio de un formulario.

Método de envío: POST.

Url: /KansasWS/summary/inventoryMovement

Parámetros de entrada:

  • String json: JSon con información del rango de fechas, tipo de modulo y tipo de documentos a consultar (ver Estructura de envío)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

200 Ok: (ver Estructura de envío, Consulta resumen de documentos)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "startDate": {
        "day": 12,
        "month":  10,
        "year": 2018
    },
    "endDate": {
        "day": 12,
        "month":  10,
        "year": 2018
    },
    "documentType ": "EPIM",
    "moduleType": 1
}
                            

Campos obligatorios: startDate, endDate, documentType, moduleType

Tipo de modulo (moduleType):

  1. Consulta Movimiento inventario para documentos de los módulos:

    • Importaciones: Entrada por importación.
    • Inventario: Devolución Entradas.
  2. Consulta Movimiento inventario para documentos de los módulos:

    • Gestión Compras: Entrada de Mercancía, Devolución Entradas de Mercancía, Factura de Compra, Devolución Facturas de Compra.
    • Inventario: Entradas de Mercancía, Saldos Iniciales.
  3. Consulta Movimiento inventario para documentos de los módulos:

    • Gestión Ventas: Remisión, Devolución de Remisión, Factura de Venta, Devolución de Factura.
    • Inventario: Salidas de Mercancía, Devolución Salidas.
  4. Consulta Movimiento inventario para documentos de los módulos:

    • Inventario: Ajuste por Inventario Físico

Ejemplo de salida json:


{
    "movement": [
        {
            "date": {
                "month": 1,
                "year": 2018,
                "day": 12
            },
            "sourceDocument": "",
            "quantity": 2038.1,
            "originDocument": "DIMP0000001",
            "kind": "Local y Niif",
            "document": {
                "number": "00000001",
                "type": "ETIM"
            },
            "referenceProduct": "REF:6821",
            "idBusine": 3,
            "idThird": "4024536472",
            "nameWarehouse": "NOMBRE_BODEGA",
            "unitPriceLocal": 26118.76,
            "idWareHouse": 6,
            "idCostCenter": "06",
            "idProduct": 50,
            "subIdProduct": 7,
            "unitPriceNiif": 26118.76,
            "nameProduct": "NOMBRE_PRODUCTO"
        }  
    ]
}
                            

Inserción de documentos

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/document

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío asientos contables)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Documento duplicado: {“error”: {“code”:5, message: “Already exists”}}
  • Documento descuadrado: {“error”: {“code”:8, message: “Total debits is not equal to total credits”}}
  • Códigos de emparejamiento errados: {“error”: {“code”:9, message: “Invalid match codes”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "document": {
        "date": {
            "day": 26,
            "month": 4,
            "year": 2015
        },
        "document": {
            "type": "FV",
            "number": " 00000078"
        },
        "transactions": [{
            "originDocument": "FC 000000012",
            "matchCode": 12,
            "nature": {
                "tag": "D"
            },
            "costCenter": "0101",
            "concept": "Factura de venta",
            "accountingClass": {
                "value": 0
            },
            "value": 1160000,
            "idThirdParty": "10141234",
            "account": "130505",
            "userCode": 1,
            "taxBase": 0,
            "businessCode": 1,
            "bankAccount": "042234677-0",
            "bankCheck": 0,
            "bankOperation": "abc",
            "bankCheckDate": {
                "day": 26,
                "month": 4,
                "year": 2015
            },
            "accountingTransactionClient": {
                "clientCode": 123,
                "expirationDate": {
                    "day": 26,
                    "month": 4,
                    "year": 2015
                },
                "idVendor": "00000",
                "paymentForm": 0,
                "affectDocument": "FV 12323123",
                "affectDate": {
                    "day": 14,
                    "month": 5,
                    "year": 2015
                },
                "affectFee": 1
            }
        }, {
            "nature": {
                "tag": "C"
            },
            "costCenter": "0101",
            "concept": "IVA",
            "accountingClass": {
                "value": 0
            },
            "value": 160000,
            "idThirdParty": "10141234",
            "account": "240801",
            "userCode": 1,
            "taxBase": 1000000
        }, {
            "nature": {
                "tag": "C"
            },
            "costCenter": "0101",
            "concept": "Valor bruto",
            "accountingClass": {
                "value": 0
            },
            "value": 1000000,
            "idThirdParty": "10141234",
            "account": "413505",
            "userCode": 1,
            "taxBase": 0,
            "businessCode": 1,
            "bankAccount": "042234677-0",
            "bankCheck": 0,
            "bankOperation": "abc",
            "bankCheckDate": {
                "day": 26,
                "month": 4,
                "year": 2015
            },
            "accountingTransactionSupplier": {
                "supplierCode": 1234,
                "expirationDate": {
                    "day": 26,
                    "month": 4,
                    "year": 2015
                },
                "paymentForm": 0,
                "affectDocument": "FV 12323123",
                "affectDate": {
                    "day": 14,
                    "month": 5,
                    "year": 2015
                },
                "affectFee": 1
            }
        }]
    }
}
                            

Campos obligatorios: date, document, transactions no puede ser vacío, dentro de transacciones nature, accountingClass, value, idThirdParty, account, userCode;

  • En caso de que sea una transacción de cartera de cuentas por cobrar debe existir accountingTransactionClient (no es obligatorio, si no existe no se afectara la cartera) donde:

    • El campo clientCode es obligatorio.
    • Si la transacción es débito se tendrán en cuenta los campos idVendor, paymentForm y expirationDate.

      • paymentForm y expirationDate no son obligatorios juntos, pero debe existir alguno de los dos.
      • paymentForm debe ser uno de los códigos existentes en la base de datos de Helisa.
    • Si la transacción es crédito se tendrán en cuenta los campos affectDocument, affectDate, affectFee. Ningún campo es obligatorio.
  • En caso de que sea una transacción de cartera de cuentas por pagar debe existir accountingTransactionSupplier (no es obligatorio, si no existe ,no se afectara la cartera) donde:
    • El campo supplierCode es obligatorio.
    • Si la transacción es crédito se tendrán en cuenta los campos paymentForm y expirationDate.

      • paymentForm y expirationDate no son obligatorios juntos, pero debe existir alguno de los dos.
      • paymentForm debe ser uno de los códigos existentes en la base de datos de Helisa.
    • Si la transacción es débito se tendrán en cuenta los campos affectDocument, affectDate, affectFee. Ningún campo es obligatorio.
  • Clase de transacción contable (accountingClass):

    • 0: Local
    • 1: NIIF

Inserción de entrada de mercancía/Gestión de Compras

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/commodity-entry

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío entrada de Mercancía)
  • String year: Año de inserción.
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

200 Ok: (ver Estructura de envío, Consulta lectura de productos)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:

                           
{
  "commodity": {
    "accountingDocument": {
      "type": "RE",
      "number": "898989"
    },
    "date": {
      "day": 1,
      "month": 1,
      "year": 2021
    },
    "supplierIdentity": "901340674",
    "idVendor": "901270129",
    "transactions": [
      {
        "costCenter": "10005",
        "observation": "PROASISTEMASS.A.(HELISA)",
        "kind": 1,
        "account": "11050505",
        "accountingClass": {
          "value": 2
        },
        "idProduct": 141401007,
        "idWarehouse": 1,
        "measure": 2,
        "rawValue": 10000,
        "ivaValue": 1900,
        "quantity": 5,
        "unitValue": 2000,
        "totalValue": 10000,
        "priceList": 1
      }
    ]
  }
}
							

Campos obligatorios: accountingDocument, date, transactions, supplierIdentity, idVendor, Campos obligatorios en transacciones: costCenter, accountingClass, account, kind, idPorudct, measure, idWarehouse, quantiy, unitValue, totalValue, priceList.

  • Tipo de contabilidad (accountingClass):

    • 0: Contabilidad local
    • 1: Contabilidad NIIF
    • 2: Contabilidad local y NIIF

Inserción de entrada de mercancía/Inventario

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/inventory-entry

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío entrada de Mercancía)
  • String year: Año de inserción.
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

200 Ok: (ver Estructura de envío, Consulta lectura de productos)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
  "inventory": {
    "document": {
      "type": "EMI",
      "number": "111"
    },
    "date": {
      "day": 15,
      "month": 11,
      "year": 2020
    },
    "idThirdParty": "1079933643",
    "transactions": [
      {
        "idProduct": 001,
        "subCode": 6,
        "wineryCode": 1,
        "concept": "ss",
        "quantity": 3,
        "unitCost": 23,
        "unitPrice": 2,
        "costCenter": "ss",
        "userCode": 1,
        "niifUnitPrice": 10500,
        "unitCostNiff": 0,
        "totalTaxCost": 0,
        "totalAccountingCost": 0
      }
    ]
  }
}
                            

Campos obligatorios: document, type, number, date, idThirdParty, "transactions, idProduct, subCode, wineryCode, concept, quantity, unitCost, unitPrice, costCenter, userCode, niifUnitPrice, unitCostNiff, totalTaxCost, totalAccountingCost.

Inserción de pedidos

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/order

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío asientos contables)
  • int year: Año de inserción
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Producto duplicado: {“error”: {“code”:5, message: “Already exists”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
  "order": {
    "accountingDocument": {
      "type": "REM",
      "number": "12345678"
    },
    "date": {
      "day": 15,
      "month": 1,
      "year": 2018
    },
    "clientIdentity": "20541114",
    "idVendor": "1325410022",
    "transactions": [
      {
        "kindQuestion": 0,
        "question": "Pregunta Global",
        "answer": "Respuesta Global",
        "kind": 2,
        "quantity": 1,
        "idProduct": 2,
        "measure": 6,
        "unitValue": 3500,
        "totalValue": 10500,
        "priceList": 1,
        "rawValue": 0,
        "idWarehouse": 1
      },
      {
        "kindQuestion": 1,
        "question": " Pregunta por Transacción",
        "answer": "Respuesta por Transacción ",
        "kind": 2,
        "quantity": 3,
        "idProduct": 1,
        "measure": 6,
        "unitValue": 3500,
        "totalValue": 10500,
        "priceList": 1,
        "rawValue": 0,
        "idWarehouse": 16
      }
    ]
  }
}
                            

Campos obligatorios: accountingDocument, date, transactions, clientIdentity, idVendor.Campos obligatorios en transacciones: kind, idPorudct, measure, idWarehouse, quantiy, unitValue, totalValue, priceList


Tipo de preguntas (KindQuestion):

  1. Registra Preguntas Globales.
  2. Registra Preguntas por transacción en cada detalle del envio.

    • Question: Detalle del contenido de la variable creada como tipo pregunta.
    • Answer: Respuesta a pregunta realizada

Inserción de productos

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/productFE

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío asientos contables)
  • int year: Año de inserción
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Producto duplicado: {“error”: {“code”:5, message: “Already exists”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "product": {
        "accountingClass": {
            "value": 2
        },
        "measure": 6,
        "characteristics": ["characteristics 1", "characteristics 2", "characteristics 3", "characteristics 4"],
        "consumeTax": 0,
        "reference": "PRUEBA",
        "iva": -2147483606,
        "id": 1587545,
        "largeName": "Prducto de prueba",
        "niifMethod": {
            "value": 1
        },
        "description": "Prducto de prueba",
        "family": 0,
        "name": "Prducto de prueba",
        "barCode": "PRUEBA",
        "group": "001001",
        "localMethod": {
            "value": 0
        }
    }
}
                            

Campos obligatorios: id, name, measure, group, localMethod, niifMethod, accountingClass, characteristics.

Inserción de remisiones

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/remission

Parámetros de entrada:

  • String json: JSon con información del documento (ver Estructura de envío, Envío asientos contables)
  • int year: Año de inserción
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Producto duplicado: {“error”: {“code”:5, message: “Already exists”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---”} , “value”: ”---”, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
  "remission": {
    "accountingDocument": {
      "type": "REM",
      "number": "66666666"
    },
    "date": {
      "day": 15,
      "month": 1,
      "year": 2018
    },
    "clientIdentity": "20498159",
    "idVendor": "1024529585",
    "transactions": [
      {
        "kindQuestion": 0,
        "question": "Detalle pregunta Global",
        "answer": "Respuesta a pregunta Global",
        "kind": 2,
        "quantity": 3,
        "idProduct": 2,
        "measure": 6,
        "unitValue": 3500,
        "totalValue": 10500,
        "priceList": 1,
        "rawValue": 0,
        "idWarehouse": 1
      },
      {
        "kindQuestion": 1,
        "question": "Pregunta por transaccion",
        "answer": "Respuesta pregunta por transaccion",
        "kind": 2,
        "quantity": 3,
        "idProduct": 3,
        "measure": 6,
        "unitValue": 3500,
        "totalValue": 10500,
        "priceList": 1,
        "rawValue": 0,
        "idWarehouse": 1
      }
    ]
  }
}

                            

Campos obligatorios: accountingDocument, date, transactions, clientIdentity, idVendor.Campos obligatorios en transacciones: kind, idPorudct, measure, idWarehouse, quantiy, unitValue, totalValue, priceList


Tipo de preguntas (KindQuestion):

  1. Registra Preguntas Globales.
  2. Registra Preguntas por transacción en cada detalle del envio.

    • Question: Detalle del contenido de la variable creada como tipo pregunta.
    • Answer: Respuesta a pregunta realizada

Inserción y actualización de acreedores

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/supplier

Parámetros de entrada:

  • String json: JSon con información del tercero (ver Estructura de envío, Envío de terceros)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "supplier": {
        "id": "12458995",
        "checkDigit": "01",
        "documentType": {
            "tag": "C"
        },
        "name": "Supplier name",
        "firstName": "Juan",
        "secondName": "Camilo",
        "firstLastName": "Espitia",
        "secondLastName": "Romero",
        "address": "Cll 14 # 20-46 apto 506",
        "telephones": "7894526",
        "cellphone": "3216940073",
        "fax": "1564891578",
        "city": "05001",
        "email": "m.espitia@helisa.com",
        "zone": "Zona",
        "group": "Grupo Acreedor",
        "free1": "Libre 1",
        "free2": "Libre 2",
        "toleranceDays": 5,
        "maxCredit": 1.2,
        "regimen": {
            "tag": "G"
        },
        "paymentForm": 1,
        "selfRetainer": true,
        "cree": false,
        "economicActivity": "10",
        "year": 2015,
        "nature": {
            "value": 0
        }
    }
}
                            

Campos obligatorios: documentType, id, year, name, economicActivity.

  • Tipos de documento (documentType)

    • C: Cédula de Ciudadanía.
    • A: Nit.
    • X: Cédula de extranjería.
    • T: Tarjeta de identidad.
    • R: Registro civil de nacimiento.
    • E: Tarjeta de extranjería.
    • P: Pasaporte.
    • F: Identificación fiscal tributaria.
    • O: Otro.
  • Tipo de persona (nature):

    • 0: Persona natural
    • 1: Persona jurídica
  • Régimen (regimen):

    • C: Régimen Común
    • G: Gran Contribuyente
    • S: Régimen Simplificado
    • O: Entidad Oficial
    • E: Especial
    • P: Persona Natural

Inserción y actualización de clientes

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/client2_0

Parámetros de entrada:

  • String json: JSon con información del tercero (ver Estructura de envío, Envío de terceros)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
  "client": {
    "portfolio": 1,
    "id": "88888888",
    "checkDigit": "4",
    "documentType": {
      "tag": "C"
    },
    "name": "Cuentas S.A.",
    "address": "Carrera 30 #45-00",
    "telephones": "3015604484",
    "cellphone": "3216940073",
    "fax": "1564891578",
    "city": "05001",
    "email": "cliente@gmail.com",
    "zone": "Detalle_Zona",
    "group": "Detalle_Grupo",
    "free1": "Detalle_Campo_Libre_1",
    "free2": " Detalle_Campo_Libre_2",
    "toleranceDays": 60,
    "maxCredit": 150000,
    "regimen": {
      "tag": "O"
    },
    "paymentForm": 1,
    "cree": true,
    "economicActivity": 10,
    "nature": {
      "value": 0
    },
    "firstName": "Juan",
    "secondName": "Camilo",
    "firstLastName": "Arbelaez",
    "secondLastName": "Campos",
    "year": 2018,
    "applyRteFte": "S",
    "applyMaxRteFte": "S",
    "applyMaxRteIva": "N",
    "applyMaxRteIca": "N",
    "contactName": " Persona contacto FE ",
    "contactPhone": "Numero contacto FE",
    "contactEmail": "correo_fe@hotmail.com"",
    "accountPortfolio": "130505",
    "idVendor": "9999999",
    "priceListServices": 1,
    "priceListArticules": 2
  }
}
                            

Campos obligatorios: documentType, id, year, name, portfolio, economicActivity.

  • Tipos de documento (documentType)

    • C: Cédula de Ciudadanía.
    • A: Nit.
    • X: Cédula de extranjería.
    • T: Tarjeta de identidad.
    • R: Registro civil de nacimiento.
    • E: Tarjeta de extranjería.
    • P: Pasaporte.
    • F: Identificación fiscal tributaria.
    • O: Otro.
  • Tipo de persona (nature):

    • 0: Persona natural
    • 1: Persona jurídica
  • Régimen (regimen):

    • C: Régimen Común
    • G: Gran Contribuyente
    • S: Régimen Simplificado
    • O: Entidad Oficial
    • E: Especial
    • P: Persona Natural

Inserción y actualización de terceros

El modo de envío será por medio de un formulario.

Url: /KansasWS/set/thirdParty2_0

Parámetros de entrada:

  • String json: JSon con información del tercero (ver Estructura de envío, Envío de terceros)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

400 Solicitud Incorrecta:

  • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
  • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
  • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
  • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
  "thirdParty": {
    "secondLastName": "Ramírez",
    "cree": false,
    "firstName": "Pedro",
    "economicActivity": "1311",
    "city": "05001",
    "documentType": {
      "tag": "C"
    },
    "year": 2015,
    "nature": {
      "value": 0
    },
    "firstLastName": "Banderas",
    "name": "Pedro Antonio Banderas Ramírez",
    "id": "1012348",
    "checkDigit": "1",
    "regimen": {
      "tag": "S"
    },
    "secondName": "Antonio",
    "userCode": 1,
    "telephones": "3214567878",
    "cellphone": "3214567878",
    "email": "antoniobanderas@gmail.com",
    "address": "CALLE 45"
  }
}
                            

Campos obligatorios: documentType, id, year, name, economicActivity.

  • Tipos de documento (documentType)

    • C: Cédula de Ciudadanía.
    • A: Nit.
    • X: Cédula de extranjería.
    • T: Tarjeta de identidad.
    • R: Registro civil de nacimiento.
    • E: Tarjeta de extranjería.
    • P: Pasaporte.
    • F: Identificación fiscal tributaria.
    • O: Otro.
  • Tipo de persona (nature):

    • 0: Persona natural
    • 1: Persona jurídica
  • Régimen (regimen):

    • C: Régimen Común
    • G: Gran Contribuyente
    • S: Régimen Simplificado
    • O: Entidad Oficial
    • E: Especial
    • P: Persona Natural

Lectura balance general

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/balanceSheet

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y tipo de contabilidad.
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "date": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "accountingType": 1
}
                            

Campos obligatorios: date, accountingType.

  • Tipo de contabilidad (accountingType):

    • 0: Contabilidad local
    • 1: Contabilidad NIIF

Ejemplo de salida json:


[{
    "balance": 8492299.4,
    "name": "ACTIVO",
    "account": "1"
}, {
    "balance": 5485297.63,
    "name": "DISPONIBLE",
    "account": "11"
}, {
    "balance": 4929297.63,
    "name": "CAJA",
    "account": "1105"
}, {
    "balance": 4729297.63,
    "name": "CAJA GENERAL",
    "account": "110505"
}]
                            

Lectura de cartilla de centros de costo

El modo de envío será por medio de un formulario.

Url: /KansasWS/get/costCenterList

Parámetros de entrada:

  • int year: Año de trabajo a consultar.
  • String id: Código de la empresa a consultar.
  • long date: Fecha y hora de petición (Milisegundos).
  • String sign: Firma de seguridad, lo firmado será la concatenación en string de year y date separados por pipe (|).

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Envío de centro de costo)
  • 400 Solicitud Incorrecta:

    • Year inválido: {“error”: {“code”:2, message: “Invalid year”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}

Ejemplo de salida json:


{
    "costCenters": [{
        "level": 1,
        "costCenter": "01",
        "name": "Administración",
        "affectable ": false
    }, {
        "level": 2,
        "costCenter ": "0101 ",
        "name": "Contabilidad",
        "affectable": true
    }]
}
                            

Lectura de cartilla de productos

El modo de envío será por medio de un formulario.

Url: /KansasWS/get/listProductMaster

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y tipo de producto (1: artículos, 2: servicios)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el Json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta lectura de productos)
  • 400 Solicitud Incorrecta:

    • Kind inválido: {"error":{"kind":3,"message:":"Incorrect data fields"}}
    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}

Ejemplo de entrada json:


{
  "startDate": {
    "day": 9,
    "month": 12,
    "year": 2013
  },
  "endDate": {
    "day": 11,
    "month": 12,
    "year": 2013
  },
  "kind": 1,
}
							

Campos obligatorios: startDate, endDate, kind.

  • Tipo de producto (kind):

    • 1: Artículos
    • 2: Servicios

Ejemplo de salida json:


[
  {
    "Articles": {
      "date": "2015-01-09 10:12:34.0",
      "code": 4,
      "ivaTariff": [
        {
          "descripcion": "IVA16%",
          "code": -2147483561
        }
      ],
      "familyCode": 0,
      "sub_code": 6,
      "active": "N",
      "type": "N",
      "billable": "F",
      "reference": "03EA35",
      "ivaTariffPurchase": [
        {
          "descripcion": "IVA16%",
          "code": -2147483561
        }
      ],
      "name": "*LAND-Kit Automotriz por 35Pzs",
      "basePrice": "P",
      "groupCode": "99"
    }
  }
]
							

Especificación de los campos anexos de un artículo

  • Producto facturable (billable):

    • F: Facturable.
    • C: No Facturable.
  • Tipo de producto (type):

    • N: Normal.
    • K: Kit.
    • E: Ensamble.
  • Base precio (basePrice):

    • F: Fijo.
    • U: Ultimo Costo.
    • C: Costo Promedio.

Lectura de cartilla de terceros, clientes y proveedores

El modo de envío será por medio de un formulario.

Url: /KansasWS/get/thirdParty2_0

Parámetros de entrada:

  • int year: Año de trabajo a consultar.
  • String identity: Documento de identificación del tercero.
  • String id: Código de la empresa a consultar.
  • long date: Fecha y hora de petición (Milisegundos).
  • String sign: Firma de seguridad, lo firmado será la concatenación en string de year, identity y date separados por pipe (|).

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Envío de terceros)
  • 400 Solicitud Incorrecta:

    • Year inválido: {“error”: {“code”:2, message: “Invalid year”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}

Ejemplo de salida json:


{
  "thirdParty": {
    "cree": true,
    "address": "CALLE 45",
    "clients": [
      {
        "address": "CRA 15 CALLE DEL COMERCIO",
        "code": 246,
        "portfolio": 1,
        "zone": "",
        "city": "05001",
        "telephones": "3216940073",
        "cellphone": "3216940073",
        "fax": "",
        "email": "",
        "applyMaxRteIca": "",
        "paymentForm": 1,
        "priceListArticules": 0,
        "applyRteFte": "S",
        "idVendor": "1234521453",
        "priceListServices": 1,
        "free2": "campo libre",
        "maxCredit": 150000,
        "free1": "campo libre",
        "group": "grupo",
        "accountPortfolio": "130505",
        "contactEmail": "fe@gmail.com",
        "contactName": "nombre",
        "applyMaxRteFte": " ",
        "toleranceDays": 60,
        "contactPhone": "3144840",
        "applyMaxRteIva": ""
      }
    ],
    "suppliers": [
      {
        "address": "CRA 15 CALLE DEL COMERCIO",
        "code": -2147482281,
        "zone": "",
        "city": "23189",
        "telephones": "3216940073",
        "cellphone": "3216940073",
        "selfRetainer": false,
        "supplierType": 1,
        "fax": "",
        "email": ""
      }
    ],
    "year": 2015,
    "documentType": {
      "tag": "C"
    },
    "nature": {
      "value": 1
    },
    "telephones": "3216940073",
    "economicActivity": 0,
    "name": "Cliente 305",
    "cellphone": "3216940073",
    "id": "3481822",
    "checkDigit": "1",
    "regimen": {
      "tag": "S"
    },
    "secondLastName": "apellido 2",
    "firstName": "nombre 1",
    "firstLastName": "apellido 1",
    "email": "nombre@gmail.com",
    "secondName": "nombre 2"
  }
}
                            

Lectura de índice del documento por tipo

El modo de envío será por medio de un formulario.

Url: /KansasWS/get/documentType

Parámetros de entrada:

  • String type: Tipo de documento
  • boolean reserve: Booleano para reservar el número para el tipo de documento dado
  • String id: Código de la empresa a consultar.
  • long date: Fecha y hora de petición (Milisegundos).
  • String sign: Firma de seguridad, lo firmado será la concatenación en string de type, reserve y date separados por pipe (|).

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Envío de terceros)
  • 400 Solicitud Incorrecta:

    • Year inválido: {“error”: {“code”:2, message: “Invalid year”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}

Ejemplo de salida json:

{"number":"01600251","type":"AB"}

Lectura estado resultados

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/incomeStatement

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y tipo de contabilidad
  • String ID: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "date": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "accountingType": 1
}
                            

Campos obligatorios: date, accountingType.

  • Tipo de contabilidad (accountingType):

    • 0: Contabilidad local
    • 1: Contabilidad NIIF

Ejemplo de salida json:


[{
    "balance": 8492299.4,
    "name": "ACTIVO",
    "account": "1"
}, {
    "balance": 5485297.63,
    "name": "DISPONIBLE",
    "account": "11"
}, {
    "balance": 4929297.63,
    "name": "CAJA",
    "account": "1105"
}, {
    "balance": 4729297.63,
    "name": "CAJA GENERAL",
    "account": "110505"
}]
                            

Lectura resumen de documentos

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/document

Parámetros de entrada:

  • String json: JSon con información del rango de fechas, tipo de contabilidad y tipo de documentos a consultar (ver Estructura de envío, Consulta resumen de documentos)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "startDate": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "endDate": {
        "day": 11,
        "month": 12,
        "year": 2013
    },
    "documentType": "CC",
    "accountingType": 1
}
                            

Campos obligatorios: startDate, endDate, documentType, accountingType.

  • Tipo de contabilidad (accountingType):

    • 0: Contabilidad local
    • 1: Contabilidad NIIF

Ejemplo de salida json:


{
    "documents": [{
        "date": {
            "month": 12,
            "year": 2013,
            "day": 9
        },
        "totalCredits": 110000,
        "document": {
            "number": "00000100",
            "type": "CC"
        },
        "totalDebits": 110000
    }, {
        "date": {
            "month": 12,
            "year": 2013,
            "day": 9
        },
        "totalCredits": 100000,
        "document": {
            "number": "00000101",
            "type": "CC"
        },
        "totalDebits": 100000
    }, {
        "date": {
            "month": 12,
            "year": 2013,
            "day": 9
        },
        "totalCredits": 40562,
        "document": {
            "number": "00000102",
            "type": "CC"
        },
        "totalDebits": 40562
    }]
}
                            

Lectura saldos de una cuenta por terceros

El modo de envío será por medio de un formulario.

Url: /KansasWS/summary/thirdPartyFromAccount

Parámetros de entrada:

  • String json: JSon con información de fecha de corte y cuenta (ver Estructura de envío, Consulta saldos de una cuenta por terceros)
  • String id: Código de la empresa a consultar.
  • String sign: Firma de seguridad, lo firmado será el json.

Salida: (ver Esquema de respuestas)

  • 200 Ok: (ver Estructura de envío, Consulta resumen de documentos)
  • 400 Solicitud Incorrecta:

    • Json inválido: {“error”: {“code”:4, message: “Invalid json”}}
    • ID inválido: {“error”: {“code”:3, message: “Invalid company ID”}}
    • Campos obligatorios incompletos: {“error”: {“code”:6, message: “Mandatory fields missing”, fields: [{“name”:”---” , “value”: ”---”}, {“name”:”---” , “value”: ”---”}]}}
    • Contenido de campos incorrecto: {“error”: {“code”:7, message: “Incorrect data fields”, fields: [{“name”:”---”, “value”: ”---”}, {“name”:”---”, “value”: ”---”}]}}

Ejemplo del parámetro json:


{
    "date": {
        "day": 9,
        "month": 12,
        "year": 2013
    },
    "account": "130505"
}
                            

Campos obligatorios: date, account.

Ejemplo de salida json:


{
    "thirdParties": [{
        "balance": 2000000,
        "name": "PROVEEDOR 01",
        "id": "12001"
    }, {
        "balance": 1000000,
        "name": "PROVEEDOR 02",
        "id": "12002"
    }]
}