Skip to content

sale

Jump to bottom
damnlist edited this page Jul 1, 2016 · 1 revision

Sales

GET '/list/{listId}/client/{clientId}/sales'

list of client sales:

{
    "status": "ok",
    "data": [
        {
            "id": 89,
            "name": "Test 1",
            "price": "100.00",
            "type": 1,
            "items": [
                {
                    "id": 1,
                    "text": "Test 1 1",
                    "doneAt": null,
                    "doneByUser": null,
                    "file": null
                }
            ]
        }
    ]
}

POST '/list/{listId}/client/{clientId}/sales'

{
    "name": "Name",
    "price": 100.29,
    "type": 2
}

adding sale:

{
    "status": "ok",
    "data": {
        "id": 90,
        "name": "Name",
        "price": 100.29,
        "type": 2,
        "items": []
    }
}

PUT '/list/{listId}/client/{clientId}/sales/{saleId}'

{
    "name": "Name 2",
    "price": 100,
    "type": 3
}

edit sale:

{
    "status": "ok",
    "data": {
        "id": 90,
        "name": "Name 2",
        "price": 100,
        "type": 3,
        "items": []
    }
}

DELETE '/list/{listId}/client/{clientId}/sales/{saleId}'

delete sale:

{
    "status": "ok"
}

POST '/list/{listId}/client/{clientId}/sale/{saleId}/details'

{
    "text": "Test 123"
}
or
file in a parameter POST 'file'

adding details to a sale:

{
    "status": "ok",
    "data": {
        "id": 1,
        "text": "Test 123",
        "doneAt": null,
        "doneByUser": null,
        "file": null
    }
}

or

{
    "status": "ok",
    "data": {
        "id": 1,
        "text": null,
        "doneAt": null,
        "doneByUser": null,
        "file": {
            "id": 126,
            "fileName": "test (2).pdf",
            "size": 418012,
            "createdAt": {
                "date": "2016-05-31 09:47:28",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            }
        }
    }
}

DELETE '/list/{listId}/client/{clientId}/sale/{saleId}/details/{detailId}'

deleteing detail:

{
    "status": "ok"
}

PUT '/list/{listId}/client/{clientId}/sale/{saleId}/details/{detailId}/toggleCheck'

mark or unmark detail as completed:

{
    "status": "ok",
    "data": {
        "id": 204,
        "text": "Test 123",
        "doneAt": {
            "date": "2016-05-31 09:51:19",
            "timezone_type": 3,
            "timezone": "Europe/Berlin"
        },
        "doneByUser": {
            "id": 1,
            "name": "Administrator",
            "avatar": ""
        },
        "file": null
    }
}

Clone this wiki locally