Webling API

API Information ¶

This API lets you interact with your Webling Database.

The API is available at the following URL:

https://<yourdomain>.webling.ch/api/1/

See the Examples section on how to use the API.

Authentication ¶

The authentication is done by passing an API-Key. As an Administrator you can generate your API-Key in the Web App (Administration > API).

To authenticate, add the apikey parameter (/api/1/member?apikey=<your_api_key>) or add an apikey header (apikey: <your_api_key>) to every request.

Response format ¶

Response body is in JSON format (except images/files). There are different JSON structures that are being used by the API:

Objects ¶

All objects have the following basic structure:

{
    "type": "objecttype",
    "meta": { 
        "created" => "2018-04-06 01:20:04",
        "lastmodified" => "2017-05-23 11:43:54"
    },
    "readonly": false,
    "properties": {},
    "children": {},
    "parents": [],
    "links": {}
}

These are the properties you find in the basic object structure:

Property datatypes ¶

Every property in properties has a datatype, which is one of the following:

Metadata of a file:

{
    "href": text, // absolute path to the file data
    "size": int, // size of the file in bytes
    "ext": text, // file extension
    "mime": text, // mime type 
    "timestamp": timestamp // creation date
}

Metadata of an image:

{
    "href": text, // absolute path to the image data
    "size": int, // size of the image in bytes
    "ext": text, // file extension
    "mime": text, // mime type 
    "timestamp": timestamp, // creation date
    "dimensions": {
        "width": int, // width in pixels
        "height": int // height in pixels
    }
}

Metadata of a binary:

{
    "href": text, // absolute path to the file data
    "size": int, // size of the file in bytes
    "name": text, // filename
    "lastmodified": timestamp, // last modified date
    "hrefthumb": string // link to the preview, if the file has a preview (only if it's an image)
}

Lists ¶

Lists contain object IDs (e.g: a list of member IDs):

{
    "objects": [12,23,34,45]
}

Files ¶

Files, images or binaries are returned as binary data with the appropriate content-type (e.g. image/png, application/xyz)

Errors ¶

Errors have the following structure:

{
    "error": "Error message"
}

Response Status Codes ¶

If possible, HTTP Response Status Codes are used:

• 200 OK: Request successful

• 201 Created: Resource has been created

• 204 No Content: The request was successful, no content is returned

• 304 Not Modified: The content has not changed

• 400 Bad Request: Invalid parameter passed

• 401 Unauthorized: Authentication failed

• 403 Forbidden: No permission to perform the request

• 404 Not Found: The resource was not found

• 413 Request Entity Too Large: try to split your request into multiple requests

• 425 Quota Exceeded: The limit of your Webling subscription was reached

• 429 Too many requests: your host has sent too many requests and has been blocked for a short period

• 500 Server Error: An internal server error occurred

• 501 Not Implemented: This call is not yet implemented

• 503 Service Unavailable: The server can not handle the request, e.g a deadlock occurred

Rate Limit ¶

The API currently enforces a rate limit of 500 requests per minute. If you hit the rate limit, you will get an HTTP 429 Error. You can fetch multiple objects in one call if you get the error code 429. The rate limit may be lowered in the future. Applications should be designed to not send more than 50 requests per minute. You can use caching to reduce the number of requests.

See the section Track Changes / Replicate for more information about how to detect changed data and only update these objects to reduce requests.

Fetch Multiple Objects ¶

There are two ways to fetch multiple objects with one request:

Option 1: multiple IDs in the url ¶

You can request multiple objects with one call (multiget). To do so, concatenate all IDs with a comma:

/api/1/member/536,525,506,535

This also works for DELETE Requests.

Option 2: fetch data instead of IDs ¶

When loading lists like /member or /membergroup by default you get object IDs only. This is due to the fact that large stores will take a while to return all object data.

If you are dealing with a lot of data, using a caching mechanism is really recommended. See Replicate.

You can fetch full data, instead of the IDs only, by appending the format=full parameter.

Example:

/api/1/member?format=full

This will return all member objects (with full data).

You can also combine this with other parameters like filter to only load certain members:

/api/1/member?format=full&filter=$parents.$id=552

This will return all members which are in the membergroup with the id 552.

Pagination ¶

You can limit the number of results with the pagination parameters:

/api/1/member?page=1&per_page=100
/api/1/member?format=full&page=4&per_page=10

• page: page number, starting with 1 for the first page

• per_page: number of results per page

Query Language ¶

All GET endpoints, which return a list of object IDs, can be filtered using the following query language. A query is passed by the filter= parameter.

Example:

https://demo.webling.ch/api/1/member?filter=`Vorname` = "Hans"&apikey=__YOUR_API_KEY__

Explanation of the query language syntax:

Special Properties ¶

There are some special properties you can use beside the normal properties:

The backtick is not required for these special properties.

Operators ¶

You can use the following comparison operators:

Functions ¶

The following functions are available:

Sort the results ¶

The results can be sorted by the order parameter, using the following pattern:

?order=`Vorname` ASC
?order=`Vorname` DESC, `Nachname` ASC

Special properties are also allowed:

?order=$label ASC 
?order=$parents.title DESC
?order=DAY(`Geburtstag`) DESC

Query Examples ¶

To filter for members, use the filter argument in the URL like this:

https://demo.webling.ch/api/1/member?filter=`Vorname` = "Hans" OR `Name` = "Weber"&apikey=__YOUR_API_KEY__

Get all members in a specific membergroup (id = 555) and sort them by “Vorname”:

member?filter=$parents.$id = 555&order=`Vorname` ASC

You can nest AND and OR conditions and use parentheses:

member?filter=`Vorname` = "Peter" OR (`Vorname` = "Hans" AND `Name` = "Meier" OR (`PLZ` > 100 AND `PLZ` <= 4000))

Get all members that are in one of the membergroups 100, 101 or 102:

member?filter=$parents.$id = 100 OR $parents.$id = 101 OR $parents.$id = 102
member?filter=$parents.$id IN (100, 101, 102)

Get all members that are in a membergroup with the title “Vorstand”:

member?filter=$parents.title = "Vorstand"

Get all members that are not in the membergroup with the id 100:

member?filter=NOT($parents.$id = 100)

Use IN to search for multiple values:

member?filter=`ID` IN (22, 45, 67)
member?filter=`Status` IN ("Aktiv", "Passiv", "Ehrenmitglied")
member?filter=$parents.$id IN (520, 612, 802, 1023)
member?filter=NOT($parents.$id IN (438, 748, 893))

Get all members, where the field “E-Mail” equals the field “E-Mail Geschäft”:

member?filter=`E-Mail` = `E-Mail Geschäft`

Get all members with an empty E-Mail field:

member?filter=`E-Mail` IS EMPTY

Get all members where the E-Mail field is not empty:

member?filter=NOT(`E-Mail` IS EMPTY)
member?filter=NOT `E-Mail` IS EMPTY

Filter by Age (years):

member?filter=AGE(`Geburtstag`) = 22
member?filter=AGE(`Eintrittsdatum`) > 5

Use of the UPPER function to match case-insensitive:

member?filter=UPPER(`Name`) = "MEIER"

Find all members with birthday in August:

member?filter=MONTH(`Geburtstag`) = 8

You can also sort the results by day:

member?filter=MONTH(`Geburtstag`) = 8&sort=DAY(`Geburtstag`) ASC

Find all members with birthday after August 20th:

member?filter=MONTH(`Geburtstag`) > 8 OR (MONTH(`Geburtstag`) = 8 AND DAY(`Geburtstag`) > 20)

Search for dates relative to today (all future dates):

member?filter=`Eintrittsdatum` > TODAY()

Comparing dates:

member?filter=`Eintrittsdatum` <= "2018-06-23"
member?filter=`Eintrittsdatum` = "2018-03-06"

Use of multienum operators:

member?filter=`Mehrfachauswahlfeld` IS ["Wert"]
member?filter=`Mehrfachauswahlfeld` CONTAINS ALL OF ["Wert", "Wert 1"]
member?filter=`Mehrfachauswahlfeld` CONTAINS NONE OF ["Wert 1", "Wert 2"]
member?filter=`Mehrfachauswahlfeld` CONTAINS ANY OF ["Wert 2"]

Get the member that is linked to the debitor with the id 851:

member?filter=$links.debitor.$id=851

Get all members with open debitors:

member?filter=$links.debitor.state="open"

Get all members with a debitor of amount 100:

member?filter=$links.debitor.$links.revenue.amount = 100

Find all members with comments:

member?filter=$links.comment.$id > 0

Combine $links and $children to find all entrygroups that have links to a debitor with the $label “Meier”:

entrygroup?filter=$children.entry.$links.debitor.$links.member.$label filter "Meier"

Get all membergroups that have members with a PLZ over 9000:

membergroup?filter=$children.member.PLZ > 9000

Search in group and subgroups of membergroup 550:

member?filter=`Vorname` = "Tim" AND $ancestors.$id = 550

Get all members you have write access to:

member?filter=$writable=true

WITH() operator ¶

Using multiple filters in linked objects may lead to unexpected results, since the conditions are executed separately.

member?filter=$links.debitor.totalamount > 100 AND $links.debitor.remainingamount > 0

Will give you all members that have a debitor with totalamount > 100 and a different debitor with remainingamount > 0.
If you want to filter by multiple properties of a linked object, use the WITH operator:

member?filter=WITH $links.debitor (totalamount > 100 AND remainingamount > 0)

This will find members with a debitor over 100, which are not yet paid in full.

Don’t forget to encode the URL if you are using special chars in your query.

EBNF ¶

If you want to dig deeper, this is the formal definition of the query language:

start                   ::= orExpr

orExpr                  ::= andExpr "OR" orExpr
andExpr                 ::= notExpr "AND" orExpr
notExpr                 ::= "NOT"? withExpr
withExpr                ::= ( "WITH" axisExpr ( "." axisExpr )* )? bracketExpr
bracketExpr             ::= ( "(" orExpr ")" ) | atomExpr

atomExpr                ::= comparisonExpr | filterComparisonExpr | containsComparisonExpr | multienumComparisonExpr | emptyExpr | setExpr
comparisonExpr          ::= contentExpr universalOpExpr contentExpr
filterComparisonExpr    ::= contentExpr "FILTER" valueExpr
containsComparisonExpr  ::= contentExpr "CONTAINS" stringExpr
multienumComparisonExpr ::= contentExpr multienumOpExpr jsonStringArrayExpr
emptyExpr               ::= contentExpr "IS" "EMPTY"
setExpr                 ::= contentExpr "IN" "(" valueExpr ("," valueExpr)* ")"

universalOpExpr         ::= "<" | "<=" | ">" | ">=" | "=" | "!="
multienumOpExpr         ::= "CONTAINS ALL OF" | "IS" | "CONTAINS NONE OF" | "CONTAINS ANY OF"

contentExpr             ::= valueExpr | jsonPathExpr | callExpr | pathExpr
valueExpr               ::= stringExpr | numberExpr | boolExpr
callExpr                ::= literalExpr "(" (contentExpr ("," contentExpr)* )? ")"
pathExpr                ::= propertiesExpr | accessExpr | labelExpr | idExpr | ( axisExpr "." pathExpr )
propertiesExpr          ::= "*" | ( propertyExpr ("," propertyExpr)* )
propertyExpr            ::= literalExpr | backtickExpr
jsonPathExpr            ::= "JSON" ( pathExpr ) ( "[" ( stringExpr | intExpr ) "]" )*
axisExpr                ::= parentExpr | ancestorExpr | childExpr | linkExpr | reverseLinkExpr
parentExpr              ::= "$parents"
ancestorExpr            ::= "$ancestors"
childExpr               ::= "$children" "." literalExpr
linkExpr                ::= "$links" "." literalExpr
reverseLinkExpr         ::= "$reverselinks" "." literalExpr ( "{" literalExpr "}" )? "." pathExpr
axisExpr                ::= parentExpr | ancestorExpr | childExpr | linkExpr | reverseLinkExpr
parentExpr              ::= "$parents"
ancestorExpr            ::= "$ancestors"
childExpr               ::= "$children" "." literalExpr
linkExpr                ::= "$links" "." literalExpr
reverseLinkExpr         ::= "$reverselinks" "." literalExpr

accessExpr              ::= "$readonly" | "$writable"
labelExpr               ::= "$label"
idExpr                  ::= "$id"

stringExpr              ::= ("'" /[^"]* / "'") | ('"' /[^']* / '"')
backtickExpr            ::= "`" /[^`]* / "`"
literalExpr             ::= /\w* /
boolExpr                ::= "TRUE" | "FALSE"
intExpr                 ::= "-"? /\d+/
numberExpr              ::= "-"? /\d+/ ( "." /\d* / )?
jsonStringArrayExpr     ::= "[" stringExpr ( "," stringExpr )* "]"

Examples ¶

Some simple examples how to use the API.

More examples can be found on our GitHub page: github.com/usystems/webling-api-examples

PHP ¶

This is a simple example to get the title of a Membergroup in PHP:

$apiurl = "https://demo.webling.ch";
$apikey = "<your_api_key>";

$url = $apiurl . "/api/1/membergroup/1?apikey=" . $apikey;
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($curl), true);
echo $data["properties"]["title"];

This is a simple example that shows how to create a new member in PHP:

$apiurl = "https://demo.webling.ch";
$apikey = "<your_api_key>";

$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode(array(
    "properties" => array(
        "Vorname" => "Fritz",
        "Name" => "Meier",
        "E-Mail" => "fritz.meier@example.ch"
    ),
    // ID of the membergroup where the member should be added, replace with your own ID
    "parents" => array(550)
)));
curl_setopt($curl, CURLOPT_URL, $apiurl . "/api/1/member?apikey=" . $apikey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($code != 201) {
    echo 'Error: '. $response . ' HTTP-Status Code: '.$code;
} else {
    echo 'Creation successful. ID of new member: '.$response;
}

JavaScript ¶

This is a simple example to get the title of a Membergroup in JavaScript:

WARNING: Don’t use this example in production, as the Apikey is exposed to the user!

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
    <script>
        var apiurl = "https://demo.webling.ch";
        var apikey = "<your_api_key>";
        $(function(){
            $.ajax(apiurl + "/api/1/membergroup/1?apikey=" + apikey).then(
                function(data) {
                    $('#title').html(data.properties.title)
                },
                function(jqXHR, textStatus, errorThrown) {
                    console.error(jqXHR, textStatus, errorThrown);
                }
            );
        })
    </script>
</head>
<body>
    <div id="title"></div>
</body>
</html>

Development Resources ¶

Some resources that may be helpful during development.

API Browser ¶

Easily browse the API with our API Browser. It’s an easy way to find objects and their id’s.

PHP Webling Client ¶

A lightweight Webling API wrapper: github.com/usystems/webling-api-php

Install this package with Composer:

composer require usystems/webling-api-php

The library simplifies Webling API requests:

$api = new Webling\API\Client('https://demo.webling.ch','MY_APIKEY')
$response = $api->get('member/123')

See the GitHub page for more information.

Code Examples ¶

Some code examples that use the API: github.com/usystems/webling-api-examples

Symfony Bundle ¶

A third-party Symfony 2 Bundle, made by Terminal42: github.com/terminal42/webling-bundle

WordPress Plugin ¶

A WordPress Plugin to create member lists and registration forms.

Newsletter ¶

We have an API newsletter to notify users about changes. Sign up here

Changelog ¶

Breaking Changes are listed here.

Release 08-2022

• Fix: Empty objects of links, children and definitions now return an empty object {} instead of an empty array []

Release 11-2021

• /debitor: added date property which is now used as the general invoice date.

Release 03-2021

Debitors can now have multiple revenues (Rechnungsposten).

• /debitor: added title property which is now used as the general invoice title

• /debitor: added invoiceitems property to store the order of invoice items

Release 01-2021

Debitors can now be written off (ausbuchen).

• /debitor: added a third split writeoff for the writeoff entries

• /debitor: added writeoffamount with the written of amount of the debitor

Release 12-2020

The object costcentertemplate has been removed, as it was never used in the Webling UI.

Release 11-2019

Debitorcategories are now children of the periodgroup.

This means: debitorcategories are available in all periods of the periodgroup and do not need to be created if a new period is created. The structure of the following endpoints are affected:

• /debitorcategory: the parents of the debitorcategories are now periodgroups

• /period: the period no longer has children of the type debitorcategory

• /periodgroup: the periodgroup now has children of the type debitorcategory

Release 07-2017

• Website features are removed from the API by default. They are only present if the website is enabled.
  • /apikey and /user: property webaccess removed
  • /quota: property web removed

Release 06-2017

• Document contents URL has changed. Old: /document/{id}/{filename}.{extension} New: /document/{id}/file/{filename}.{extension}

• Some changes to the search Query Language:

  • The filter query param is now ?filter=<your_query> instead of ?query=<your_query>
  • Most EBNF features are now supported
  • Global "NOT" Operator introduced. The old syntax "IS NOT" and "NOT LIKE" and "NOT IN" is not supported anymore
  • Operator "START WITH" has been removed, use "FILTER" instead
  • Properties containing special characters must now be enclosed by backticks instead of quotes. Old: "Zweiter Name" = "Meier" New: `Zweiter Name` = "Meier"
  • Properties can now be used on the left and the right side of a comparison. Example: `Vorname` = `Nachname`
  • The special property $type has been removed

• Changed and improved the sorting options. Old query params were ?sort=Vorname&direction=ASC, the new param is ?order=Vorname ASC, Nachname DESC. Multiple sort fields are now possible.

• The unofficial finance endpoints have changed due to a large internal refactoring

Account ¶

An account is a finance item (Konto) and is always a child of an accountgroup. An account has links to all entries and entrygroups that are connected to this account.

A link to an accounttemplate is required.

amount is a computed property and cannot be changed.

budget can only be set for expense and income accounts

openingentry can only be set for assets and liabilitys accounts

Content-Type: application/json

{
  "objects": [
    99,
    116,
    206
  ]
}

{
  "type": "account",
  "readonly": false,
  "properties": {
    "title": "Bank",
    "openingentry": 6000
  },
  "children": {},
  "links": {
    "accounttemplate": [
      4117
    ]
  },
  "parents": [
    96
  ]
}

18010

Content-Type: application/json

{
  "type": "account",
  "readonly": false,
  "properties": {
    "amount": 5920,
    "title": "Bank",
    "budget": null,
    "openingentry": 6000
  },
  "children": {},
  "links": {
    "entry": [
      179
    ],
    "entrygroup": [
      2718
    ],
    "accounttemplate": [
      4117
    ]
  },
  "parents": [
    96
  ]
}

{
  "type": "account",
  "readonly": false,
  "properties": {
    "amount": 5920,
    "title": "Bank",
    "budget": null,
    "openingentry": 6000
  },
  "links": {},
  "parents": [
    96
  ]
}

Accountgroup ¶

An accountgroup is a finance item group (Kontengruppe) and is always a child of a period. An accountgroup has a link to the accountgrouptemplate, for linking accountgroups in different periods together. Children of an accountgroup are accounts.

A link to an accountgrouptemplate is required.

type specifies to which group it belongs. It can be one expense, income, assets or liabilitys

Content-Type: application/json

{
  "objects": [
    187,
    195,
    197
  ]
}

{
  "type": "accountgroup",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "links": {
    "accountgrouptemplate": [
      4152
    ]
  },
  "parents": [
    2230
  ]
}

18010

Content-Type: application/json

{
  "type": "accountgroup",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "children": {
    "account": [
      2244,
      2245
    ]
  },
  "links": {
    "accountgrouptemplate": [
      4152
    ]
  },
  "parents": [
    2230
  ]
}

Content-Type: application/json

{
  "type": "accountgroup",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "children": {
    "account": [
      2244,
      2245
    ]
  },
  "links": {
    "accountgrouptemplate": [
      4152
    ]
  },
  "parents": [
    2230
  ]
}

Accountgrouptemplate ¶

An accountgrouptemplate is a finance item (Kontengruppenvorlage) and is always a child of a periodchain. It serves as a link between accountgroups in different periods. Accountgrouptemplates are used to determine a corresponding accountgroup in a following/previous period. The children of an accountgrouptemplate are accounttemplates, that serve a similar purpose but for accounts.

Content-Type: application/json

{
  "objects": [
    4133,
    4152
  ]
}

{
  "type": "accountgrouptemplate",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "children": {},
  "links": {},
  "parents": [
    4126
  ]
}

18010

Content-Type: application/json

{
  "type": "accountgrouptemplate",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "children": {
    "accounttemplate": [
      4153,
      4154
    ]
  },
  "links": {
    "accountgroup": [
      197,
      814,
      2243
    ]
  },
  "parents": [
    4126
  ]
}

Content-Type: application/json

{
  "type": "accountgrouptemplate",
  "readonly": false,
  "properties": {
    "title": "Eigenkapital",
    "type": "liabilitys"
  },
  "children": {
    "accounttemplate": [
      4153,
      4154
    ]
  },
  "links": {
    "accountgroup": [
      197,
      814,
      2243
    ]
  },
  "parents": [
    4126
  ]
}

Accounttemplate ¶

An accounttemplate is a finance item (Kontenvorlage) and is always a child of an accountgrouptemplate. It serves as a link between accounts in different periods. Accounttemplates are used to determine a corresponding account in a following/previous period.

Content-Type: application/json

{
  "objects": [
    4007,
    4023
  ]
}

{
  "type": "accounttemplate",
  "readonly": false,
  "properties": {
    "title": "Kasse"
  },
  "children": {},
  "links": {
    "account": [
      3603,
      3658,
      3722
    ]
  },
  "parents": [
    4022
  ]
}

18010

Content-Type: application/json

{
  "type": "accounttemplate",
  "readonly": false,
  "properties": {
    "title": "Kasse"
  },
  "children": {},
  "links": {
    "account": [
      3603,
      3658,
      3722
    ]
  },
  "parents": [
    4022
  ]
}

Content-Type: application/json

{
  "type": "accounttemplate",
  "readonly": false,
  "properties": {
    "title": "Kasse"
  },
  "children": {},
  "links": {
    "account": [
      3603,
      3658,
      3722
    ]
  },
  "parents": [
    4022
  ]
}

Apikey ¶

Only administrators have access to the /apikey endpoints.

Content-Type: application/json

{
  "objects": [
    1812,
    1791,
    1793,
    1789
  ]
}

Content-Type: application/json

{
  "type": "apikey",
  "readonly": false,
  "properties": {
    "title": "Api Key",
    "custommemberaccess": {
      "552": "+r",
      "555": "+r+w",
      "558": "+r"
    },
    "customfinanceaccess": {
      "800": "+r+w",
      "1814": "+r"
    },
    "memberaccess": "custom",
    "financeaccess": "custom",
    "articleaccess": "none",
    "administrator": false
  },
  "children": {},
  "parents": [],
  "links": {}
}

1793

Content-Type: application/json

{
  "type": "apikey",
  "readonly": false,
  "properties": {
    "title": "Api Key",
    "custommemberaccess": {
      "552": "+r",
      "555": "+r+w",
      "558": "+r"
    },
    "customfinanceaccess": {
      "800": "+r+w",
      "1814": "+r"
    },
    "memberaccess": "custom",
    "financeaccess": "custom",
    "articleaccess": "none",
    "administrator": false
  },
  "children": {},
  "parents": [],
  "links": {}
}

Content-Type: application/json

{
  "type": "apikey",
  "readonly": false,
  "properties": {
    "title": "Api Key",
    "custommemberaccess": {
      "552": "+r",
      "555": "+r+w",
      "558": "+r"
    },
    "customfinanceaccess": {
      "800": "+r+w",
      "1814": "+r"
    },
    "memberaccess": "custom",
    "financeaccess": "custom",
    "articleaccess": "none",
    "administrator": false
  },
  "children": {},
  "parents": [],
  "links": {}
}

Content-Type: application/json

{
  "timestamp": "2015-12-28 11:39:42",
  "ip": "192.168.19.1"
}

Article ¶

An article is a material item and is always a child of an articlegroup.

Content-Type: application/json

{
  "objects": [
    64,
    65,
    66
  ]
}

Content-Type: application/json

{
  "type": "article",
  "readonly": false,
  "properties": {
    "description": "1 Defekt",
    "title": "Freistossdummies",
    "place": "Materiallager",
    "price": 0,
    "quantity": 4
  },
  "children": {},
  "parents": [
    56
  ],
  "links": {}
}

18010

Content-Type: application/json

{
  "type": "article",
  "readonly": false,
  "properties": {
    "description": "1 Defekt",
    "title": "Freistossdummies",
    "place": "Materiallager",
    "price": 0,
    "quantity": 4
  },
  "children": {},
  "parents": [
    56
  ],
  "links": {}
}

Content-Type: application/json

{
  "type": "article",
  "readonly": false,
  "properties": {
    "description": "1 Defekt",
    "title": "Freistossdummies",
    "place": "Materiallager",
    "price": 0,
    "quantity": 4
  },
  "children": {},
  "parents": [
    56
  ],
  "links": {}
}

Articlegroup ¶

An articlegroup contains articles.

Articlegroups are also known as “Rubriken”.

Content-Type: application/json

{
  "objects": [
    56,
    57
  ]
}

Content-Type: application/json

{
  "type": "articlegroup",
  "readonly": false,
  "properties": {
    "title": "Artikel"
  },
  "children": {
    "article": [
      65
    ]
  },
  "parents": [],
  "links": {}
}

1809

Content-Type: application/json

{
  "type": "articlegroup",
  "readonly": false,
  "properties": {
    "title": "Artikel"
  },
  "children": {
    "article": [
      65
    ]
  },
  "parents": [],
  "links": {}
}

Content-Type: application/json

{
  "type": "articlegroup",
  "readonly": false,
  "properties": {
    "title": "Artikel"
  },
  "children": {
    "article": [
      65
    ]
  },
  "parents": [],
  "links": {}
}

Config ¶

Content-Type: application/json

{
  "name": "Demo Verein",
  "domain": "demo",
  "language": "de",
  "defaultSmsSender": "webling.ch",
  "userImageEnabled": true,
  "cardDavEnabled": true,
  "apiEnabled": true,
  "emailEnabled": true,
  "smsEnabled": true,
  "sepaEnabled": true
}

Costcenter ¶

Costcenters can be used to categorize entries. Entries can be linked to a costcenter. Costcenters are children of a period.

Content-Type: application/json

{
  "objects": [
    1098,
    1864
  ]
}

Content-Type: application/json

{
  "type": "costcenter",
  "readonly": false,
  "properties": {
    "title": "Spielbetrieb"
  },
  "children": {},
  "links": {
    "entry": [
      3593
    ]
  },
  "parents": [
    2309
  ]
}

1809

Content-Type: application/json

{
  "type": "costcenter",
  "readonly": false,
  "properties": {
    "title": "Spielbetrieb"
  },
  "children": {},
  "links": {
    "entry": [
      3593
    ]
  },
  "parents": [
    2309
  ]
}

Content-Type: application/json

{
  "type": "costcenter",
  "readonly": false,
  "properties": {
    "title": "Spielbetrieb"
  },
  "children": {},
  "links": {
    "entry": [
      3593
    ]
  },
  "parents": [
    2309
  ]
}

Currentuser ¶

Content-Type: application/json

{
  "id": 1789,
  "name": "Api-Test Key"
}

Debitor ¶

A debitor is an invoice (Rechnung).

• A debitor needs to be linked to at least one revenue entry (Rechnungsposten).

• If it is paid it is also linked to one or more payment entries.

• It can also have one or more writeoff entries if the amount was reduced.

• It is always a child of a period.

• It will usually be linked to a member, but this is optional.

• If a pdf was generated, the letter and the letterpdf are also linked (only for pdfs created with the new editor).

• The invoice items (Rechnungsposten) are the linked entries in links->revenue

• The order of the invoice items is stored in the invoiceitems property. You can omit the invoiceitems property when creating a debitor. It can be null for older debitors with only one invoiceitem.

• The address property gets populated with the last known address, when the linked member is deleted.

• The *amount properties are readonly and are calculated from the linked entries.

Not all properties of the invoice are stored in the debitor itself. Some of them are stored in linked objects.

• Paydates (Bezahldatum): links->payment[*]->parents[0]->properties->date

• Receipt (Beleg Nr.): links->payment[0]->properties->receipt

• PDFs: links->letterpdf[*]->properties->pdf->href (PDF url)

Content-Type: application/json

{
  "objects": [
    3832,
    3840,
    3854
  ]
}

{
  "properties": {
    "title": "Jahresrechnung",
    "date": "2016-03-27",
    "duedate": "2016-04-27"
  },
  "parents": [
    2230
  ],
  "links": {
    "revenue": [
      {
        "properties": {
          "amount": 50,
          "title": "Mitgliederbeitrag 2016",
          "receipt": "12A"
        },
        "parents": [
          {
            "properties": {
              "date": "2016-03-27",
              "title": "Mitgliederbeitrag 2016"
            },
            "parents": [
              2230
            ]
          }
        ],
        "links": {
          "credit": [
            2257
          ],
          "debit": [
            2236
          ]
        }
      }
    ],
    "member": [
      469
    ],
    "debitorcategory": [
      1097
    ]
  }
}

15013

Content-Type: application/json

{
  "meta": {
    "created": "2020-03-13 17:05:32",
    "lastmodified": "2020-03-13 17:06:31"
  },
  "type": "debitor",
  "readonly": false,
  "properties": {
    "title": "Mitgliederbeitrag Jassverein 2020",
    "address": null,
    "comment": null,
    "date": "2020-03-12",
    "duedate": "2020-04-12",
    "debitorid": 535,
    "state": "paid",
    "remainingamount": 0,
    "totalamount": 50,
    "paidamount": 50,
    "writeoffamount": 0,
    "invoiceitems": "[{\"entryId\":4895}]"
  },
  "children": {},
  "parents": [
    2230
  ],
  "links": {
    "revenue": [
      {
        "type": "entry",
        "meta": {
          "created": "2020-03-13 17:05:32",
          "lastmodified": "2020-03-13 17:05:32"
        },
        "readonly": false,
        "properties": {
          "amount": 50,
          "title": null,
          "receipt": null,
          "entryid": 32,
          "receiptfile": null
        },
        "children": {},
        "links": {
          "credit": [
            2257
          ],
          "debit": [
            2236
          ],
          "debitor": [
            4333
          ]
        },
        "parents": [
          4332
        ],
        "id": 4331
      }
    ],
    "payment": [
      {
        "type": "entry",
        "meta": {
          "created": "2020-03-13 17:06:31",
          "lastmodified": "2020-03-13 17:06:31"
        },
        "readonly": false,
        "properties": {
          "amount": 50,
          "title": null,
          "receipt": null,
          "entryid": 108,
          "receiptfile": null
        },
        "children": {},
        "links": {
          "credit": [
            2236
          ],
          "debit": [
            2235
          ],
          "debitor": [
            4333
          ]
        },
        "parents": [
          4638
        ],
        "id": 4639
      }
    ],
    "member": [
      476
    ],
    "debitorcategory": [
      1097
    ]
  }
}

Content-Type: application/json

{
  "meta": {
    "created": "2020-03-13 17:05:32",
    "lastmodified": "2020-03-13 17:06:31"
  },
  "type": "debitor",
  "readonly": false,
  "properties": {
    "title": "Mitgliederbeitrag Jassverein 2020",
    "address": null,
    "comment": null,
    "date": "2020-03-12",
    "duedate": "2020-04-12",
    "debitorid": 535,
    "state": "paid",
    "remainingamount": 0,
    "totalamount": 50,
    "paidamount": 50,
    "writeoffamount": 0,
    "invoiceitems": "[{\"entryId\":4895}]"
  },
  "children": {},
  "parents": [
    2230
  ],
  "links": {
    "revenue": [
      {
        "type": "entry",
        "meta": {
          "created": "2020-03-13 17:05:32",
          "lastmodified": "2020-03-13 17:05:32"
        },
        "readonly": false,
        "properties": {
          "amount": 50,
          "title": null,
          "receipt": null,
          "entryid": 32,
          "receiptfile": null
        },
        "children": {},
        "links": {
          "credit": [
            2257
          ],
          "debit": [
            2236
          ],
          "debitor": [
            4333
          ]
        },
        "parents": [
          4332
        ],
        "id": 4331
      }
    ],
    "payment": [
      {
        "type": "entry",
        "meta": {
          "created": "2020-03-13 17:06:31",
          "lastmodified": "2020-03-13 17:06:31"
        },
        "readonly": false,
        "properties": {
          "amount": 50,
          "title": null,
          "receipt": null,
          "entryid": 108,
          "receiptfile": null
        },
        "children": {},
        "links": {
          "credit": [
            2236
          ],
          "debit": [
            2235
          ],
          "debitor": [
            4333
          ]
        },
        "parents": [
          4638
        ],
        "id": 4639
      }
    ],
    "member": [
      476
    ],
    "debitorcategory": [
      1097
    ]
  }
}

Debitorcategory ¶

Debitorcategories can be used to categorize debitors. Debitors can be linked to a debitorcategory. Debitorcategories are children of a periodgroup and can be used in all child periods of that periodgroup.

Content-Type: application/json

{
  "objects": [
    1098,
    1864
  ]
}

Content-Type: application/json

{
  "type": "debitorcategory",
  "readonly": false,
  "properties": {
    "title": "Materialbezug"
  },
  "children": {},
  "links": {
    "debitor": [
      2291
    ]
  },
  "parents": [
    800
  ]
}

1809

Content-Type: application/json

{
  "type": "debitorcategory",
  "readonly": false,
  "properties": {
    "title": "Materialbezug"
  },
  "children": {},
  "links": {
    "debitor": [
      2291
    ]
  },
  "parents": [
    800
  ]
}

Content-Type: application/json

{
  "type": "debitorcategory",
  "readonly": false,
  "properties": {
    "title": "Materialbezug"
  },
  "children": {},
  "links": {
    "debitor": [
      2291
    ]
  },
  "parents": [
    800
  ]
}

Definitions ¶

Content-Type: application/json

/* ?format=simple */
{
    "member": {
        "label": [
            "Vorname",
            "Name"
        ],
        "ordered": false,
        "properties": {
            "ID": {
                "id": 236,
                "datatype": "autoincrement",
                "category": 1,
                "order": 0
            },
            "Vorname": {
                "id": 83,
                "datatype": "text",
                "category": 1,
                "order": 1,
                "type": "firstname"
            },
            "Lizenz": {
                "id": 71,
                "datatype": "enum",
                "category": 1,
                "order": 13,
                "values": [
                    "1.Liga",
                    "2.Liga",
                    "Junior"
                ]
            },
            "Geburtstag": {
                "id": 68,
                "datatype": "date",
                "category": 1,
                "order": 15,
                "type": "birthday"
            },
            /* more properties ... */
        },
        "children": {},
        "parents": "membergroup",
        "links": {
            "debitor": "debitor"
        },
        "categories": {
            "1": "Mitgliederdaten",
            "2": "Zweite Kategorie"
        }
    },
    "user": {
        "label": [ "title" ],
        "ordered": false,
        "properties": { 
            /* user properties ... */ 
        },
        "children": {},
        "parents": "usergroup",
        "links": {},
        "categories": []
    },
    /* more datatypes (membergroup, article, document, ...) */
}

Document ¶

Content-Type: application/json

{
  "objects": [
    1796,
    1805,
    1808,
    1804
  ]
}

{
  "type": "document",
  "readonly": true,
  "properties": {
    "title": "factsheet_webling.pdf",
    "content": "base64 encoded file content"
  },
  "children": {},
  "parents": [
    577
  ],
  "links": {}
}

18010

Content-Type: application/json

{
  "type": "document",
  "readonly": true,
  "properties": {
    "title": "factsheet_webling.pdf",
    "description": "Webling Factsheet",
    "href": "/api/1/document/1805/file/factsheet_webling.pdf",
    "size": 1142037,
    "lastmodified": "2015-05-15 11:27:40",
    "isProtected": true,
    "protectedBy": "Administrator",
    "file": {
      "name": "factsheet_webling.pdf",
      "href": "/api/1/document/1805/file/factsheet_webling.pdf",
      "size": 1142037,
      "lastmodified": "2015-05-15 11:27:40"
    }
  },
  "children": {},
  "parents": [
    577
  ],
  "links": {}
}

Content-Type: application/json

{
  "type": "document",
  "readonly": true,
  "properties": {
    "title": "factsheet_webling.pdf",
    "description": "Webling Factsheet",
    "href": "/api/1/document/1805/file/factsheet_webling.pdf",
    "size": 1142037,
    "lastmodified": "2015-05-15 11:27:40",
    "isProtected": true,
    "protectedBy": "Administrator",
    "file": {
      "name": "factsheet_webling.pdf",
      "href": "/api/1/document/1805/file/factsheet_webling.pdf",
      "size": 1142037,
      "lastmodified": "2015-05-15 11:27:40"
    }
  },
  "children": {},
  "parents": [
    577
  ],
  "links": {}
}

Content-Type: application/zip

binary data

Documentgroup ¶

A documentgroup contains documents and other documentgroups.

Documentgroups are also known as Folders, “Ordner”.

Content-Type: application/json

{
  "objects": [
    1806,
    577,
    1807,
    1795
  ],
  "roots": [
    577
  ]
}

Content-Type: application/json

{
  "type": "documentgroup",
  "readonly": false,
  "properties": {
    "title": "Dokumente"
  },
  "children": {
    "document": [
      1808
    ],
    "documentgroup": [
      1807
    ]
  },
  "parents": [
    577
  ],
  "links": {}
}

1809

Content-Type: application/json

{
  "type": "documentgroup",
  "readonly": false,
  "properties": {
    "title": "Dokumente"
  },
  "children": {
    "document": [
      1808
    ],
    "documentgroup": [
      1807
    ]
  },
  "parents": [
    577
  ],
  "links": {}
}

Content-Type: application/json

{
  "type": "documentgroup",
  "readonly": false,
  "properties": {
    "title": "Dokumente"
  },
  "children": {
    "document": [
      1808
    ],
    "documentgroup": [
      1807
    ]
  },
  "parents": [
    577
  ],
  "links": {}
}

Content-Type: application/zip

binary data

Entry ¶

An entry is a financial posting (Buchung) linked to two accounts and is a child of an entrygroup.

An entry can be linked to a debitor to indicate a revenue or payment.

An entry can be linked to a costcenter to categorize entries.

Content-Type: application/json

{
  "objects": [
    175,
    176,
    180
  ]
}

{
  "properties": {
    "amount": 50,
    "title": "Mitgliederbeitrag 2024",
    "receipt": "12A"
  },
  "parents": [
    {
      "properties": {
        "date": "2024-03-27",
        "title": "Mitgliederbeitrag 2024"
      },
      "parents": [
        2230
      ]
    }
  ],
  "links": {
    "credit": [
      2236
    ],
    "debit": [
      2235
    ]
  }
}

7800

Content-Type: application/json

{
  "type": "entry",
  "readonly": false,
  "properties": {
    "amount": 200,
    "title": "",
    "receipt": "6",
    "entryid": 13,
    "skrSphere": null,
    "receiptfile": null
  },
  "children": {},
  "links": {
    "credit": [
      122
    ],
    "debit": [
      97
    ]
  },
  "parents": [
    2719
  ]
}

Content-Type: application/json

{
  "type": "entry",
  "readonly": false,
  "properties": {
    "amount": 200,
    "title": "",
    "receipt": "6",
    "entryid": 13,
    "skrSphere": null,
    "receiptfile": null
  },
  "children": {},
  "links": {
    "credit": [
      122
    ],
    "debit": [
      97
    ]
  },
  "parents": [
    2719
  ]
}

Entrygroup ¶

An entrygroup is a collective financial posting (Sammelbuchung) linked to two accounts and is always a child of a period. It cannot exist without a period. An entrygroup can only have one entry as a child.

Content-Type: application/json

{
  "objects": [
    3096,
    3100,
    3047
  ]
}

{
  "properties": {
    "date": "2011-03-27",
    "title": "Spesen"
  },
  "children": {
    "entry": [
      {
        "properties": {
          "amount": 200,
          "receipt": "6"
        },
        "links": {
          "credit": [
            122
          ],
          "debit": [
            97
          ]
        }
      }
    ]
  },
  "parents": [
    94
  ]
}

18010

Content-Type: application/json

{
  "type": "entrygroup",
  "readonly": false,
  "properties": {
    "title": "Getränkeverkauf",
    "date": "2020-10-03"
  },
  "children": {
    "entry": [
      4289
    ]
  },
  "links": {
    "account": [
      2234,
      2259
    ]
  },
  "parents": [
    2230
  ]
}

Content-Type: application/json

{
  "type": "entrygroup",
  "readonly": false,
  "properties": {
    "title": "Getränkeverkauf",
    "date": "2020-10-03"
  },
  "children": {
    "entry": [
      4289
    ]
  },
  "links": {
    "account": [
      2234,
      2259
    ]
  },
  "parents": [
    2230
  ]
}

Letter ¶

The letter object is used by the letter editor to write and send letters. They can be printed but also sent by e-mail.

If a PDF has been generated, the letterpdfs are linked and the state of the letter is “sent”. A sent letter becomes immutable.

Not all letter actions are available to API users (e.g. send letters by e-mail or saving drafts).

Note: This is only available for letters created with the new editor

Content-Type: application/json

{
  "objects": [
    1098,
    1864
  ]
}

Content-Type: application/json

{
  "type": "letter",
  "meta": {
    "created": "2021-01-15 16:44:38",
    "lastmodified": "2021-01-15 16:45:21"
  },
  "readonly": false,
  "properties": {
    "title": "Rechnung",
    "state": "sent",
    "sentat": "2021-01-15 16:45:20",
    "sentby": "Demo Benutzer <demo@example.ch>",
    "data": "... letter content ...",
    "preview": {
      "href": "/api/1/letter/4812/image/preview.png",
      "hrefthumb": "/api/1/letter/4812/thumb/preview.png",
      "size": 126668,
      "name": "preview.png",
      "lastmodified": "2021-01-15 16:45:09",
      "dimensions": {
        "width": 400,
        "height": 570
      }
    },
    "isattachment": true,
    "lettertype": "debitor"
  },
  "children": {
    "letterpdf": [
      4814,
      4815,
    ]
  },
  "links": {
    "debitor": [
      4546,
      4543,
    ],
    "sender": [
      584
    ]
  },
  "parents": []
}

{
  "properties": {
    "title": "my letter",
    "state": "sent",
    "data": "{\"body\":[[{\"start\":0,\"width\":12,\"id\":\"1\",\"type\":\"html\",\"padding\":{\"top\":0,\"right\":0,\"bottom\":0,\"left\":0},\"content\":{\"html\":\"<h1>Hallo {{Vorname}}</h1>\"}}]]}",
    "lettertype": "member"
  },
  "links": {
    "member": [
      525
    ]
  }
}

Letterpdf ¶

The generated pdf from a letter is saved as a letterpdf object. To get the actual PDF you need to call the href that is returned with this object.

A letterpdf is either linked to a member or a debitor and is always a child of a letter.

Letterpdfs are immutable and cannot be created or updated manually. To create a new PDF, use the /letter/new/send endpoint.

Note: This is only available for pdfs created with the new editor

Content-Type: application/json

{
  "objects": [
    4814,
    4815,
    4816
  ]
}

Content-Type: application/json

{
  "type": "letterpdf",
  "meta": {
    "created": "2021-01-15 16:44:03",
    "lastmodified": "2021-01-15 16:44:03"
  },
  "readonly": false,
  "properties": {
    "pdf": {
      "href": "/api/1/letterpdf/4808/file/pdf.pdf",
      "size": 19334,
      "name": "pdf.pdf",
      "lastmodified": "2021-01-15 16:44:02"
    }
  },
  "children": {},
  "links": {
    "debitor": [
      4552
    ]
  },
  "parents": [
    4807
  ]
}

Member ¶

Content-Type: application/json

{
  "objects": [
    536,
    525,
    497,
    535,
    474,
    533,
    499
  ]
}

{
  "type": "member",
  "readonly": false,
  "properties": {
    "Vorname": "Quentin",
    "Name": "Moser",
    "Firma": null,
    "Strasse": "Kirchgasse  32",
    "PLZ": "9000",
    "Ort": "St. Gallen",
    "Telefon": "079 336 47 50",
    "Mobile": "077 336 47 50",
    "E-Mail": "Moser@nospam-webling.ch",
    "Lizenz": "Junior",
    "Geschlecht": "m",
    "Geburtstag": "1997-07-13",
    "Checkbox": true,
    "Mehrfachauswahlfeld": [
      "Wert 1",
      "Wert 2"
    ],
    "Mitgliederbild": {
      "name": "filename.gif",
      "content": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="
    }
  },
  "children": {},
  "parents": [
    555
  ],
  "links": {
    "debitor": [
      883,
      1136,
      1900,
      2388
    ]
  }
}

540

Content-Type: application/json

{
  "type": "member",
  "readonly": false,
  "properties": {
    "Vorname": "Quentin",
    "Name": "Moser",
    "Firma": null,
    "Strasse": "Kirchgasse  32",
    "PLZ": "9000",
    "Ort": "St. Gallen",
    "Telefon": "079 336 47 50",
    "Mobile": "077 336 47 50",
    "E-Mail": "Moser@nospam-webling.ch",
    "Lizenz": "Junior",
    "Geschlecht": "m",
    "Geburtstag": "1997-07-13",
    "Checkbox": false,
    "Mitgliederbild": {
      "href": "/api/1/member/504/image/Mitgliederbild.jpg",
      "size": 325743,
      "name": "Mitgliederbild.jpg",
      "lastmodified": "2015-05-15 11:26:55",
      "dimensions": {
        "width": 640,
        "height": 480
      }
    },
    "Datei": {
      "href": "/api/1/member/504/file/Datei.pdf",
      "size": 117539,
      "name": "Datei.pdf",
      "lastmodified": "2015-05-15 11:26:55"
    }
  },
  "children": {},
  "parents": [
    555
  ],
  "links": {
    "debitor": [
      883,
      1136,
      1900,
      2388
    ]
  }
}

{
  "type": "member",
  "readonly": false,
  "properties": {
    "Vorname": "Quentin",
    "Name": "Moser",
    "Firma": null,
    "Strasse": "Kirchgasse  32",
    "PLZ": "9000",
    "Ort": "St. Gallen",
    "Telefon": "079 336 47 50",
    "Mobile": "077 336 47 50",
    "E-Mail": "Moser@nospam-webling.ch",
    "Lizenz": "Junior",
    "Geschlecht": "m",
    "Geburtstag": "1997-07-13",
    "Checkbox": true,
    "Mehrfachauswahlfeld": [
      "Wert 1",
      "Wert 2"
    ],
    "Mitgliederbild": {
      "name": "filename.gif",
      "content": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="
    }
  },
  "children": {},
  "parents": [
    555
  ],
  "links": {
    "debitor": [
      883,
      1136,
      1900,
      2388
    ]
  }
}

Content-Type: image/jpeg

binary data

Content-Type: application/pdf

binary data

Membergroup ¶

A membergroup contains members and other membergroups.