Objeto Políticas de Gastos
Puedes hacer uso de la API para solicitar la información de una o más Políticas de Gastos de tu empresa. Por ahora sólo se permite leer información, no crear Políticas de Gastos o actualizar la información de los Políticas de Gastos existentes.
Método: getExpensePolicies
Método para obtener una lista de Políticas de Gastos de la empresa según parámetros definidos.
Parámetro | Descripción | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | GET | |||||||||||||||
URL | https://api.rindegastos.com/v1/getExpensePolicies<params> | |||||||||||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué informes se desea obtener. Los parametros posibles son:
|
A contiuación se muestra un ejemplo usando el método getExpensePolicies de la API de Rindegastos. Este método permite consultar las Políticas de Gastos activas de la empresa.
https://api.rindegastos.com/v1/getExpensePolicies?Status=1&ResultsPerPage=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "Records": { "TotalRecords": 3, "Policies": 2, "Page": 1, "Pages": 2 }, "Policies": [ { "Id": 7, "Name": "New Scotland", "Code": "", "Description": "", "IsActive": true, "Currency": "GBP", "TotalEmployees": 3, "TotalApprovers": 2 }, { "Id": 6, "Name": "East Devon", "Code": "852", "Description": "", "IsActive": true, "Currency": "GBP", "TotalEmployees": 4, "TotalApprovers": 2 } ] }
Método: getExpensePolicy
Método para obtener una política de gastos específica con toda su información.
Parámetro | Descripción | |||
---|---|---|---|---|
Método | GET | |||
URL | https://api.rindegastos.com/v1/getExpensePolicy?Id=<id> | |||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id de la Política de Gastos.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicy de la API de Rindegastos. Este método permite consultar una política de gastos específica de la empresa.
https://api.rindegastos.com/v1/getExpensePolicy?Id=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "Id": 2, "Name": "Headquarters", "Code": "0102HQ", "Description": "My new Policy", "IsActive": true, "Currency": "GBP", "TotalEmployees": 4, "TotalApprovers": 2 }
Método: getExpensePolicyExpenseReportFields
Método para obtener una lista con los campos extra para informes.
Parámetro | Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Método | GET | |||||||||
URL | https://api.rindegastos.com/v1/getExpensePolicyExpenseReportFields?IdPolicy=<id> | |||||||||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id de la política.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicyExpenseReportFields de la API de Rindegastos. Este método permite consultar los campos extra a nivel de informe de una política específica de la empresa.
https://api.rindegastos.com/v1/getExpensePolicyExpenseReportFields?IdPolicy=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "IdPolicy": 2, "PolicyName": "Headquarters", "NbrFields": 2, "ExpenseExtraFields": [ { "Name": "Due Date", "Type": "date", "DefaultValue": "", "DefaultCode": "", "Options": [ ] }, { "Name": "Costing Code", "Type": "list", "DefaultValue": "London", "DefaultCode": "0101", "Options": [ { "Value": "London", "Code": "0101" }, { "Value": "North Wales", "Code": "0202" } ] } ] }
Método: getExpensePolicyExpenseFields
Método para obtener una lista con los campos extra para gastos.
Parámetro | Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Método | GET | |||||||||
URL | https://api.rindegastos.com/v1/getExpensePolicyExpenseFields?IdPolicy=<id> | |||||||||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id de la política.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicyExpenseFields de la API de Rindegastos. Este método permite consultar los campos extra a nivel de gastos de una política específica de la empresa.
https://api.rindegastos.com/v1/getExpensePolicyExpenseFields?IdPolicy=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "IdPolicy": 2, "PolicyName": "Headquarters", "NbrFields": 3, "ExpenseExtraFields": [ { "Name": "VAT ID", "Type": "text", "DefaultValue": "", "DefaultCode": "", "Options": [ ] }, { "Name": "Tipo de Documento", "Type": "list", "DefaultValue": "", "DefaultCode": "", "Options": [ { "Value": "BOLETA", "Code": "dsa" }, { "Value": "Factura Electr\u00f3nica", "Code": "DSA" }, { "Value": "Factura Exenta Electronica", "Code": "SDD" }, { "Value": "N.Cr\u00e9d.Electr\u00f3nica", "Code": "SA" } ] }, { "Name": "Expense Type", "Type": "list", "DefaultValue": "Invoice", "DefaultCode": "02", "Options": [ { "Value": "Invoice", "Code": "02" }, { "Value": "Ticket", "Code": "01" } ] } ] }
Método: getExpensePolicyCategories
Método para obtener una lista con todas las categorías de una política específica.
Parámetro | Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Método | GET | |||||||||
URL | https://api.rindegastos.com/v1/getExpensePolicyCategories?IdPolicy=<id> | |||||||||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id de la política.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicyCategories de la API de Rindegastos. Este método permite consultar las categorías actualmente activas de una política específica de la empresa.
{ "IdPolicy": 2, "PolicyName": "Headquarters", "NbrCategories": 7, "Categories": [ { "Name": "Water", "GroupName": "Utilities", "GroupCode": "U012", "AccountCode": "701-202", "Instructions": "" }, { "Name": "Uber", "GroupName": "Travels", "GroupCode": "T01", "AccountCode": "101-105", "Instructions": "Only for Uber" }, { "Name": "Taxi", "GroupName": "Travels", "GroupCode": "T01", "AccountCode": "101-102", "Instructions": "Only for taxi" }, { "Name": "Phones", "GroupName": "Utilities", "GroupCode": "U012", "AccountCode": "802-201", "Instructions": "" }, { "Name": "Internet", "GroupName": "Utilities", "GroupCode": "U012", "AccountCode": "902-302", "Instructions": "" }, { "Name": "Food", "GroupName": "Travels", "GroupCode": "T01", "AccountCode": "101-101", "Instructions": "" }, { "Name": "Electricity", "GroupName": "Utilities", "GroupCode": "U012", "AccountCode": "701-201", "Instructions": "" } ] }
Método: getExpensePolicyWorkflow
Método para obtener una lista con todos los aprobadores del flujo de aprobación para una política específica.
Parámetro | Descripción | |||
---|---|---|---|---|
Método | GET | |||
URL | https://api.rindegastos.com/v1/getExpensePolicyWorkflow?IdPolicy=<id> | |||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id de la política.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicyWorkflow de la API de Rindegastos. Este método permite consultar el flujo de aprobación de una política específica de la empresa.
https://api.rindegastos.com/v1/getExpensePolicyWorkflow?IdPolicy=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "IdPolicy": 2, "PolicyName": "Headquarters", "RevisionLevels": 2, "Approvers": [ { "Level": 1, "ApproverId": "2", "ApproverName": "John Lemon", "ApproverEmail": "John@myAbbey.net", "AmmountRestriction": false, "RestrictionReportAmount": 0, "RestrictionExtraApproverId": "", "RestrictionExtraApproverEmail": "" }, { "Level": 2, "ApproverId": "4", "ApproverName": "Apple MacCartney", "ApproverEmail": "apple@myabbey.net", "AmmountRestriction": false, "RestrictionReportAmount": 0, "RestrictionExtraApproverId": "", "RestrictionExtraApproverEmail": "" } ] }
Método: getExpensePolicyTaxes
Método para obtener una lista con todos los impuestos configurados en la política de gastos.
Parámetro | Descripción | |||
---|---|---|---|---|
Método | GET | |||
URL | https://api.rindegastos.com/v1/getExpensePolicyTaxes?IdPolicy=<id> | |||
Params |
Para usar este servicio se debe enviar el Id de la política de gastos.
|
A contiuación se muestra un ejemplo usando el método getExpensePolicyTaxes de la API de Rindegastos.
https://api.rindegastos.com/v1/getExpensePolicyTaxes?IdPolicy=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "IdPolicy": 2, "PolicyName": "Headquarters", "NbrTaxes": 2, "Taxes": [ { "Type": 1, "Name": "Exempt", "Value": 0 }, { "Type": 1, "Name": "VAT", "Value": 20 } ] }