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:
|
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, "CreatedAt": 2020-07-23 22:36:44, "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, "CreatedAt": 2020-07-10 13:47:47, "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.
|
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, "CreatedAt": 2020-07-10 13:34:19, "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.
|
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, "CreatedAt": 2016-07-10 13:34:19, "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.
|
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, "CreatedAt": 2016-07-10 13:34:19, "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.
|
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, "CreatedAt": 2016-08-10 13:34:19, "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.
|
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, "CreatedAt": 2017-09-10 13:34:19, "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.
|
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, "CreatedAt": 2016-09-12 13:34:19, "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" } ] }