API documentation

v1.0

Líneas de negocio

Las líneas de negocio ofrecen la posibilidad de etiquetar tus presupuestos y facturas con el objetivo de generar datos estadísticos agrupados por las actividades realizadas.

Crear una línea de negocio

Este endpoint permite la creación de una nueva línea de negocio en tu aplicación.

Petición HTTP

POST/business-lines

Parámetros

NombreTipoDescripción
nameCadena / ObligatoriaNombre de la línea de negocio

Datos petición

{
    "name": "System"
}

201Respuesta

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

Listar líneas de negocio

Este endpoint permite la consulta de las líneas de negocio de tu aplicación.

Petición HTTP

GET/business-lines

Parámetros GET

NombreTipoDescripción
pageEntero / Opcional / Min:1Página
per_pageEntero / Opcional / Min:1 Max:100Elementos por página

200 Respuesta

{
    "data": [
        {
            "id": 86,
            "name": "Systems",
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 63,
            "name": "Desing",
            "created_at": "2022-09-29T15:30:15+00:00",
            "updated_at": "2022-09-29T15:30:15+00:00"
        },
        {
            "id": 50,
            "name": "Programing",
            "created_at": "2022-09-28T15:30:15+00:00",
            "updated_at": "2022-09-28T15:30:15+00:00"
        }
    ],
    "links": {
        "first": "http:\/\/api.orzame.com\/v1\/business-lines?page=1",
        "last": "http:\/\/api.orzame.com\/v1\/business-lines?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/api.orzame.com\/v1\/business-lines",
        "per_page": 100,
        "to": 3,
        "total": 3
    }
}

Obtener una línea de negocio

Este endpoint permite la consulta de una línea de negocio de tu aplicación.

Petición HTTP

GET/business-lines/{id}

200 Respuesta

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

Actualizar una línea de negocio

Este endpoint permite la actualización de una línea de negocio de tu aplicación.

Petición HTTP

PATCH/business-lines/{id}

Parámetros

NombreTipoDescripción
nameCadena / ObligatoriaNombre de la línea de negocio

Datos petición

{
    "name": "System"
}

204 Respuesta

Respuesta sin cuerpo.

Eliminar una línea de negocio

Este endpoint permite la eliminación de una línea de negocio de tu aplicación.

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

Petición HTTP

DELETE/business-lines/{id}

204 Respuesta

Respuesta sin cuerpo.