Desarrolladores Api Orzame - Tipos de gastos

Tipos de gastos

Los tipos de gastos ofrecen la posibilidad de etiquetar tus gastos con el objetivo de generar datos estadísticos agrupados de los mismos.

Crear un nuevo tipo de gasto

Este endpoint permite la creación de un nuevo tipo de gasto en tu aplicación.

Petición HTTP

POST/expense-types

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Obligatoria	Nombre de el tipo de gasto

Datos petición

{
    "name": "Hardware"
}

201Respuesta

{
    "data": {
        "id": 15,
        "name": "Hardware",
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Listar tipos de gasto

Este endpoint permite la consulta de los tipos de gasto de tu aplicación.

Petición HTTP

GET/expense-types

Parámetros GET

Nombre	Tipo	Descripción
page	Entero / Opcional / Min:1	Página
per_page	Entero / Opcional / Min:1 Max:100	Elementos por página

200 Respuesta

{
    "data": [
        {
            "id": 15,
            "name": "Hardware",
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 13,
            "name": "Communications",
            "created_at": "2022-09-29T15:30:15+00:00",
            "updated_at": "2022-09-29T15:30:15+00:00"
        },
        {
            "id": 6,
            "name": "Software Subscriptions",
            "created_at": "2022-09-28T15:30:15+00:00",
            "updated_at": "2022-09-28T15:30:15+00:00"
        },
        {
            "id": 5,
            "name": "Office",
            "created_at": "2022-09-27T15:30:15+00:00",
            "updated_at": "2022-09-27T15:30:15+00:00"
        }
    ],
    "links": {
        "first": "http:\/\/api.orzame.com\/v1\/expense-types?page=1",
        "last": "http:\/\/api.orzame.com\/v1\/expense-types?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/api.orzame.com\/v1\/expense-types",
        "per_page": 100,
        "to": 4,
        "total": 4
    }
}

Obtener un tipo de gasto

Este endpoint permite la consulta de un tipo de gasto de tu aplicación.

Petición HTTP

GET/expense-types/{id}

200 Respuesta

{
    "data": {
        "id": 15,
        "name": "Hardware",
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Actualizar un tipo de gasto

Este endpoint permite la actualización de un tipo de gasto de tu aplicación.

Petición HTTP

PATCH/expense-types/{id}

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Obligatoria	Nombre de el tipo de gasto

Datos petición

{
    "name": "Hardware"
}

204 Respuesta

Respuesta sin cuerpo.

Eliminar un tipo de gasto

Este endpoint permite la eliminación de un tipo de gasto de tu aplicación.

No es posible eliminar si está en uso en la aplicación.

Petición HTTP

DELETE/expense-types/{id}

204 Respuesta

Respuesta sin cuerpo.