Inkoopfacturen

Authenticatie vereist

Met deze resource kunnen inkoopfacturen van u opgehaald en aangemaakt worden.

Resource mogelijkheden

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

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de inkoopfactuur. Ja Nee Nee
contact_id   Ja Ja Ja
project_id   Ja Ja Nee
code   Ja Ja Ja
name   Ja Ja Ja
status
  1. 1 Openstaand
  2. 2 Betaald
  3. 3 Geannuleerd
 Ja Ja Nee
currency Standaard waarde: EUR Ja Ja Nee
currency_rate   Ja Ja Nee
date_purchase   Ja Ja Nee
date_due   Ja Ja Nee
date_payed   Ja Ja Nee
created   Ja Nee Nee
modified   Ja Nee Nee
total_price   Ja Nee Nee
total_price_vat   Ja Nee Nee

Collectie GET

GET Collectie

Een GET request op de collectie zal resulteren in een volledige lijst van uw inkoopfacturen.

https://api.workspace.nl/api/v1/purchases.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 2,
            "Purchases": [
                {
                    "Purchase": {
                        "id": "87",
                        "contact_id": "517",
                        "project_id": "65",
                        "code": "389428",
                        "name": "Inkoop verf",
                        "status": "2",
                        "currency": "EUR",
                        "currency_rate": "1",
                        "date_purchase": "2013-02-19",
                        "date_due": "2013-02-28",
                        "date_payed": "2013-09-23",
                        "created": "2013-02-19 14:40:47",
                        "modified": "2013-09-23 09:40:26",
                        "total_price": "8750000",
                        "total_price_vat": "1837500"
                    },
                    "Contact": [],
                    "PurchaseLine": [],
                    "PurchaseUpload": [],
                    "PurchasePayment": [],
                    "Project": []
                },
                {
                    "Purchase": {
                        "id": "88",
                        "contact_id": "517",
                        "project_id": "65",
                        "code": "389429",
                        "name": "Inkoop verf",
                        "status": "2",
                        "currency": "EUR",
                        "currency_rate": "1",
                        "date_purchase": "2013-02-19",
                        "date_due": "2013-02-28",
                        "date_payed": "2013-09-23",
                        "created": "2013-02-19 14:40:47",
                        "modified": "2013-09-23 09:40:26",
                        "total_price": "8750000",
                        "total_price_vat": "1837500"
                    },
                    "Contact": [],
                    "PurchaseLine": [],
                    "PurchaseUpload": [],
                    "PurchasePayment": [],
                    "Project": []
                }
            ]
        }
    }
}

Mogelijke filter parameters

Veld Parameter Type Beschrijving
date_purchase date_purchase_from Datum De vanafdatum om te sorteren
date_purchase date_purchase_to Datum De einddatum om te sorteren
date_due date_due_from Datum De vanafdatum om te sorteren
date_due date_due_to Datum De einddatum om te sorteren
date_payed date_payed_from Datum De vanafdatum om te sorteren
date_payed date_payed_to Datum De einddatum om te sorteren
code code LIKE %{code}% Matchen op karakterbasis zowel links als rechts van het veld
name name LIKE %{name}% Matchen op karakterbasis zowel links als rechts van het veld

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/purchases.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 inkoopfactuur.

https://api.workspace.nl/api/v1/purchases/{id}.json
Parameters
{id} Het indentificatie nummer van de inkoopfactuur in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Purchase": {
                "id": "87",
                "contact_id": "517",
                "project_id": "65",
                "code": "389428",
                "name": "Inkoop verf",
                "status": "2",
                "currency": "EUR",
                "currency_rate": "1",
                "date_purchase": "2013-02-19",
                "date_due": "2013-02-28",
                "date_payed": "2013-09-23",
                "created": "2013-02-19 14:40:47",
                "modified": "2013-09-23 09:40:26",
                "total_price": "8750000",
                "total_price_vat": "1837500",
                "accountant_processed": false
            },
            "Contact": [],
            "PurchaseLine": [],
            "PurchaseUpload": [],
            "PurchasePayment": []
        }
    }
}

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/purchases/{id}.json
Parameters
{id} Het indentificatie nummer van de inkoopfactuur 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 Purchase 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/purchases/{id}.json
Parameters
{id} Het indentificatie nummer van de inkoopfactuur in formaat (0-9)

Mogelijke fout meldingen Errors

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