Facturen

Authenticatie vereist

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

Laatste update: 29-06-2016

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Invoices.read
POST Collectie Invoices.write
GET Element Invoices.read
POST Element Invoices.write
DELETE Element Invoices.write
Speciale acties
GET Action get layouts Invoices.read
GET Action get send email Invoices.send
POST Action post send email Invoices.send
POST Action post generate invoice code Invoices.write

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de factuur. Ja Nee Nee
code   Ja Nee Nee
code_generated   Ja Nee Nee
hash   Ja Nee Nee
name   Ja Ja Nee
description   Ja Ja Nee
contact_id Id van de relatie. Moet type 1 of 3 zijn. Ja Ja Ja
contact_attention   Ja Ja Nee
project_id   Ja Ja Nee
order_id   Ja Ja Nee
status De status van de factuur standaard 1 Ja Ja Nee
total_price De totaalprijs van de factuur. Wordt berekend op basis van de factuurregels. Ja Nee Nee
total_price_vat   Ja Nee Nee
discount De korting in procenten Ja Ja Nee
date_sent   Ja Ja Nee
date_payed   Ja Ja Nee
layout Bij het aanmaken kan met dit veld een speciale layout worden gekozen. Ja Ja Nee
vat_shift   Ja Ja Nee
modified   Ja Nee Nee
created   Ja Nee Nee

Collectie GET

GET Collectie

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

https://api.workspace.nl/api/v1/invoices.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 1,
            "Invoices": [
                {
                    "Invoice": {
                        "id": "270",
                        "code": "2013-0001",
                        "code_generated": "2013-02-19",
                        "hash": "PtwZaQmcjAKmia4uB4sv",
                        "name": "Schilderen pand",
                        "description": "",
                        "contact_id": "521",
                        "contact_attention": "",
                        "project_id": "65",
                        "status": "1",
                        "total_price": "11370000",
                        "total_price_vat": "2387700",
                        "discount": null,
                        "date_sent": null,
                        "date_payed": null,
                        "vat_shift": false,
                        "modified": "2015-04-16 10:18:45",
                        "created": "2013-02-19 14:31:36",
                        "total_price_incl": "13757700",
                        "total_price_discount": null,
                        "display_name": "Schilderen pand",
                        "display_code": "2013-0001"
                    },
                    "Contact": {
                        "id": "521",
                        "type": "1",
                        "name": "123 Test"
                    },
                    "InvoiceLine": [],
                    "InvoicePayment": []
                }
            ]
        }
    }
}

Mogelijke filter parameters

Veld Parameter Type Beschrijving
date_sent date_sent_from Datum De vanafdatum om te sorteren
date_sent date_sent_to Datum De einddatum om te sorteren
date_reminder date_reminder_from Datum De vanafdatum om te sorteren
date_reminder date_reminder_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
name name LIKE %{name}% Matchen op karakterbasis zowel links als rechts van het veld
description description LIKE %{description}% Matchen op karakterbasis zowel links als rechts van het veld
code code LIKE %{code}% Matchen op karakterbasis zowel links als rechts van het veld

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Invoices not found.

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/invoices.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 factuur.

https://api.workspace.nl/api/v1/invoices/{id}.json
Parameters
{id} Het indentificatie nummer van de factuur in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Invoice": {
                "id": "270",
                "code": "2013-0001",
                "code_generated": "2013-02-19",
                "hash": "PtwZaQmcjAKmia4uB4sv",
                "name": "Schilderen pand",
                "description": "..",
                "contact_id": "521",
                "contact_attention": "",
                "project_id": "65",
                "status": "1",
                "total_price": "11370000",
                "total_price_vat": "2387700",
                "discount": null,
                "date_sent": null,
                "date_payed": null,
                "vat_shift": false,
                "modified": "2015-04-16 10:18:45",
                "created": "2013-02-19 14:31:36",
                "total_price_incl": "13757700",
                "total_price_discount": null,
                "display_name": "Schilderen pand",
                "display_code": "2013-0001"
            },
            "Contact": {
                "id": "521",
                "type": "1",
                "name": "123 Test"
            },
            "InvoiceLine": [],
            "InvoicePayment": []
        }
    }
}

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

Mogelijke fout meldingen Errors

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

Actions Overview

GET Resource

Een GET request op de resource zal resulteren in een overzicht van de beschikbare opties.

https://api.workspace.nl/api/v1/invoices/actions.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "",
        "exception": [],
        "code": 200,
        "data": {
            "Supported actions": {
                "\/invoices\/actions\/generate_invoice_code.json": "POST",
                "\/invoices\/actions\/send_email\/{id}.json": [
                    "GET",
                    "POST"
                ]
            }
        }
    }
}

ACTION GET Layouts

GET

Een GET request op deze actie zal resulteren in een overzicht van de beschikbare factuur layouts.

https://api.workspace.nl/api/v1/invoices/layouts.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": [
            "Standaard template",
            "Layout zonder logo",
            "Layout tweede vestiging"
        ]
    }
}

ACTION GET Send Email

GET

Een GET request op deze actie zal resulteren in een overzicht van de email template.

https://api.workspace.nl/api/v1/invoices/actions/send_email.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Template": {
                "email_to": "info@test.nl",
                "sender_name": "ABC Schilders B.V.",
                "subject": "Factuur 2013-0001",
                "mail_layout": "",
                "sender_email": "Jan de Klaassen",
                "sender_email_bcc": 0
            }
        }
    }
}

ACTION POST Send Email

POST

Een POST request op de actie zal resulteren in versturen van een email.

https://api.workspace.nl/api/v1/invoices/actions/send_email.json

Benodigde Velden

Veld
message
address
sender_name
sender_email
sender_bcc
subject

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 400 Bad Request Not all required fields are provided.

ACTION POST Generate Invoice Code

POST

Een POST request op de actie zal resulteren in genereren van een factuur code.

https://api.workspace.nl/api/v1/invoices/actions/generate_invoice_code.json

Benodigde Velden

Veld
invoice_id

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 400 Bad Request Not all required fields are provided.