Offerteregels

Authenticatie vereist

Met deze resource is het mogelijk offerteregels voor offertes te beheren

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
POST Collectie Quotations.write
GET Element Quotations.read
POST Element Quotations.write
DELETE Element Quotations.write

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de offerteregel. Ja Nee Nee
name   Ja Ja Ja
price Standaard waarde: 0 Ja Ja Nee
quotation_id Een geldig en bestaand offerte id. Ja Ja Ja
article_id   Ja Ja Nee
amount Standaard waarde: 1 Ja Ja Nee
reference   Ja Ja Nee
tax_rate_id   Ja Ja Ja
discount   Ja Ja Nee
unit_type Standaard waarde: STK Ja Ja Nee
sort   Ja Nee Nee

Collectie POST

POST Collectie

Een POST request op de collectie zal resulteren in het aanmaken van een nieuw element.

https://api.workspace.nl/api/v1/quotationlines.json

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkele offerteregel.

https://api.workspace.nl/api/v1/quotationslines/{id}.json
Parameters
{id} Het indentificatie nummer van de offerteregel in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "QuotationLine": {
                "id": "22550",
                "name": "test Regel",
                "price": "0",
                "quotation_id": "53",
                "amount": "1",
                "reference": null,
                "tax_rate_id": "4870",
                "unit_type": "STK",
                "sort": "0"
            },
            "TaxRate": {
                "id": "4870",
                "percentage": "21",
                "display": true,
                "name": "21% BTW",
                "type": "invoice",
                "sort": "1"
            }
        }
    }
}

ELEMENT POST

POST Element

Een POST request op het element zal resulteren in het aanpassen van het element. Alleen specifieke velden zijn aanpasbaar.

https://api.workspace.nl/api/v1/quotationlines/{id}.json
Parameters
{id} Het indentificatie nummer van de offerteregel in formaat (0-9)

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.
POST 404 Not Found Quotationline not found.

ELEMENT DELETE

DELETE Element

Een DELETE request op het element zal resulteren in het verwijderen van het element.

https://api.workspace.nl/api/v1/quotationlines/{id}.json
Parameters
{id} Het indentificatie nummer van de offerteregel in formaat (0-9)

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 404 Not Found Quotationline not found.