API
General
Autenticación Solicitudes
Objetos
Gasto getExpenses getExpense setExpenseIntegration Informe de Gastos Fondos Política de Gastos Usuarios
SDKs
PHP JAVA .Net C# Python Ruby
Ejemplos
Integración Estándar
Ayuda
Contacto

Objeto Gasto

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

Método: getExpenses

Método para obtener una lista de gastos de la empresa según parámetros definidos.

Parámetro Descripción
Método GET
URL https://api.rindegastos.com/v1/getExpenses<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué gastos se desea obtener. Los parametros posibles son:
Since * date Fecha desde cuando contar los gastos en formato YYYY-MM-DD.
Until date Fecha hasta cuando contar los gastos en formato YYYY-MM-DD.
Currency string(3) Código ISO de la moneda que se desea filtrar. Por ejemplo USD para dólar americano. Este parámetro trabaja sobre la moneda final del gasto, no la moneda original.
Status int 1: Aprobado; 2: Rechazado; 0: En proceso.
Category string(150) Nombre de la categoría de gastos que se desea.
ReportId int Id único del informe de gastos
ExpensePolicyId int Id único de la política de gastos
IntegrationStatus integer Buscar gastos por estado de integración: 1 = Integrados o 0 = No integrados. Si se envía blanco no se agrega al filtro de busqueda.
IntegrationCode String(255) Buscar gastos integrados, filtrando por el código de comprobante asociado al gasto.
IntegrationDate Date Buscar gastos integrados, filtrando por fecha de integración en formato YYYY-MM-DD.
UserId int Id único del usuario en Rindegastos
OrderBy int 1: fecha del gasto; 2: fecha creación del gasto. Por defecto el orden es por fecha del gasto.
Order string ASC o DESC (default)
ResultsPerPage int Número de resultados por solicitud (máximo 100).
Page int Página de resultados. Por defecto = 1

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 getExpenses de la API de Rindegastos. Este método permite consultar los gastos de la empresa. 

https://api.rindegastos.com/v1/getExpenses?Currency=GBP&ResultsPerPage=2
METHOD GET
Authorization: Bearer <token>

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

{
  "Records": {
    "TotalRecords": 3,
    "Expenses": 2,
    "Page": 1,
    "Pages": 2
  },
  "Expenses": [
    {
      "Id": 7,
      "Status": 1,
      "Supplier": "Great Customer",
      "IssueDate": "2017-06-27",
      "OriginalAmount": 23.99,
      "OriginalCurrency": "GBP",
      "ExchangeRate": 0,
      "Net": 19.99,
      "Tax": 4,
      "TaxName": "VAT",
      "OtherTaxes": 0,
      "RetentionName": "",
      "Retention": 0,
      "Total": 23.99,
      "Currency": "GBP",
      "Reimbursable": false,
      "Category": "Electricity",
      "CategoryCode": "701-201",
      "CategoryGroup": "Utilities",
      "CategoryGroupCode": "U012",
      "Note": 0,
      "IntegrationDate": "",
      "IntegrationExternalCode": "",
      "ExtraFields": [
        {
          "Name": "Expense Type",
          "Value": "Invoice",
          "Code": "02"
        },
        {
          "Name": "VAT ID",
          "Value": "99999999",
          "Code": ""
        }
      ],
      "Files": [
        {
          "FileName": "invoice.png",
          "Extension": "png",
          "Original": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/original\/2-1-5952e07e4c44a-1498603646-192.png",
          "Large": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/large\/2-1-5952e07e4c44a-1498603646-192.png",
          "Medium": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/medium\/2-1-5952e07e4c44a-1498603646-192.png",
          "Small": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/small\/2-1-5952e07e4c44a-1498603646-192.png"
        }
      ],
      "NbrFiles": 1,
      "ReportId": 1,
      "ExpensePolicyId": 6,
      "UserId": 2
    },
    {
      "Id": 8,
      "Status": 1,
      "Supplier": "London Underground",
      "IssueDate": "2017-06-27",
      "OriginalAmount": 5,
      "OriginalCurrency": "GBP",
      "ExchangeRate": 0,
      "Net": 5,
      "Tax": 0,
      "TaxName": "Exempt",
      "OtherTaxes": 0,
      "RetentionName": "",
      "Retention": 0,
      "Total": 5,
      "Currency": "GBP",
      "Reimbursable": false,
      "Category": "Taxi",
      "CategoryCode": "101-102",
      "CategoryGroup": "Travels",
      "CategoryGroupCode": "T01",
      "Note": 0,
      "IntegrationDate": "",
      "IntegrationExternalCode": "",
      "ExtraFields": [
        {
          "Name": "Expense Type",
          "Value": "Ticket",
          "Code": "01"
        },
        {
          "Name": "VAT ID",
          "Value": "",
          "Code": ""
        }
      ],
      "Files": [
        {
          "FileName": "London_Underground_One-Day_Travelcard.jpg",
          "Extension": "jpg",
          "Original": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/original\/2-1-5952e1803d7d8-1498603904-489.jpg",
          "Large": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/large\/2-1-5952e1803d7d8-1498603904-489.jpg",
          "Medium": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/medium\/2-1-5952e1803d7d8-1498603904-489.jpg",
          "Small": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/small\/2-1-5952e1803d7d8-1498603904-489.jpg"
        }
      ],
      "NbrFiles": 1,
      "ReportId": 1,
      "ExpensePolicyId": 6,
      "UserId": 2
    }
  ]
}

Método: getExpense

Método para obtener un gasto con toda su información.

Parámetro Descripción
Método GET
URL https://api.rindegastos.com/v1/getExpense?Id=<id>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué gastos se desea obtener. Los parametros posibles son:
Id int Id único del gasto que se desea obtener.

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

{
  "Id": 7,
  "Status": 1,
  "Supplier": "Great Customer",
  "IssueDate": "2017-06-27",
  "OriginalAmount": 23.99,
  "OriginalCurrency": "GBP",
  "ExchangeRate": 0,
  "Net": 19.99,
  "Tax": 4,
  "TaxName": "VAT",
  "OtherTaxes": 0,
  "RetentionName": "",
  "Retention": 0,
  "Total": 23.99,
  "Currency": "GBP",
  "Reimbursable": false,
  "Category": "Electricity",
  "CategoryCode": "701-201",
  "CategoryGroup": "Utilities",
  "CategoryGroupCode": "U012",
  "Note": 0,
  "IntegrationDate": "",
  "IntegrationExternalCode": "",
  "ExtraFields": [
    {
      "Name": "Expense Type",
      "Value": "Invoice",
      "Code": "02"
    },
    {
      "Name": "VAT ID",
      "Value": "99999999",
      "Code": ""
    }
  ],
  "Files": [
    {
      "FileName": "invoice.png",
      "Extension": "png",
      "Original": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/original\/2-1-5952e07e4c44a-1498603646-192.png",
      "Large": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/large\/2-1-5952e07e4c44a-1498603646-192.png",
      "Medium": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/medium\/2-1-5952e07e4c44a-1498603646-192.png",
      "Small": "https:\/\/ppstatic.s3.amazonaws.com\/expenses\/uploads\/small\/2-1-5952e07e4c44a-1498603646-192.png"
    }
  ],
  "NbrFiles": 1,
  "ReportId": 1,
  "ExpensePolicyId": 6,
  "UserId": 2
}

Método: setExpenseIntegration

Método para marcar como integrado o no integrado un gasto específico.

Parámetro Descripción
Método PUT
URL https://api.rindegastos.com/v1/setExpenseIntegration
Post Params Parámetros que pueden ser agregados a la solicitud para discriminar qué gastos se marcarán como integrados o no integrados.
Id int Id único del gasto que se desea marcar como integrado o no integrado.
IntegrationStatus int Estado Integrado = 1 o bien No Integrado = 0.
IntegrationCode string(255) Permite comunicar un código de comprobante contable para enlazar información de la integración con los gastos existentes en Rindegastos.
IntegrationDate DateTime Fecha/hora de integración YYYY-MM-DD H:i:s, por defecto si el valor del atributo IntegrationStatus es igual a cero, este valor será vacio.

A continuación se muestra un ejemplo usando el método setExpenseIntegration de la API de Rindegastos. Este método permite marcar o desmarcar el estado Integrado un gasto específico de la empresa. 

curl 'http://localhost:9004/v1/setExpenseIntegration' -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,
    "Supplier": "Wallmart",
    "OriginalAmount": 100000,
    "OriginalCurrency": "CLP",
    "IntegrationStatus": 1,
    "IntegrationCode": "0303456",
    "IntegrationDate": "2017-08-01 12:00:00"
}
2024-10-30 23:33:29