Objeto Fondos

Puedes hacer uso de la API para solicitar la información de uno o más fondos de tu empresa. Por ahora sólo se permite leer información, no crear fondos o actualizar la información de los fondos existentes.

Método: getFunds

Método para obtener una lista de fondos de la empresa según parámetros definidos. No incluye la lista de movimientos de cada fondo.

Parámetro Descripción
Método GET
URL https://api.rindegastos.com/v1/getFunds<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué informes se desea obtener. Los parametros posibles son:
Status integer 1 = Abiertos; 2 = Cerrados; 3 = Bloqueados; en blanco muestra todos los fondos.
OrderBy integer Permite indicar bajo cual parametro vamos a ordenar la lista de informes obtenida, donde: 1 = fecha de creación, 2 = Título del fondo y por defecto si se envía en blanco fecha de creación
Order integer ASC o DESC (default).
ResultsPerPage integer Número de Resultados por página.
Page integer Página de resultados. Por defecto = 1

A continuación se muestra un ejemplo usando el método getFunds de la API de Rindegastos. Este método permite consultar los fondos de la empresa.

https://api.rindegastos.com/v1/getFunds?ResultsPerPage=2
METHOD GET
Authorization: Bearer <token>

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Records": {
    "TotalRecords": 2,
    "Funds": 2,
    "Page": 1,
    "Pages": 1
  },
  "Funds": [
    {
      "Id": 2,
      "Title": "Manager ",
      "Code": "ST856",
      "Currency": "USD",
      "IdAssignTo": 3,
      "IdCreator": 2,
      "Deposits": 15200.00,
      "Withdrawals": 0.00,
      "Balance": 15200.00,
      "Status": 1,
      "ExpirationDate": "",
      "FlexibleFund": "1",
      "ManualDeposit": false,
      "AutomaticBlock": false
    },
    {
      "Id": 1,
      "Title": "Sales Executive",
      "Code": "PM025",
      "Currency": "USD",
      "IdAssignTo": 4,
      "IdCreator": 2,
      "Deposits": 85622.00,
      "Withdrawals": 0.00,
      "Balance": 85622.00,
      "Status": 1,
      "ExpirationDate": "",
      "FlexibleFund": "1",
      "ManualDeposit": false,
      "AutomaticBlock": false
    }
  ]
}

Método: getFund

Método para obtener un fondo con toda su información. Incluye la lista de movimientos del fondo solicitado.

Parámetro Descripción
Método GET
URL https://api.rindegastos.com/v1/getFund?Id=<id>
Params Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id del fondo.
Id int Id único del fondo que se desea obtener.

A continuación se muestra un ejemplo usando el método getFund de la API de Rindegastos. Este método permite consultar un fondo específico de la empresa.

https://api.rindegastos.com/v1/getFund?Id=3
METHOD GET
Authorization: Bearer <token>

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive ",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 4,
  "Deposits": 860.00,
  "Charges": 30.00,
  "Balance": 830.00,
  "Status": 1,
  "ExpirationDate": "",
  "FlexibleFund": "1",
  "ManualDeposit": false,
  "AutomaticBlock": false,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    },
    {
      "TransactionType": 2,
      "TransactionTypeName": "Withdrawal",
      "TransactionAmount": 30.00,
      "TransactionDate": "2017-06-30"
    }
  ]
}

Método: createFund

Método para crear un fondo con toda su información.

Parámetro Descripción
Método POST
URL https://api.rindegastos.com/v1/createFund
Post Params Parametros a comunicar para crear un fondo.
IdEmployee int Id único del empleado al cual asignaremos el fondo. (Obligatorio)
IdAdmin int Id único del usuario con rol administrador bajo el cual crearemos el Fondo (debe tener definido permiso para administrar fondos). (Obligatorio)
FundName String(200) Nombre del fondo. (Obligatorio)
FundCurrency String(3) Código estándar (ISO 4217) de la moneda asociada al fondo. (Obligatorio)
FundCode String(50) Código del fondo.
FundAmount float Monto del fondo con dos posiciones decimales (separadas con punto). (Obligatorio)
FundComment String(255) Comentario u observación del fondo.
FundFlexibility bool El usuario podrá enviar informes aunque se sobrepase el saldo disponible.
FundAutoDeposit bool Al cerrar un informe de gastos asociado a este fondo abonar automáticamente el monto aprobado para volver al saldo disponible inicial.
FundAutoBlock bool Bloquear este fondo luego de que el rendidor envíe un informe de gastos.
FundExpiration bool Definir una fecha en la que fondo debe ser rendido y alertar al rendidor y al creador del fondo.
FundExpirationDate Date YYYY-MM-DD Fecha en la que fondo debe ser rendido (solo si FundExpiration es TRUE)

A continuación se muestra un ejemplo usando el método getFund de la API de Rindegastos. Este método permite consultar un fondo específico de la empresa.

curl 'https://api.rindegastos.com/v1/createFund' -X POST
-d '{"IdEmployee":4,"IdAdmin":5,"FundName":"Fund Executive","FundCurrency":"GBP","FundCode":"852KJ","FundAmount":860.00,"FundComment":"Comment...","FundFlexibility":true,"FundAutoDeposit":true,"FundAutoBlock":true,"FundExpiration":true,"FundExpirationDate":"2017-01-01"}'
-H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive ",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 5,
  "Deposits": 860.00,
  "Charges": 0.00,
  "Balance": 860.00,
  "Status": 1,
  "ExpirationDate": "2017-01-01",
  "FlexibleFund": true,
  "ManualDeposit": true,
  "AutomaticBlock": true,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    }
   
  ]
}

Método: updateFund

Método para actualizar un fondo. No se podrá cambiar el propietario, el creador, la moneda ni el monto disponible del fondo.

Parámetro Descripción
Método PUT
URL https://api.rindegastos.com/v1/updateFund
Post Params Parametros a comunicar para actualizar un fondo.
Id int Id único del fondo que deseamos actualizar. (Obligatorio)
IdAdmin int Id único del usuario con rol administrador bajo el cual actualizaremos el Fondo (debe tener definido permiso para administrar fondos). (Obligatorio)
FundName String(200) Nombre del fondo. (Obligatorio)
FundCode String(50) Código del fondo.
FundComment String(255) Comentario u observación del fondo.
FundFlexibility bool El usuario podrá enviar informes aunque se sobrepase el saldo disponible.
FundAutoDeposit bool Al cerrar un informe de gastos asociado a este fondo abonar automáticamente el monto aprobado para volver al saldo disponible inicial.
FundAutoBlock bool Bloquear este fondo luego de que el rendidor envíe un informe de gastos.
FundExpiration bool Definir una fecha en la que fondo debe ser rendido y alertar al rendidor y al creador del fondo.
FundExpirationDate Date YYYY-MM-DD Fecha en la que fondo debe ser rendido (solo si FundExpiration es TRUE)

A continuación se muestra un ejemplo usando el método updateFund de la API de Rindegastos. Este método permite actualizar un fondo específico de la empresa.

curl 'https://api.rindegastos.com/v1/updateFund' -X PUT
-d '{"Id":3,"IdAdmin":5,"FundName":"Fund Executive Update","FundCode":"852KJ","FundComment":"Comment...","FundFlexibility":true,"FundAutoDeposit":true,"FundAutoBlock":true,"FundExpiration":true,"FundExpirationDate":"2017-01-01"}'
-H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive Update",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 5,
  "Deposits": 860.00,
  "Charges": 0.00,
  "Balance": 860.00,
  "Status": 1,
  "ExpirationDate": "2017-01-01",
  "FlexibleFund": true,
  "ManualDeposit": true,
  "AutomaticBlock": true,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    }
   
  ]
}

Método: depositMoneyToFund

Método para realizar abonos a un fondo específico.

Parámetro Descripción
Método POST
URL https://api.rindegastos.com/v1/depositMoneyToFund
Post Params Parametros a comunicar para actualizar un fondo.
Id int Id único del fondo al cual deseamos realizar un abono. (Obligatorio)
IdAdmin int Id único del usuario con rol administrador bajo el cual realizaremos el abono (debe tener definido permiso para administrar fondos). (Obligatorio)
DepositAmount float Monto del abono a realizar, permite valores con dos posiciones decimales (con punto separador).

A continuación se muestra un ejemplo usando el método depositMoneyToFund de la API de Rindegastos.

curl 'https://api.rindegastos.com/v1/depositMoneyToFund' -X POST
-d '{"Id":3,"IdAdmin":6,"DepositAmount":100.00}'
-H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive Update",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 5,
  "Deposits": 960.00,
  "Charges": 0.00,
  "Balance": 960.00,
  "Status": 1,
  "ExpirationDate": "2017-01-01",
  "FlexibleFund": true,
  "ManualDeposit": true,
  "AutomaticBlock": true,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    },
   {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 100.00,
      "TransactionDate": "2017-06-30"
    }
  ]
}

Método: withdrawMoneyFromFund

Método para realizar cargos a un fondo específico.

Parámetro Descripción
Método POST
URL https://api.rindegastos.com/v1/withdrawMoneyFromFund
Post Params Parametros a comunicar para actualizar un fondo.
Id int Id único del fondo al cual deseamos realizar un cargo. (Obligatorio)
IdAdmin int Id único del usuario con rol administrador bajo el cual realizaremos el cargo (debe tener definido permiso para administrar fondos). (Obligatorio)
WithdrawAmount float Monto del cargo a realizar, permite valores con dos posiciones decimales (con punto separador).

A continuación se muestra un ejemplo usando el método withdrawMoneyFromFund de la API de Rindegastos.

curl 'https://api.rindegastos.com/v1/withdrawMoneyFromFund' -X POST
-d '{"Id":3,"IdAdmin":6,"WithdrawAmount":100.00}'
-H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive Update",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 5,
  "Deposits": 860.00,
  "Charges": 100.00,
  "Balance": 760.00,
  "Status": 1,
  "ExpirationDate": "2017-01-01",
  "FlexibleFund": true,
  "ManualDeposit": true,
  "AutomaticBlock": true,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    },
   {
      "TransactionType": 2,
      "TransactionTypeName": "Withdrawal",
      "TransactionAmount": 100.00,
      "TransactionDate": "2017-06-30"
    }
  ]
}

Método: setFundStatus

Método para cambiar el estado a un fondo.

Parámetro Descripción
Método PUT
URL https://api.rindegastos.com/v1/setFundStatus
Post Params Parametros a comunicar para actualizar un fondo.
Id int Id único del fondo al cual deseamos realizar un cargo. (Obligatorio)
IdAdmin int Id único del usuario con rol administrador bajo el cual realizaremos el cargo (debe tener definido permiso para administrar fondos). (Obligatorio)
FundStatus int Estado bajo el cual queremos dejar el fondo. Los valores para los estados disponibles son:

- 1 (Abierto): Al estar el fondo en estado, permite al rendidor enviar informes de gastos asociados al fondo especificado.
- 2 (Cerrado):Cerrar y dar por terminado el ciclo de vida del fondo especificado.
- 3 (Bloqueado):Al estar el fondo en estado, No permite al rendidor enviar informes de gastos asociados al fondo especificado.

A continuación se muestra un ejemplo usando el método setFundStatus de la API de Rindegastos.

curl 'https://api.rindegastos.com/v1/setFundStatus' -X PUT
-d '{"Id":3,"IdAdmin":6,"FundStatus":2}'
-H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "Id": 3,
  "Title": "Fund Executive Update",
  "Code": "852KJ",
  "Currency": "GBP",
  "IdAssignTo": 4,
  "IdCreator": 5,
  "Deposits": 860.00,
  "Charges": 100.00,
  "Balance": 760.00,
  "Status": 2,
  "ExpirationDate": "2017-01-01",
  "FlexibleFund": true,
  "ManualDeposit": true,
  "AutomaticBlock": true,
  "Transactions": [
    {
      "TransactionType": 1,
      "TransactionTypeName": "Deposit",
      "TransactionAmount": 860.00,
      "TransactionDate": "2017-06-30"
    },
   {
      "TransactionType": 2,
      "TransactionTypeName": "Withdrawal",
      "TransactionAmount": 100.00,
      "TransactionDate": "2017-06-30"
    }
  ]
}
2018-12-10 07:19:43