API v1 (Timesheet Pro)

Inhoudsopgave

Datavelden
    - customer
    - project
    - product
    - user
    - administration
    - ledger
    - invoice

Datavelden

Er zijn per soort invoer, verschillende datavelden. Hier staan alle velden op een rijtje, inclusief waar je ze voor kunt gebruiken en een korte omschrijving.

customer

Algemene machtigingen: create, read, update

Veldnaam Datatype CRUD Omschrijving
id integer CR Unieke id
name string CRU (Bedrijfs)naam
street string CRU Straatnaam
street_number string CRU Huisnummer
postal_code string CRU Postcode
city string CRU Plaats/stad
country string CRU Landcode
telephone string CRU Telefoonnummer
fax string CRU Faxnummer
iban string CRU IBAN-nummer
iban_name string CRU Tenaamstelling IBAN-nummer
bank string CRU Bankrekening
contact string CRU Primair contactpersoon
email string CRU E-mailadres
btw string CRU Btw-nummer
kvk string CRU KvK-nummer
mobile string CRU Mobiel telefoonnummer
note string CRU Notities bij klant
status integer CRU Primaire status van relatie. 1: Lead, 2: Prospect, 3: Debiteur, 4: Crediteur
owner_user_id integer CRU Klanteigenaar (foreign key)
email_administrative string CRU Administratief e-mailadres (bijvoorbeeld voor facturen)
custom_payment_term integer CRU Klantspecifieke betaaltermijn voor verkoopfacturen in dagen
trash integer CRU Is de klant verwijderd of niet?

project

Algemene machtigingen: create, read, update

Veldnaam Datatype CRUD Omschrijving
id integer CR Unieke id
customer_id integer CRU Customer id, foreign key
number string CRU Projectnummer
name string CRU Naam/titel
description string CRU Omschrijving
startDate integer (UNIX timestamp) CRU Startdatum project
endDate integer (UNIX timestamp) CRU Einddatum project
projectWorth float CRU Projectwaarde (fixed price)
maxHours float CRU Maximum aantal begrote uren
realHours float CRU Aantal gewerkte uren
wbso bool (1/0) CRU WBSO project
comments string CRU Overige opmerkingen
finished bool (1/0) CRU Project voltooid (1) of lopend (0)
projectleader int CRU User id projectleider, foreign key
nonProject bool (1/0) CRU Project (0) of dossier (1)

product

Algemene machtigingen: create, read, update

Veldnaam Datatype CRUD Omschrijving
id integer CR Unieke id
title string CRU Productnaam
description string CRU Omschrijving
product_type string CRU Twee mogelijkheden: "dienst", "product"
code string CRU Artikelcode
price_purchase float CRU Inkoopprijs
price float CRU Verkoopprijs (excl. btw)
vat float CRU BTW-percentage
note string CRU Notities (intern)
stock int CRU Aantal stuks op voorraad
ean string CRU EAN-code

 

user

Algemene machtigingen: create, read, update

Veldnaam Datatype CRUD Omschrijving
id integer CR Unieke id
first_name string CRU Voornaam
insertion string CRU Tussenvoegsel
last_name string CRU Achternaam
street string CRU Straatnaam
number string CRU Huisnummer
zipcode string CRU Postcode
city string CRU Plaats/stad
country string CRU Landcode
telephone string CRU Telefoonnummer
mobile string CRU Mobiel telefoonnummer
iban string CRU IBAN-nummer
bic string CRU BIC-code
email string CRU E-mailadres
authlevel integer CRU 0 = medewerker, 1 = projectleider, 2 = manager, 3 = beheerder
user_status string CRU Drie mogelijke statussen: "actief", "non-actief", "uit dienst"

 

administration

Algemene machtigingen: read

Het is niet mogelijk om administraties aan te maken of te wijzigen. Dit moet te allen tijde binnen Timesheet Pro gebeuren.

Veldnaam Datatype CRUD Omschrijving
id integer R Unieke id
name string R Handelsnaam
is_default boolean R Is het de standaard handelsnaam?
street string R Straatnaam
street_number string R Huisnummer
postcode string R Postcode
city string R Stad/plaats
country string R Land (voluit geschreven)
telephone string R Telefoonnummer
fax string R Faxnummer
coc_number string R KvK-nummer
vat_number string R Btw-nummer
iban string R IBAN-nummer
iban_bic string R BIC-nummer
g_account string R G-rekening (IBAN)
g_account_name string R Tenaamstelling G-rekening
g_account_bic string R BIC-nummer bij G-rekening
logo string R Het logo van de handelsnaam (bestand)
logo_mime string R Het MIME-type van het logo
colour string R Hexadecimale kleurcode voor de huisstijl
website string R Websiteadres
email string R E-mailadres

ledger

Algemene machtigingen: read

Het is niet mogelijk om ledgers (grootboekrekeningen) aan te maken of te wijzigen. Dit moet te allen tijde binnen Timesheet Pro gebeuren.

Veldnaam Datatype CRUD Omschrijving
id integer R Unieke id
number integer R Grootboekrekeningnummer
description string R Omschrijving van de GBR
category string R "WV": Winst & Verlies, "BAL": Balans, "OB": Omzetbelasting
trash boolean (tinyint) R Verwijderd ja/nee

invoice

Algemene machtigingen: create, read, update

Let op: de facturen zijn multidimensionale arrays, de producten worden namelijk direct meegegeven. Bij de facturen horen daarom twee tabellen met datavelden. Uiteraard is het ook uit te lezen als een object.

Tevens is het belangrijk om te weten dat het systeem zélf een factuurnummer maakt voor de nieuwe facturen. Bij het aanmaken van een factuur wordt dus niets gedaan met de velden "invoice_prefix" en "invoice_number". Ook is het niet mogelijk om een factuur in het verleden aan te maken.

Veldnaam Datatype CRUD Omschrijving
id integer R Unieke id
invoice_prefix string R Voorvoegsel factuurnummer
invoice_number string R Het daadwerkelijke factuurnummer
reverse_charge boolean (tinyint) CRU BTW-verlegd ja/nee
note string CRU Notitie op de factuur
address_self string CRU Eigen adres (HTML-opmaak)
address_customer string CRU Adres van klant (HTML-opmaak)
customer_id int CRU Het id van de customer, foreign key
concept boolean (tinyint) CRU Conceptfactuur ja/nee
reminders string CRU Lijst met alle keren dat een herinnering per e-mail is verstuurd
administration_id int CRU De id van de handelsnaam (administration) van waaruit de factuur verstuurd moet worden
paid_date date (yyyy-mm-dd) CRU Datum betaald
payment_before_date date (yyyy-mm-dd) CRU Uiterste betaaldatum
planned_date date (yyyy-mm-dd) CRU Geplande verzending
sent_date date (yyyy-mm-dd) CRU Factuurdatum (datum verzending)
language string CRU Taal: "nl" of "en"
products array/object CRU Array met producten, zie volgende tabel


Reacties

Er zijn nog geen reacties.
 Meld je aan met LinkedIn om te reageren