Objeto Informe de Gastos
Puedes hacer uso de la API para solicitar la información de uno o más informes de gastos de tu empresa. Por ahora sólo se permite leer información, no crear informes o actualizar la información de los informes creados.
Método: getExpenseReports
Método para obtener una lista de informes de la empresa según parámetros definidos.
| Parámetro | Descripción | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Método | GET | ||||||||||||||||||||||||||||||||||||||||||
| URL | https://api.rindegastos.com/v1/getExpenseReports<params> | ||||||||||||||||||||||||||||||||||||||||||
| Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué informes se desea obtener. Los parametros posibles son:
|
Importante: el campo since es obligatorio y debe tener como maximo con un año de rango a la fecha o al until
A continuación se muestra un ejemplo usando el método getExpenseReports de la API de Rindegastos. Este método permite consultar los informes de gastos de la empresa.
https://api.rindegastos.com/v1/getExpenseReports?Currency=GBP&ResultsPerPage=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "Records": { "TotalRecords": 1, "Reports": 1, "Page": 1, "Pages": 1 }, "ExpenseReports": [ { "Id": 1, "Title": "New Expense Report", "ReportNumber": "1", "SendDate": "2017-06-27", "CloseDate": "2017-06-29", "EmployeeId": 2, "EmployeeName": "John Lemon", "EmployeeIdentification": "", "ApproverId": 4, "ApproverName": "Apple MacCartney", "PolicyId": 6, "PolicyName": "East Devon", "Status": 1, "CustomStatus": "", "FundId": 0, "FundName": "", "ReportTotal": 36.99, "ReportTotalApproved": 36.99, "Currency": "GBP", "Note": "Check", "Integrated": "", "IntegrationDate": "", "IntegrationExternalCode": "", "IntegrationInternalCode": "", "NbrExpenses": 3, "NbrApprovedExpenses": 3, "NbrRejectedExpenses": 0, "ExtraFields": [ { "Name": "Costing Code", "Value": "London", "Code": "0101" }, { "Name": "Due Date", "Value": "2017-06-20", "Code": "" } ], "Files": [ ] } ] }
Método: getExpenseReport
Método para obtener un informe de gastos con toda su información.
| Parámetro | Descripción | |||
|---|---|---|---|---|
| Método | GET | |||
| URL | https://api.rindegastos.com/v1/getExpenseReport?Id=<id> | |||
| Params |
Para usar este servicio se debe definir el Id del informe de gastos y enviarlo como parámetro.
|
A continuaciónse muestra un ejemplo usando el método getExpenseReport de la API de Rindegastos. Este método permite consultar un informe de gastos específico de la empresa.
https://api.rindegastos.com/v1/getExpense?Id=1 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "Id": 1, "Title": "New Expense Report", "ReportNumber": "1", "SendDate": "2017-06-27", "CloseDate": "2017-06-29", "EmployeeId": 2, "EmployeeName": "John Lemon", "EmployeeIdentification": "", "ApproverId": 4, "ApproverName": "Apple MacCartney", "PolicyId": 6, "PolicyName": "East Devon", "Status": 1, "CustomStatus": "", "FundId": 0, "FundName": "", "ReportTotal": 36.99, "ReportTotalApproved": 36.99, "Currency": "GBP", "Note": "Check", "IntegrationDate": "", "IntegrationExternalCode": "", "NbrExpenses": 3, "NbrApprovedExpenses": 3, "NbrRejectedExpenses": 0, "ExtraFields": [ { "Name": "Costing Code", "Value": "London", "Code": "0101" }, { "Name": "Due Date", "Value": "2017-06-20", "Code": "" } ], "Files": [ ] }
Método: setExpenseReportIntegration
Método para marcar como integrado o no integrado una rendición de gastos específica.
| Parámetro | Descripción | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Método | PUT | ||||||||||||
| URL | https://api.rindegastos.com/v1/setExpenseReportIntegration | ||||||||||||
| Post Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué reportes se marcaraán como integrados o no integrados.
|
A continuación se muestra un ejemplo usando el método setExpenseReportIntegration de la API de Rindegastos. Este método permite marcar o desmarcar el estado Integrado un gasto específico de la empresa.
curl 'https://api.rindegastos.com/v1/setExpenseReportIntegration' -X PUT -d '{"Id":1,"IntegrationStatus":1,"IntegrationCode":"0303456","IntegrationDate":"2017-08-01 12:00:00"}' -H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'
{ "Id": 1, "Title": "dsfsdfsd", "ReportNumber": "1", "IntegrationStatus": 1, "IntegrationCode": "0303456", "IntegrationDate": "2017-08-01 12:00:00" }
Método: setExpenseReportCustomStatus
Método para actualizar el estado personalizado de una rendición de gastos específica.
| Parámetro | Descripción | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Método | PUT | ||||||||||||
| URL | https://api.rindegastos.com/v1/setExpenseReportCustomStatus | ||||||||||||
| Post Params |
Parámetros que pueden ser agregados a la solicitud.
|
A continuación se muestra un ejemplo usando el método setExpenseReportCustomStatus de la API de Rindegastos.
curl 'https://api.rindegastos.com/v1/setExpenseReportCustomStatus' -X POST -d '{"Id":4,"IdAdmin":5,"CustomStatus":"Waiting for payment","CustomMessage":"Payment By George Clinton"}' -H 'authorization: Bearer <token> ' -H 'Content-Type: application/json'
{ "Id": 1, "Title": "dsfsdfsd", "ReportNumber": "1", "CustomStatus": "Waiting for payment" }
Importante: El método setExpenseReportCustomStatus no permite crear estados personalizados en políticas de gasto, solo asigna un estado a una rendición; es recomendable crear el o los estados personalizados en la políticas correspondientes antes de utilizar este método.
