API - Projecten : SimplyBooks Support

Items uit het domein “projects” stellen een project voor.

Opbouw URL’s:

/api/v1/projects: Projecten

/api/v1/projects/707: Project met ID 707

/api/v1/projects/707/tasks: Taken van project met ID 707

/api/v1/projects/707/tasks/808: Taak met ID 808 binnen project met ID 707

/api/v1/projects/707/tasks/808/items: Items (tijdsregistraties en kosten) van taak met ID 808

/api/v1/projects/707/tasks/808/items/909: Item met ID 909 binnen taak met ID 808

Domein: projects

Veldnaam

Type

Omschrijving

Voorbeeld

project_id

int

Unieke ID van het Project. Gegenereerd door het systeem. Steeds verplicht op te geven in URL (behalve bij creatie).

707

uri

text

URL naar Project. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.

external_project_id

int

(Unieke) ID van het project dat kan worden ingesteld door een externe partij. Maximum 50 karakters lang. Uniekheid van de waarde wordt niet afgedwongen.

ID123

user_id

int

Unieke ID van het project. Verplicht op te geven bij creatie.

user_name

text

Naam van de gebruiker die de aanpassing heeft doorgevoerd. Indien de naam niet beschikbaar wordt het e-mail adres teruggegeven.

John Doe

client_id

int

Unieke ID van de klant. Verplicht op te geven bij creatie.

101

client_uri

text

URL naar de klant. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.

client_name

text

Naam van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.

Company X

client_attention

text

T.a.v. van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.

Paul

billing_address

Address

Facturatieadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.

delivery_address

Address

Verzendadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.

site_address

Address

Werfadres van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven.

number

text

Klantennummer. Niet verplicht, maximum 55 karakters lang. Wordt automatisch gegenereerd indien niet opgegeven bij creatie en indien deze optie geactiveerd werd in de Instellingen.

P000001

name

text

Naam van de klant. Verplicht mee te geven bij creatie. Maximum 75 karakters lang.

Consultancy

start_date

text

Startdatum van het project

2023-12-01

end_date

text

Einddatum van het project

2024-05-31

state

text

Status van het project

open

billable_type

text

Tarief keuze voor het project

hourly

billable_rate

float

Het bedrag dat je klanten in rekening brengt

billable_estimate

float

De schatting van de tijd voor een project

250

billable_current

float

Huidig gepresteerde tijd van het project

total

float

Totaal van billable_estimate & billable_current

480

total_estimate

float

Totaal van geschatte tijd van het project

fixed_break

float

De vaste pauze van het project

0.5

use_tasks

text

Worden er taken gebruikt

yes

tasks

list

Een lijst van taken

last_activity

datetime

Datum van laatste wijziging in het project

2023-11-30 14:34:34

Subdomein: tasks ( < projects)

Veldnaam	Type	Omschrijving	Voorbeeld
task_id	int	Unieke ID van de taak. Gegenereerd door het systeem.	808
uri	text	URL naar de taak. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.	-
description	text	Omschrijving van de taak	Task 1
description_html	text	Omschrijving met de html code van de taak	<p>Task 1</p>
state	text	Status van de taak	open
items	list	Lijst met de voltooien opdrachten in de taak	-

Subdomein: items ( < tasks < projects)

Veldnaam	Type	Omschrijving	Voorbeeld
item_id	int	Unieke ID van de item. Gegenereerd door het systeem.	909
uri	text	URL naar de item. Gegenereerd door het systeem. Te gebruiken bij aanspreken klant langs de API.	-
type	text	Type item	time
description	text	Omschrijving van de type item	Hours worked
description_html	text	Omschrijving met de html van de type item	<p>Hours worked</p>
date	date	Datum van de item	2024-01-03
start_time	text	Start tijd van de item	09:00
end_time	text	Eind tijd van de item	12:00
fixed_break	float	De vaste pauze van het item	0.5
quantity	float	Hoeveelheid van de item	3
unit	text	Eenheid van de item
price	float	Prijs van de item	60
price_total	float	Totaalprijs van de item	180
state	text	status van de item	open

Voorbeeld in JSON van een project:

{
  "project_id": 707,
  "uri": "https://eenvoudigfactureren.be/api/v1/projects/707",
  "external_project_id": "",
  "user_id": 1,
  "user_name": "John Doe",
  "client_id": 101,
  "client_uri": "https://eenvoudigfactureren.be/api/v1/clients/101",
  "client_name": "Company X",
  "client_attention": "",
  "billing_address": {
    "street": "Street 1",
    "street2": "",
    "postal_code": "1000",
    "city": "Brussels",
    "country_code": "BE",
    "country": "België"
  },
  "delivery_address": null,
  "site_address": null,
  "number": "P000001",
  "name": "Consultancy",
  "start_date": "2023-12-01",
  "end_date": "2024-05-31",
  "state": "open",
  "billable_hourly_rate": 60,
  "billable_hours_estimate": 250,
  "billable_hours_current": 3,
  "total": 480,
  "total_estimate": 0,
  "use_tasks": "yes",
  "tasks": [
    {
      "task_id": 808,
      "uri": "https://eenvoudigfactureren.be/api/v1/projects/707/tasks/808",
      "description": "Taak 1",
      "description_html": "Taak 1",
      "state": "open",
      "items": [
        {
          "item_id": 909,
          "uri": "https://eenvoudigfactureren.be/api/v1/projects/707/tasks/808/items/909",
          "type": "time",
          "description": "Uren",
          "description_html": "Uren",
          "date": "2024-01-03",
          "start_time": "09:00",
          "end_time": "12:00",
          "quantity": 3,
          "unit": "",
          "price": 60,
          "price_total": 180,
          "state": "open"
        },
        {
          "item_id": 910,
          "uri": "https://eenvoudigfactureren.be/api/v1/projects/707/tasks/808/items/910",
          "type": "cost",
          "description": "Kosten",
          "description_html": "Kosten",
          "date": "2024-01-01",
          "start_time": "",
          "end_time": "",
          "quantity": 1,
          "unit": "",
          "price": 300,
          "price_total": 300,
          "state": "open"
        }
      ]
    }
  ],
  "last_activity": "2023-11-30 14:34:34"
}