Getting started


Our REST API let you integrate weclapp with other applications or services.

What should I know before starting?

Our API is continuously being developed and improved, but we are still trying to keep it as stable as possible. We try to only have changes that are backwards compatible: usually the changes are only additions, e.g. new resources are implemented or new properties are added to existing resources. Sometimes breaking changes cannot be avoided, e.g. when a new feature requires an incompatible change to the underlying data model, all those changes will be documented in the change log.

Security and Authentication

You must be a verified user to make API requests. You can authorize against the API with an API token. The token is configurable in your weclapp account under My settings > API. Authentication is possible in multiple ways: If the request contains the session cookies of a logged in weclapp session then the user and permissions of that session are used. This is useful when testing the API in a Webbrowser, because then requests are “automatically” authenticated if weclapp is used in another tab. But generally the API is not used from a browser or with session cookies, instead there is an API token for each user that can be used to authenticate requests. Each user can find his/her token on the My Settings page. The token should be kept secret like a password. A user can also generate a new token at any time, doing that invalidates all previous tokens. Authenticating using a token is possible in two ways:

•the token can be sent using the AuthenticationToken header AuthenticationToken: {api_token}
•the standard HTTP Basic authentication can be used: the username needs to be “*” and the password is the token

Using curl

            curl -H "AuthenticationToken:{api_token} https://<tenant>.weclapp.com/webapp/api/v1/...
          


Examples of how to use curl will be shown in each section of this API.

Headers

This is a JSON-only API. You must supply a Content-Type: application/json header on PUT and POST operations. You must set a Accept: application/json header on all requests. You may get a text/plain response in case of error, e.g. in case of a bad request, you should treat this as an error you need to take action on.

URLs

The base URL for the API is https://<tenant>.weclapp.com/webapp/api/v1/ where <tenant>.weclapp.com is the domain of the specific weclapp instance. So each weclapp instance has its own API endpoints which allow accessing data for that particular instance. The API provides access to various resources like customers, sales orders, articles etc.. Each of those resources implements a common set of operations. The URLs and HTTP methods for the different resource operations use the same pattern for all resources:

Operation HTTP Method URL pattern
Query/list instances GET
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>
                
total number of instances GET
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>/count
                
Get a specific instance by id GET
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>/id/<id>
                
Create a new instance POST
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>
                
Update a specific instance PUT
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>/id/<id>
                
Delete a specific instance DELETE
                  https://<tenant>.weclapp.com/webapp/api/v1/<resource>/id/<id>
                
Not all resources support all of those operations. A general description for each operation can be found in API Operations by example, and details for each resource are described on the page for that resource.

Additional operations

Some resources allow further operations or actions. Those operations can be executed with a POST request, for some operations that only read data it is also possible to use a GET request (this is documented for each operation). For general operations for a resource the URL pattern is https://<tenant>.weclapp.com/webapp/api/v1/<resource>/<operation>. Some operations are instance specific, those use the following URL pattern: https://<tenant>.weclapp.com/webapp/api/v1/<resource>/id/<id>/<operation>.

JSON

Type Representation in JSON
string Serialized as JSON string, empty strings (length 0 or only whitespace) are always interpreted as null, it is not possible to have a property with an empty string value.
boolean Serialized as true/false.
decimal number Most numbers in weclapp are decimal numbers with a fixed precision and scale (e.g. quantities or prices), they are serialized as JSON strings and not as JSON numbers to prevent accidental loss of precision when the JSON is deserialized with a JSON library that uses doubles to represent JSON numbers. The serialized numbers always use a “.” as the decimal mark (if one is required).
integers Integer numbers (that can safely be represented as a double) are serialized as JSON numbers.
floats/doubles Serialized as JSON numbers.
dates and timestamps Serialized as the milliseconds since 1970-01-01T00:00:00Z (as a JSON number).
enums Sometimes a property value can be one of a fixed number of named options. Those enum properties are serialized as a JSON string with the name of the option.
The deserialization of data sent to the API is relatively lenient, for example when a string is expected, but a number is given then that number is used as the string and the other way around (if possible). Properties with the value null are not serialized by default and when sending data to the API it is also not necessary to include properties whose value is null: all properties that are missing from the JSON object but are expected are assumed to be null. To get all properties including those with the value null the query parameter serializeNulls can be added to the request URL, in that case null values are included in the response.

Change Policy

weclapp may modify the attributes and resources available to the API and our policies related to access and use of the API from time to time without advance notice. weclapp will use commercially reasonable efforts to notify you of any modifications to the API or policies through notifications or posts on the weclapp Developer Website. weclapp also tracks deprecation of attributes of the API on its Changelog. Modification of the API may have an adverse effect on weclapp Applications, including but not limited to changing the manner in which weclapp Applications communicate with the API and display or transmit Your Data. weclapp will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications

API operations sample


As mentioned previously all resources implement common operations in the same way. In the following all the common operations are explained for the salesOrder resource. The operations work in the same way for all other resources (some resources don’t support all the operations), the differences between the resources are mostly the data and the properties that are required and used.

Querying

The most common operation is querying or listing the existing entity instances. This is possible with a GET request to the base URL of a resource:

/salesOrder

            curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder
          

Output:

{
  "result": [
      {
          "id": "1839",
          "version": "2",
          "createdDate": 1398436281262,
          "customerId": "1827",
          "customerNumber": "1007",
          "deliveryAddress": {
              "addressLine1": "Example Company",
              "city": "Example city",
              "countryCode": "DE",
              "street1": "Example street 1",
              "zipcode": "12345"
          },
          "invoiceAddress": {
              "addressLine1": "Example Company",
              "city": "Example city",
              "countryCode": "DE",
              "street1": "Example street 1",
              "zipcode": "12345"
          },
          "lastModifiedDate": 1398440239136,
          "orderDate": 1398376800000,
          "orderItems": [
              {
                  "id": "1844",
                  "version": "0",
                  "articleId": "1835",
                  "articleNumber": "123456",
                  "createdDate": 1398436371394,
                  "discountPercentage": "0",
                  "lastModifiedDate": 1398436371394,
                  "manualUnitPrice": true,
                  "positionNumber": 1,
                  "quantity": "1",
                  "reductionAdditionItems": [],
                  "unitId": "657",
                  "unitName": "Stk.",
                  "unitPrice": "10"
              }
          ],
          "orderNumber": "1000",
          "pricingDate": 1398376800000,
          "recordAddress": {
              "addressLine1": "Example Company",
              "city": "Example city",
              "countryCode": "DE",
              "street1": "Example street 1",
              "zipcode": "12345"
          },
          "recordCurrencyName": "EUR",
          "salesOrderPaymentType": "STANDARD",
          "status": "ORDER_ENTRY_IN_PROGRESS"
      }
  ]
}
          
        
In this case there is one sales order with one order item. By default all null values are ommitted, to include them the query parameter serializeNulls can be used:

/salesOrder/?serializeNulls

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?serializeNulls
        
Output:
{
    "result": [
        {
            "id": "1839",
            "version": "2",
            "commercialLanguage": null,
            "createdDate": 1398436281262,
            "customerId": "1827",
            "customerNumber": "1007",
            "deliveryAddress": {
                "addressLine1": "Example Company",
                "addressLine2": null,
                "city": "Example city",
                "countryCode": "DE",
                "postOfficeBoxCity": null,
                "postOfficeBoxNumber": null,
                "postOfficeBoxZipCode": null,
                "street1": "Example street 1",
                "street2": null,
                "zipcode": "12345"
            },
            "invoiceAddress": {
                "addressLine1": "Example Company",
                "addressLine2": null,
                "city": "Example city",
                "countryCode": "DE",
                "postOfficeBoxCity": null,
                "postOfficeBoxNumber": null,
                "postOfficeBoxZipCode": null,
                "street1": "Example street 1",
                "street2": null,
                "zipcode": "12345"
            },
            "lastModifiedDate": 1398440239136,
            "orderDate": 1398376800000,
            "orderItems": [
                {
                    "id": "1844",
                    "version": "0",
                    "articleId": "1835",
                    "articleNumber": "123456",
                    "createdDate": 1398436371394,
                    "description": null,
                    "discountPercentage": "0",
                    "lastModifiedDate": 1398436371394,
                    "manualUnitPrice": true,
                    "positionNumber": 1,
                    "quantity": "1",
                    "reductionAdditionItems": [],
                    "unitId": "657",
                    "unitName": "Stk.",
                    "unitPrice": "10"
                }
            ],
            "orderNumber": "1000",
            "pricingDate": 1398376800000,
            "quotationId": null,
            "quotationNumber": null,
            "recordAddress": {
                "addressLine1": "Example Company",
                "addressLine2": null,
                "city": "Example city",
                "countryCode": "DE",
                "postOfficeBoxCity": null,
                "postOfficeBoxNumber": null,
                "postOfficeBoxZipCode": null,
                "street1": "Example street 1",
                "street2": null,
                "zipcode": "12345"
            },
            "recordComment": null,
            "recordCurrencyName": "EUR",
            "recordFreeText": null,
            "recordOpening": null,
            "salesOrderPaymentType": "STANDARD",
            "status": "ORDER_ENTRY_IN_PROGRESS"
        }
    ]
}
                                        

Pagination

By default the operation will not return all entity instances but only the first 100, this can be changed by using the pageSize query parameter with the number of desired results. But pageSize cannot be arbitrarily high it usually is limited 1000 (exceptions to the default limits of 100 and 1000 are noted in the documentation for the specific resources). To get further results it is necessary to skip entity instances, this is done using the page query parameter. Examples:

/salesOrder/?pageSize=10

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?pageSize=10
        

returns at most 10 instances

/salesOrder/?page=2&pageSize=10

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?page=2&pageSize=10
        

returns the second page of results (the page parameter is one based, so page=1 is the first page, which is also the default). Using those two parameters it is possible to implement pagination.

Sorting

It is also possible to change the order of the returned results using the sort parameter:

/salesOrder/?sort=customerNumber

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?sort=customerNumber
        

sort by customerNumber (ascending).

/salesOrder/?sort=-customerNumber

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?sort=-customerNumber
        

sort by customerNumber descending.

/salesOrder/?sort=customerNumber,-orderNumber

          curl -H "AuthenticationToken:<TOKEN>
          https://<tenant>.com/webapp/api/v1/salesOrder/?sort=customerNumber,-orderNumbe
        

sort by customerNumber (ascending) and then orderNumber descending.

It is generally possible to sort by most of the simple properties of an entity. It is possible to combine multiple sort orders by combining the property names with a comma. To sort in descending order just prepend a minus to the property name. If an unsupported or unknown property is specified then an error response is returned.

Filtering

It is often desired to get just a subset of the data, for example just the orders of a specific customer or created after a specific date. This is possible using filtering query parameters:

/salesOrder/?customerNumber-eq=1007

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?customerNumber-eq=1007
        

sales orders for customer 1007.

/salesOrder/?createdDate-gt=1398436281262

          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.com/webapp/api/v1/salesOrder/?createdDate-gt=1398436281262
        

sales orders created after the specified timestamp.

/salesOrder/?customerNumber-eq=1007&createdDate-gt=1398436281262

          curl -H "AuthenticationToken:<TOKEN>
          https://<tenant>.com/webapp/api/v1/salesOrder/?customerNumber-eq=1007&createdDate-gt=1398436281262
        

sales orders for customer 1007 and created after the specified timestamp.

A filtering query parameter consists of a property name and a filter operator joined together with a minus. If multiple filtering query parameter are specified then they are combined and the returned results match all of them. Filtering query parameters for unknown properties or properties that don’t support filtering are silently ignored.

The following filtering operators are supported (not all of them work for all property types):
Operator Meaning
eq equal
ne not equal
lt less than
gt greater than
le less equal
ge greater equal
null propery is null (the query parameter value is ignored and can be ommitted)
notnull propery is not null (the query parameter value is ignored and can be ommitted)
like like expression (supports % and _ as placeholders, similar to SQL LIKE)
notlike not like expression
ilike like expression, ignoring case
notilike not like expression, ignoring case
in the property value is in the specified list of values, the query parameter value must be a JSON array with the values in the correct type, for example ?customerNumber-in=["1006","1007"]
notin the property value is not in the specified list of values

Return only specific properties

Sometimes it is desirable to only fetch a subset of all properties, for example to save bandwidth. This is possible by specifying the desired properties using the properties query parameter:

/salesOrder/?properties=id,orderNumber,customerNumber

          curl -H "AuthenticationToken:<TOKEN>
          https://<tenant>.com/webapp/api/v1/salesOrder/?properties=id,orderNumber,customerNumber
        
Output:
{
    "result": [
        {
            "id": "1839",
            "customerNumber": "1007",
            "orderNumber": "1000"
        }
    ]
}
          
It is also possible to specify property paths:

/salesOrder/?properties=id,orderNumber,customerNumber,orderItems.articleNumber,orderItems.quantity

          curl -H "AuthenticationToken:<TOKEN>
          https://<tenant>.com/webapp/api/v1/salesOrder/?properties=id,orderNumber,customerNumber,orderItems.articleNumber,orderItems.quantity
        

If an unknown property or property path is specified then an error response is returned.

Combinations

The query parameters for pagination, sorting, filtering and returning only specific properties can be combined to perform queries.
{
    "result": [
        {
            "id": "1839",
            "customerNumber": "1007",
            "orderItems": [
                {
                    "articleNumber": "123456",
                    "quantity": "1"
                }
            ],
            "orderNumber": "1000"
        }
    ]
}
            

Counting

To determine the total number of entity instances the count operation can be used:
          curl -H "AuthenticationToken:<TOKEN> https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/count
        

It is possible to use the filtering query parameters from the querying operation with the count operation:
          curl -H "AuthenticationToken:<TOKEN>
          https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/count?customerNumber-eq=1007
        

returns the number of sales orders for customer 1007.

Optimistic locking

For the update operation the resources usually also support optimistic locking using the version property: if the version property is in the request body and it does not match the current version, then the request fails with an optimistic lock error. In that case the caller should again get the latest version, apply the changes and try the request again.

Basic Operations

The following entries will show you how to use the different basic operations (GET, POST, PUT, DELETE) and what an exemplary response they will give whether the operation was successfull or not.

The following table will show you the HTTP status codes of the basic operations if the operation was successfull:
Operation HTTP status code
GET 200 (OK)
POST 201 (Created)
PUT 200 (OK)
DELETE 204 (No Content)
If you are not currently logged in to weclapp, you are using another browser or the AuthenticationToken was wrong you will get a response of 401 (Unauthorized). It is possible to disable the optimisitic locking check by just ommitting the version property, but doing this might accidentally overwrite changes done by another user in the meantime.

How To use the tables

This is the last part of the introduction to our API. This is just a short description of "how the tables work". Each segment of this API where POST or PUT is allowed will feature one big table at the beginning. The first column shows the name of the variables which can be used. The second will show the type of the variable. The third column shows whether this variable is required during a POST-Request or not. The last one shows whether the variable will be set as default. There are four different combinations which will be explained here:

required default explanation
No No Not required and not set per default says that you don't have to set this variable and it will not be set per default when you use POST
No Yes Not required, but set per default says that you don't have to set this variable, but it will be set per default. For example: The "address" variable will be set as an empty array most of the time. But you can always provide an own content
Yes No Required, but not set per default is what you have to set by yourself all the time. You will have to set this variable when you do POST and when you do PUT
Yes Yes Required and set per default means that you don't have to set this variable when you do POST, but you have to set it when you do PUT

There will also be some variables for example : "termOfPaymentId / termOfPaymentName" - If you want to include a termOfPayment you have to provide one variable either the id or the name, not both. The other one will be searched and entered by the system.

Article

see all operations for articles.


/article

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/article
Definition https://<tenant>.weclapp.com/webapp/api/v1/article
Result Format
Success Failure
{
    "result": [
        {
          "id": "1457",
          "version": "2",
          "active": true,
          "articleNumber": "DemoTA1",
          "createdDate": 1425816916014,
          "description": "Testarticle 1",
          "lastModifiedDate": 1433770361360,
          "name": "Testartikel 1",
          "productionArticle": false,
          "serialNumberRequired": false,
          "serviceArticle": false,
          "showOnDeliveryNote": true,
          "storable": false,
          "taxId": "907",
          "taxName": "Sales tax",
          "unitId": "926",
          "unitName": "pc."
        },
        {
          "id": "1458",
          "version": "0",
          "active": true,
          "articleNumber": "DemoTA2",
          "createdDate": 1425816916015,
          "description": "Testarticle 2",
          "lastModifiedDate": 1425816916015,
          "name": "Testartikel 2",
          "productionArticle": false,
          "serialNumberRequired": false,
          "serviceArticle": false,
          "showOnDeliveryNote": true,
          "storable": false,
          "taxId": "907",
          "taxName": "Sales tax",
          "unitId": "926",
          "unitName": "pc."
        }
    ]
}
                                

{
    "error": "not found"
}
/article/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/article/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/article/id/:id
Result Format
Success Failure
{
            "id": "1457",
            "version": "2",
            "active": true,
            "articleNumber": "DemoTA1",
            "createdDate": 1425816916014,
            "description": "test description",
            "lastModifiedDate": 1433770361360,
            "name": "Testarticle 1",
            "productionArticle": false,
            "serialNumberRequired": false,
            "serviceArticle": false,
            "showOnDeliveryNote": true,
            "storable": false,
            "taxId": "907",
            "taxName": "Sales tax",
            "unitId": "926",
            "unitName": "pc."
        }
                                

        

        
        {
            "error": "not found"
        }
                                

        
/article/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/article/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/article/count
Result Format
Success Failure


{
    "result": 4
}
                            



{
    "error": "not found"
}
                        

Campaign

see all operations for campaigns.

name type description required default
version integer version number No Yes
campaignEndDate timestamp date at which campaign expires No No
campaignName string name of the campaign Yes No
campaignNumber integer number of the campaign No Yes
campaignStartDate timestamp date at which campaign starts No No
CampaignType string type of the campaign No No
description string short description of this campaign No No
responsibleUserId / responsibleUserUsername integer / string id or name of the responsible user No No

/campaign

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campaign
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign
Result Format
Success Failure


{
    "result": [
        {
            "id": "2109",
            "version": "1",
            "campaignEndDate": 1435356000000,
            "campaignName": "Neue Campagne",
            "campaignNumber": "1000",
            "campaignStartDate": 1434060000000,
            "campaignType": "WEBINAR",
            "createdDate": 1434011091576,
            "description": "new description",
            "lastModifiedDate": 1434011956688,
            "responsibleUserId": "885",
            "responsibleUserUsername": "test@test.de"
        },
        {
            "id": "2237",
            "version": "0",
            "campaignName": "New Campaign",
            "campaignNumber": "1001",
            "createdDate": 1434966079061,
            "lastModifiedDate": 1434966079061
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/campaign/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Result Format
Success Failure


{
    "id": "2109",
    "version": "1",
    "campaignEndDate": 1435356000000,
    "campaignName": "Neue Campagne",
    "campaignNumber": "1000",
    "campaignStartDate": 1434060000000,
    "campaignType": "WEBINAR",
    "createdDate": 1434011091576,
    "description": "new description",
    "lastModifiedDate": 1434011956688,
    "responsibleUserId": "885",
    "responsibleUserUsername": "test@test.de"
}
                        



{
    "error": "not found"
}
                        

/campaign

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"campaignEndDate": 1435356000000, "campaignName": "Hello Cam","campaignStartDate":
1434060000000, "campaignType": "WEBINAR","description": "new
Description","responsibleUserUsername":
"tester@test.de"}'https://<tenant>.weclapp.com/webapp/api/v1/campaign
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign
Result Format
Success Failure


{
    "id": "2237",
    "version": "0",
    "campaignName": "New Campaign",
    "campaignNumber": "1001",
    "createdDate": 1434966079061,
    "lastModifiedDate": 1434966079061
}
                        



{
    "error": "not found"
}
                        

/campaign/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d
'{"campaignEndDate": 1435356000000, "campaignName": "Hello Cam","campaignStartDate":
1434060000000, "campaignType": "WEBINAR","description": "new Description",
"responsibleUserUsername": "tester@test.de"}'
https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Result Format
Success Failure


{
    "id": "2237",
    "version": "0",
    "campaignName": "New Campaign",
    "campaignNumber": "1001",
    "createdDate": 1434966079061,
    "lastModifiedDate": 1434966079061
}
                        



{
    "error": "not found"
}
                        

/campaign/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/campaign/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campaign/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaign/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Campaign Participant

see all operations for campaign participants.

name type description required default
version integer version number No Yes
campaignId string id of the campaign Yes No
campaignnumber string number of the campaign No Yes
participation boolean whether the party participates or not Yes Yes
partyId integer id of the party Yes No

/campaignParticipant

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant
Result Format
Success Failure


{
    "result": [
        {
            "id": "2113",
            "version": "0",
            "campaignId": "2109",
            "campaignNumber": "1000",
            "createdDate": 1434011956684,
            "lastModifiedDate": 1434011956684,
            "participation": false,
            "partyId": "1374"
        },
        {
            "id": "2114",
            "version": "0",
            "campaignId": "2129",
            "campaignNumber": "1000",
            "createdDate": 143401192284,
            "lastModifiedDate": 14322956684,
            "participation": true,
            "partyId": "1234"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/campaignParticipant/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campainParticipant/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/id/:id
Result Format
Success Failure


{
            "id": "2113",
            "version": "0",
            "campaignId": "2109",
            "campaignNumber": "1000",
            "createdDate": 1434011956684,
            "lastModifiedDate": 1434011956684,
            "participation": false,
            "partyId": "1374"
}
                        



{
    "error": "not found"
}
                        

/campaignParticipant

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"campaignId" : 2122, "partyId" : 2222}'
https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant
Result Format
Success Failure


{
    "id": "2246",
    "version": "0",
    "campaignId": "2243",
    "campaignNumber": "1002",
    "createdDate": 1434969874787,
    "lastModifiedDate": 1434969874787,
    "participation": false,
    "partyId": "1374"
}
                        



{
    "error": "not found"
}
                        

/campaignParticipant/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d
'{"campaignId" : 2122, "partyId" : 2222, "participation" : true}'
https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/id/:id
Result Format
Success Failure


{
    "id": "2246",
    "version": "0",
    "campaignId": "2243",
    "campaignNumber": "1002",
    "createdDate": 1434969874787,
    "lastModifiedDate": 1434969874787,
    "participation": true,
    "partyId": "1374"
}
                        



{
    "error": "not found"
}
                        

/campaignParticipant/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/id/:id
Result Format
Success Failure


No Content
                                                        



{
    "error": "not found"
}
                        

/campaignParticipant/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/campaignParticipant/count
Result Format
Success Failure


{
    "result": 3
}
                            



{
    "error": "not found"
}
                        

Contact

see all operations for contacts.

name type description required default
version integer version of this contact No Yes
addresses array one or more addresses of this contact No Yes
birthDate timestamp birthdate of this contact No No
company string company name Yes No
company2 string second company name No No
contacts array one or more contacts for this contact No Yes
description string short discription No No
email string email address of this contact No No
fax string fax address of this contact No No
firstName string firstname of the person No No
fixPhone2 string fixed phone number No No
lastName string lastname of the person Yes No
middleName string middlename of the person No No
mobilePhone1 string cellphone number No No
mobilePhone2 string second cellphone number No No
partyType string Contacts are persons only No Yes
personCompany string name of the company No No
personDepartment string department of the person in this company No No
personRole string role of the person in this company No No
phone string phonenumber of this contact No No
phoneHome string home phonenumber of this contact No No
salutation string salutation of this person No No
title string title of this person No No
website string website of this contact No No

/contact

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/contact
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact
Result Format
Success Failure


{
    "result": [
        {
            "id": "1356",
            "version": "1",
            "addresses": [
                {
                    "id": "1358",
                    "version": "0",
                    "city": "New city",
                    "countryCode": "DE",
                    "createdDate": 1433765295352,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433765295352,
                    "primeAddress": true,
                    "street1": "Main street",
                    "zipcode": "12345"
                }
            ],
            "contacts": [],
            "createdDate": 1433764875351,
            "email": "test@test.de",
            "firstName": "John",
            "lastModifiedDate": 1433765295770,
            "lastName": "Doe",
            "partyType": "PERSON",
            "personCompany": "New Company",
            "personDepartment": "Sales & Marketing",
            "personRole": "Sales expert",
            "phone": "0815-9001020",
            "salutation": "MR",
            "website": "www.new.de"
        },
        {
            "id": "1362",
            "version": "1",
            "addresses": [
                {
                    "id": "1364",
                    "version": "0",
                    "city": "New city",
                    "countryCode": "DE",
                    "createdDate": 1433765355393,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433765355393,
                    "primeAddress": true,
                    "street1": "1st avenue",
                    "zipcode": "12345"
                }
            ],
            "contacts": [],
            "createdDate": 1433764935392,
            "email": "test2@test.de",
            "firstName": "Jane",
            "lastModifiedDate": 1433765355393,
            "lastName": "Doe",
            "partyType": "PERSON",
            "personCompany": New Company",
            "personDepartment": "Sales & Marketing",
            "personRole": "Marketing Expert",
            "phone": "0815-9001022",
            "salutation": "MRS",
            "website": "www.new.de"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/contact/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Result Format
Success Failure


{
            "id": "1356",
            "version": "1",
            "addresses": [
                {
                    "id": "1358",
                    "version": "0",
                    "city": "New city",
                    "countryCode": "DE",
                    "createdDate": 1433765295352,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433765295352,
                    "primeAddress": true,
                    "street1": "Main street",
                    "zipcode": "12345"
                }
            ],
            "contacts": [],
            "createdDate": 1433764875351,
            "email": "test@test.de",
            "firstName": "John",
            "lastModifiedDate": 1433765295770,
            "lastName": "Doe",
            "partyType": "PERSON",
            "personCompany": "New Company",
            "personDepartment": "Sales & Marketing",
            "personRole": "Sales expert",
            "phone": "0815-9001020",
            "salutation": "MR",
            "website": "www.new.de"
}
                        



{
    "error": "not found"
}
                        

/contact

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"lastName"
: "Doe", "firstName" : "John"}'
https://<tenant>.weclapp.com/webapp/api/v1/contact
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact
Result Format
Success Failure


{
            "id": "1356",
            "version": "1",
            "addresses": [],
            "contacts": [],
            "createdDate": 1433764875351,
            "firstName": "John",
            "lastName": "Doe",
            "partyType": "PERSON"
}
                        



{
    "error": "not found"
}
                        

/contact/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"lastName"
: "Doe", "firstName" : "John", "phone" : "515-55555"}'
https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Result Format
Success Failure


{
            "id": "1356",
            "version": "1",
            "addresses": [],
            "contacts": [],
            "createdDate": 1433764875351,
            "firstName": "John",
            "lastName": "Doe",
            "phone": "515-55555",
            "partyType": "PERSON"
}
                        



{
    "error": "not found"
}
                        

/contact/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/contact/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/contact/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/contact/count
Result Format
Success Failure


{
    "result": 6
}
                            



{
    "error": "not found"
}
                        

Customer

see all operations for customer.

name type description required default
version integer version of this customer No Yes
addresses array one or more addresses of this contact No Yes
amountInsured integer how high this customer is insured No No
annualRevenue integer the annual revenue of this customer No No
birthDate timestamp birthdate of the customer No No
company string Name of the company of this customer Yes No
company2 string second name of the company of this customer No No
contacts array one or more contacts for this customer No Yes
creditLimit integer limit of maximal credit No No
currencyId / currencyName integer / string id or name of the currency this customer uses No Yes
customerCategoryId / customerCategoryName integer / string id or name of the category of this customer No No
customerNumber integer number of this customer No Yes
customerRating integer rating of this customer No No
customerTopics array topics this customer manages No Yes
deliveryBlock boolean whether the delivery for this customer should be blocked or not No Yes
description string short description of this customer No No
email string email address of this customer No No
fax string fax number of this customer No No
firstName string firstname of this customer No No
insolvent boolean whether this customer is bankrupt or not No Yes
insured boolean whether this customer is insured or not No Yes
lastName string lastame of this customer Yes No
middleName string middlename of this customer No No
mobilePhone1 string mobile phone number of this customer No No
oldCustomerNumber integer number of the customer of the previous system No No
optIn boolean whether this customer will receive emails or not No Yes
partyType string whether this contact is a person or organization Yes No
paymentMethodId / paymentMethodName integer / name id or name of the used payment method No No
personCompany string name of the company this person works for No No
personDepartment string name of the department this person works in No No
personRole string name of the role this person works as No No
phone string phonenumber of this customer No No
primaryContactId integer id of the primary contact of this customer No Yes
responsibleUserFixed boolean whether user should be fixed or not No Yes
responsibleUserId / resonsibleUserUsername integer / string id or username of the responsible user No Yes
salesChannel string which sales channel should be used No Yes
salutation string the salutation for this customer No No
satisfaction string whether the customer is satisfied, neutral or unsatisfied No No
sectorId / sectorName integer / string id or name of the sector of this customer No No
salutation string the salutation for this customer No No
shipmentMethodId / shipmentMethodName integer / string id or name of the shipmen method this quotation uses No No
termOfPaymentId / termOfPaymentName integer / string id or name of term of payment No No
title string title of this customer No No
useCustomsTariffNumber boolean whether customs tariff numbers should be printed for this customer No Yes
varRegistrationNumber string number of the registration No No
website string website of this customer No No

/customer

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customer
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer
Result Format
Success Failure


{
    "result": [
        {
            "id": "835",
            "version": "0",
            "addresses": [],
            "company": "ANONYMOUS_COMPANY",
            "contacts": [
                {
                    "id": "837",
                    "version": "0",
                    "addresses": [],
                    "contacts": [],
                    "createdDate": 1433765563806,
                    "lastModifiedDate": 1433765563806,
                    "lastName": "ANONYMOUS_COMPANY",
                    "partyType": "PERSON"
                }
            ],
            "createdDate": 1433765563805,
            "currencyId": "248",
            "currencyName": "EUR",
            "customerNumber": "ANONYMOUS_DEBITOR",
            "customerTopics": [],
            "deliveryBlock": false,
            "insolvent": false,
            "insured": false,
            "lastModifiedDate": 1433765563805,
            "optIn": false,
            "partyType": "ORGANIZATION",
            "primaryContactId": "837",
            "responsibleUserFixed": false,
            "salesChannel": "NET1",
            "useCustomsTariffNumber": false
        },
        {
            "id": "1405",
            "version": "2",
            "addresses": [
                {
                    "id": "1407",
                    "version": "0",
                    "city": "New Castle",
                    "countryCode": "DE",
                    "createdDate": 1433764815549,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433764815549,
                    "primeAddress": true,
                    "street1": "New Street 1",
                    "zipcode": "54321"
                }
            ],
            "company": "Next Company",
            "contacts": [
                {
                    "id": "1368",
                    "version": "1",
                    "addresses": [
                        {
                            "id": "1370",
                            "version": "0",
                            "city": "New Castle",
                            "countryCode": "DE",
                            "createdDate": 1433764815412,
                            "deliveryAddress": false,
                            "lastModifiedDate": 1433764815412,
                            "primeAddress": true,
                            "street1": "New Street 1",
                            "zipcode": "54321"
                        }
                    ],
                    "contacts": [],
                    "createdDate": 1433763915411,
                    "email": "test@test.de",
                    "firstName": "Jane",
                    "lastModifiedDate": 1433764815567,
                    "lastName": "Doe",
                    "partyType": "PERSON",
                    "personCompany": "new Company",
                    "personRole": "Leader",
                    "phone": "04911-8020311",
                    "salutation": "MR",
                    "website": "www.next.de"
                }
    ]
}
                        



{
    "error": "not found"
}
                        

/customer/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Result Format
Success Failure


{
            "id": "835",
            "version": "0",
            "addresses": [],
            "company": "ANONYMOUS_COMPANY",
            "contacts": [
                {
                    "id": "837",
                    "version": "0",
                    "addresses": [],
                    "contacts": [],
                    "createdDate": 1433765563806,
                    "lastModifiedDate": 1433765563806,
                    "lastName": "ANONYMOUS_COMPANY",
                    "partyType": "PERSON"
                }
            ],
            "createdDate": 1433765563805,
            "currencyId": "248",
            "currencyName": "EUR",
            "customerNumber": "ANONYMOUS_DEBITOR",
            "customerTopics": [],
            "deliveryBlock": false,
            "insolvent": false,
            "insured": false,
            "lastModifiedDate": 1433765563805,
            "optIn": false,
            "partyType": "ORGANIZATION",
            "primaryContactId": "837",
            "responsibleUserFixed": false,
            "salesChannel": "NET1",
            "useCustomsTariffNumber": false
}
                        



{
    "error": "not found"
}
                        

/customer

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"partyType" : "ORGANIZATION", "company" : "New Company"}'
https://<tenant>.weclapp.com/webapp/api/v1/customer
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer
Result Format
Success Failure


{
    "id": "2271",
    "version": "0",
    "addresses": [
        {
            "id": "2273",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1434979393035,
            "deliveryAddress": false,
            "lastModifiedDate": 1434979393035,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1434979393034,
    "currencyId": "248",
    "currencyName": "EUR",
    "customerNumber": "C1008",
    "customerTopics": [],
    "deliveryBlock": false,
    "insolvent": false,
    "insured": false,
    "lastModifiedDate": 1434979393034,
    "optIn": false,
    "partyType": "ORGANIZATION",
    "responsibleUserFixed": false,
    "responsibleUserId": "885",
    "responsibleUserUsername": "testing@test.de",
    "salesChannel": "NET1",
    "useCustomsTariffNumber": false
}
                        



{
    "error": "not found"
}
                        

/customer/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"partyType"
: "ORGANIZATION", "company" : "New Company", "salesChannel" : "NET2",
"optIn" : false}'
https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Result Format
Success Failure


{
    "id": "2271",
    "version": "0",
    "addresses": [
        {
            "id": "2273",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1434979393035,
            "deliveryAddress": false,
            "lastModifiedDate": 1434979393035,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1434979393034,
    "currencyId": "248",
    "currencyName": "EUR",
    "customerNumber": "C1008",
    "customerTopics": [],
    "deliveryBlock": false,
    "insolvent": false,
    "insured": false,
    "lastModifiedDate": 1434979393034,
    "optIn": false,
    "partyType": "ORGANIZATION",
    "responsibleUserFixed": false,
    "responsibleUserId": "885",
    "responsibleUserUsername": "maximilian.klingelhoefer@risima.de",
    "salesChannel": "NET2",
    "useCustomsTariffNumber": false
}
                        



{
    "error": "not found"
}
                        

/customer/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/customer/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customer/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/customer/count
Result Format
Success Failure


{
    "result": 6
}
                            



{
    "error": "not found"
}
                        

Customer Category

see all operations for customer categories.

name type description required default
name string name of the category Yes No
version integer version of this customer category No Yes

/customerCategory

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory
Result Format
Success Failure


{
    "result": [
        {
            "id": "1208",
            "version": "0",
            "createdDate": 1433765714903,
            "lastModifiedDate": 1433765714903,
            "name": "Premium"
        },
        {
            "id": "1209",
            "version": "0",
            "createdDate": 1433765714903,
            "lastModifiedDate": 1433765714903,
            "name": "Standard"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/customerCategory/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "Standard"
}
                        



{
    "error": "not found"
}
                        

/customerCategory

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"Power User"}'
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "Power User"
}
                        



{
    "error": "not found"
}
                        

/customerCategory/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"Power User 2"}'
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "Power User 2"
}
                        



{
    "error": "not found"
}
                        

/customerCategory/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/customerCategory/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerCategory/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Customer Topic

see all operations for customer topics.

name type description required default
name string name of the topic Yes No
version integer version of this customer topic No Yes
active boolean whether the topic can be used or not Yes Yes
positionNumber integer position of this topic No Yes

/customerTopic

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic
Result Format
Success Failure


{
    "result": [
        {
            "id": "1208",
            "version": "0",
            "active": true,
            "createdDate": 1433765714903,
            "lastModifiedDate": 1433765714903,
            "name": "IT Security"
        },
        {
            "id": "1209",
            "version": "0",
            "active": true,
            "createdDate": 1433765714903,
            "lastModifiedDate": 1433765714903,
            "name": "Consulting"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/customerTopic/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "It Security",
    "positionNumber": 1
}
                        



{
    "error": "not found"
}
                        

/customerTopic

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"IT Security"}'
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "IT Security",
    "positionNumber" : 1
}
                        



{
    "error": "not found"
}
                        

/customerTopic/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"Consulting"}'
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Result Format
Success Failure


{
    "id": "1209",
    "version": "0",
    "createdDate": 1433765714903,
    "lastModifiedDate": 1433765714903,
    "name": "Consulting",
    "positionNumber": 2
}
                        



{
    "error": "not found"
}
                        

/customerTopic/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/customerTopic/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/customerTopic/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Document

see all operations for documents.
/document

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/document
Definition https://<tenant>.weclapp.com/webapp/api/v1/document
Result Format
Success Failure



                        



{
    "error": "not found"
}
                        

/document/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Result Format
Success Failure



                        



{
    "error": "not found"
}
                        

/document/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Result Format
Success Failure



                        



{
    "error": "not found"
}
                        

/document/id/:id/download

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/download
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/download
Result Format
Success Failure


No Content
                        



{
    "error": "not found"
}
                        

/document/id/:id/upload

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -d /path/to/file.txt
https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/upload
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/upload
Result Format
Success Failure


No Content
                        



{
    "error": "not found"
}
                        

/document/upload

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -d /path/to/file.txt
https://<tenant>.weclapp.com/webapp/api/v1/document/upload
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/upload
Result Format
Success Failure


No Content
                        



{
    "error": "not found"
}
                        

/document/id/:id/downloadDocumentVersion

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/downloadDocumentVersion
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id/downloadDocumentVersion
Result Format
Success Failure



                        



{
    "error": "not found"
}
                        

/document/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/document/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/document/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/document/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

Lead

see all operations for leads.

name type description required default
version integer version of this lead No Yes
addresses array holds all addresses No Yes
annualRevenue integer how much this lead earns per year No No
birthDate timestamp date of birth of this lead No No
company string name of the company Yes No
company2 string name of another company No No
contacts array holds all contacts No Yes
currencyId / currencyName integer / name id ot name of the currency which this lead is using No Yes
description string short description of this lead No No
email string email address of this lead No No
fax string the fax number of this lead No No
firstName string firstname of this lead No No
lastName string lastname of this lead Yes No
leadRating string whether this lead is promising or not No Yes
leadStatus string whether this lead is new or qualified Yes Yes
leadTopics array topics which this lead manages No Yes
middleName string middlename of this lead No No
mobilePhone1 string mobile number of this lead No No
oldLeadNumber string lead number of a previous system No No
optIn boolean whether this lead will receive emails or not No Yes
partyType string whether this lead is a person or an organization Yes No
personCompany string name of the company of this person No No
personDepartment string department this lead works for No No
personRole string the role of this lead in this department No No
phone string phonenumber of this lead No No
primaryContactId integer id of the primary contact of this lead No Yes
responsibleUserFixed boolean if true then the responsible user will not be updated automatically by the application No Yes
responsibleUserId / responsibleUserUsername integer / string id or name of the responsible user of this lead No Yes
salesChannel string which sales channel this lead uses Yes Yes
salutation string the salutation of this lead No No
sectorId / sectorName integer the Id or name of the sector this lead manages No No
title string the title of this lead No No
website string the website of this lead No No

/lead

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/lead
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead
Result Format
Success Failure


{
    "result": [
         {
            "id": "1449",
            "version": "0",
            "addresses": [
                {
                    "id": "1451",
                    "version": "0",
                    "city": "Frankfurt",
                    "countryCode": "DE",
                    "createdDate": 1432556115970,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1432556115970,
                    "primeAddress": true,
                    "street1": "Mainstreet 22",
                    "zipcode": "60311"
                }
            ],
            "contacts": [
                {
                    "id": "1386",
                    "version": "1",
                    "addresses": [
                        {
                            "id": "1388",
                            "version": "0",
                            "city": "Frankfurt",
                            "countryCode": "DE",
                            "createdDate": 1432556115470,
                            "deliveryAddress": false,
                            "lastModifiedDate": 1432556115470,
                            "primeAddress": true,
                            "street1": "Mainstreet 22",
                            "zipcode": "60311"
                        }
                    ],
                    "contacts": [],
                    "createdDate": 1431346515469,
                    "email": "doe@email.de",
                    "firstName": "John",
                    "lastModifiedDate": 1432556115984,
                    "lastName": "Doe",
                    "partyType": "PERSON",
                    "phone": "069-9080703",
                    "salutation": "MR"
                }
            ],
            "createdDate": 1432556115969,
            "currencyId": "248",
            "currencyName": "EUR",
            "email": "doe@email.de",
            "firstName": "John",
            "lastModifiedDate": 1432556115970,
            "lastName": "Doe",
            "leadNumber": "1002",
            "leadStatus": "QUALIFIED",
            "leadTopics": [
                {
                    "id": "1402",
                    "name": "Website Programming"
                },
                {
                    "id": "1401",
                    "name": "Online Marketing"
                },
                {
                    "id": "1403",
                    "name": "Marketing Material"
                }
            ],
            "optIn": true,
            "partyType": "PERSON",
            "phone": "069-9080703",
            "primaryContactId": "1386",
            "responsibleUserFixed": false,
            "responsibleUserId": "1349",
            "responsibleUserUsername": "test@example.com",
            "salesChannel": "NET1",
            "salutation": "MR"
        },
        {
            "id": "2158",
            "version": "1",
            "addresses": [
                {
                    "id": "2160",
                    "version": "1",
                    "city": "New City",
                    "countryCode": "CH",
                    "createdDate": 1434037735258,
                    "deliveryAddress": true,
                    "lastModifiedDate": 1434038071483,
                    "primeAddress": true,
                    "street1": "New Street 1",
                    "zipcode": "939439"
                }
            ],
            "company": "New Company",
            "contacts": [],
            "createdDate": 1434037735258,
            "currencyId": "248",
            "currencyName": "EUR",
            "lastModifiedDate": 1434038071483,
            "leadNumber": "1003",
            "leadStatus": "NEW",
            "leadTopics": [],
            "optIn": false,
            "partyType": "ORGANIZATION",
            "responsibleUserFixed": false,
            "responsibleUserId": "885",
            "responsibleUserUsername": "testing@test.de",
            "salesChannel": "NET1"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/lead/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Result Format
Success Failure


{
        "id": "2158",
        "version": "1",
        "addresses": [
                {
                        "id": "2160",
                        "version": "1",
                        "city": "New City",
                        "countryCode": "CH",
                        "createdDate": 1434037735258,
                        "deliveryAddress": true,
                        "lastModifiedDate": 1434038071483,
                        "primeAddress": true,
                        "street1": "New Street 1",
                        "zipcode": "939439"
                }
        ],
        "company": "New Company",
        "contacts": [],
        "createdDate": 1434037735258,
        "currencyId": "248",
        "currencyName": "EUR",
        "lastModifiedDate": 1434038071483,
        "leadNumber": "1003",
        "leadStatus": "NEW",
        "leadTopics": [],
        "optIn": false,
        "partyType": "ORGANIZATION",
        "responsibleUserFixed": false,
        "responsibleUserId": "885",
        "responsibleUserUsername": "testing@test.de",
        "salesChannel": "NET1"
}
                        



{
    "error": "not found"
}
                        

/lead

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"partyType": "ORGANIZATION", "company" : "New Company"}'
https://<tenant>.weclapp.com/webapp/api/v1/lead
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead
Result Format
Success Failure


{
    "id": "2316",
    "version": "0",
    "addresses": [
        {
            "id": "2318",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1435043755884,
            "deliveryAddress": false,
            "lastModifiedDate": 1435043755884,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1435043755884,
    "currencyId": "248",
    "currencyName": "EUR",
    "lastModifiedDate": 1435043755884,
    "leadNumber": "1006",
    "leadStatus": "NEW",
    "leadTopics": [],
    "optIn": false,
    "partyType": "ORGANIZATION",
    "responsibleUserFixed": false,
    "responsibleUserId": "885",
    "responsibleUserUsername": "maximilian.klingelhoefer@risima.de",
    "salesChannel": "NET1"
}

                        



{
    "error": "not found"
}
                        

/lead/id/:id

EXAMPLE:

curl  -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d
'{"partyType": "ORGANIZATION", "company" : "New Company", "salesChannel":
"NET2", "leadStatus" : "QUALIFIED"}' https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Result Format
Success Failure


{
    "id": "2316",
    "version": "4",
    "addresses": [
        {
            "id": "2323",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1435043862510,
            "deliveryAddress": false,
            "lastModifiedDate": 1435043862510,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1435043755884,
    "lastModifiedDate": 1435043862512,
    "leadNumber": "1007",
    "leadStatus": "QUALIFIED",
    "leadTopics": [],
    "optIn": false,
    "partyType": "ORGANIZATION",
    "responsibleUserFixed": false,
    "responsibleUserId": "885",
    "responsibleUserUsername": "maximilian.klingelhoefer@risima.de",
    "salesChannel": "NET2"
}
                        



{
    "error": "not found"
}
                        

/lead/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/lead/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/lead/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/lead/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

Meta

see all operations for the meta.
/meta/resources

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/meta/resources
Definition https://<tenant>.weclapp.com/webapp/api/v1/meta/resources
Result Format
Success Failure


{
    "result": [
                 "/article": {
            "/count": {
                "GET": {
                    "type": "COUNT",
                    "url": "https://asdfghjk.weclapp.com/webapp/api/v1/article/count"
                }
            },
            "/id": {
                "/{id}": {
                    "GET": {
                        "type": "GET_INSTANCE",
                        "url": "https://asdfghjk.weclapp.com/webapp/api/v1/article/id/{id}"
                    }
                }
            },
            "GET": {
                "type": "QUERY",
                "url": "https://asdfghjk.weclapp.com/webapp/api/v1/article"
            }
        },
        "/articleCategory": {
            "/count": {
                "GET": {
                    "type": "COUNT",
                    "url": "https://asdfghjk.weclapp.com/webapp/api/v1/articleCategory/count"
                }
            },
            "/id": {
                "/{id}": {
                    "GET": {
                        "type": "GET_INSTANCE",
                        "url": "https://asdfghjk.weclapp.com/webapp/api/v1/articleCategory/id/{id}"
                    }
                }
            },
            "GET": {
                "type": "QUERY",
                "url": "https://asdfghjk.weclapp.com/webapp/api/v1/articleCategory"
            }
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/meta/queryFilterProperties/?resource=:resource

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/meta/queryFilterProperties/?resource=lead
Definition https://<tenant>.weclapp.com/webapp/api/v1/meta/queryFilterProperties/?resource=:resource
Result Format
Success Failure


{
    "result": [
        {
            "name": "annualRevenue"
        },
        {
            "name": "birthDate"
        },
        {
            "name": "company"
        },
        {
            "name": "company2"
        },
        {
            "name": "createdDate"
        },
        {
            "name": "currency.createdDate"
        },
        {
            "name": "currency.currencySymbol"
        },
        {
            "name": "currency.id"
        },
        {
            "name": "currency.lastModifiedDate"
        },
        {
            "name": "currency.name"
        },
        {
            "name": "currency.version"
        },
        {
            "name": "currencyId"
        },
        {
            "name": "currencyName"
        },
        {
            "name": "description"
        },
        {
            "name": "email"
        },
        {
            "name": "fax"
        },
        {
            "name": "firstName"
        },
        {
            "name": "id"
        },
        {
            "name": "lastModifiedDate"
        },
        {
            "name": "lastName"
        },
        {
            "name": "leadNumber"
        },
        {
            "name": "leadRating"
        },
        {
            "name": "leadStatus"
        },
        {
            "name": "middleName"
        },
        {
            "name": "oldLeadNumber"
        },
        {
            "name": "optIn"
        },
        {
            "name": "partyType"
        },
        {
            "name": "personCompany"
        },
        {
            "name": "personDepartment"
        },
        {
            "name": "personRole"
        },
        {
            "name": "phone"
        },
        {
            "name": "primaryContactId"
        },
        {
            "name": "responsibleUserFixed"
        },
        {
            "name": "responsibleUserId"
        },
        {
            "name": "responsibleUserUsername"
        },
        {
            "name": "salesChannel"
        },
        {
            "name": "salutation"
        },
        {
            "name": "sectorId"
        },
        {
            "name": "sectorName"
        },
        {
            "name": "title"
        },
        {
            "name": "version"
        },
        {
            "name": "website"
        }
    ]
}
                                                        



{
    "error": "unknown resource"
}
                        

/meta/querySortProperties/?resource=:resource

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/meta/querySortProperties/?resource=user
Definition https://<tenant>.weclapp.com/webapp/api/v1/meta/querySortProperties/?resource=:resource
Result Format
Success Failure


{
    "result": [
        {
            "name": "createdDate"
        },
        {
            "name": "email"
        },
        {
            "name": "faxNumber"
        },
        {
            "name": "firstName"
        },
        {
            "name": "id"
        },
        {
            "name": "lastModifiedDate"
        },
        {
            "name": "lastName"
        },
        {
            "name": "mobilePhoneNumber"
        },
        {
            "name": "phoneNumber"
        },
        {
            "name": "username"
        },
        {
            "name": "version"
        }
    ]
}
                                                        



{
    "error": "unknown resource"
}
                        

Payment Method

see all operations for payment methods.
/paymentMethod

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod
Definition https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod
Result Format
Success Failure


{
    "result": [
        {
            "id": "1055",
            "version": "0",
            "createdDate": 1433765714644,
            "lastModifiedDate": 1433765714644,
            "name": "EC-Card"
        },
        {
            "id": "1056",
            "version": "0",
            "createdDate": 1433765714646,
            "lastModifiedDate": 1433765714646,
            "name": "Credit card"
        }
        ]
}
                        



{
    "error": "not found"
}
                        

/paymentMethod/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod/id/:id
Result Format
Success Failure


{
        "id": "1056",
        "version": "0",
        "createdDate": 1433765714646,
        "lastModifiedDate": 1433765714646,
        "name": "Credit card"
}
                        



{
    "error": "not found"
}
                        

/paymentMethod/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/paymentMethod/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

Production Order

see all operations for production orders.

name type description required default
quantity integer quantity of products Yes No
productionOrderNumber integer number of the production order Yes No

/productionOrder/fastProductionBooking

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"quantity": 200, "productionOrderNumber": 2199}'
https://<tenant>.weclapp.com/webapp/api/v1/productionOrder/fastProductionBooking
Definition https://<tenant>.weclapp.com/webapp/api/v1/productionOrder/fastProductionBooking
Result Format
Success Failure


{
    "result": {
        "message": "SUCCESS",
        "success": true
    }
}
                        



{
    "result": {
        "message": "INVALID_ORDER_NUMBER",
        "success": false
    }
}
                        

Quotation

see all operations for quotations.

name type description required default
version integer version of this quotation No No
commercialLanguage string used languager No No
commission integer commission No No
customerId integer id of involved customer Yes No
customerNumber integer number of involved customer No Yes
deliveryAddress array holds delivery addresses No Yes
invoiceAddress array holds invoice addresses No Yes
leadId integer id of involved lead Yes No
leadNumber integer number of involved lead No Yes
paymentMethodId integer id of the payment method which this quotation is using No No
paymentMethodName string name of the payment method which this quotation is using No No
pricingDate timestamp quotation is valid thru this date No Yes
quotationDate timestamp quotation starts a this date No Yes
quotationItems array holds all items which are used in this quotation No Yes
quotationNumber integer number of this quotation No Yes
recordAddress array Main address No Yes
recordComment string custom comment for the pdf No No
recordCurrencyId / recordCurrencyName integer / name id or name of the currency of this quotation No Yes
recordFreeText string custom text visible on the pdf No No
recordOpening string custom text at the beginning of pdf No No
responsibleUserId / responsibleUserUsername integer / string id or name of the user who is repsonsible for this quotation No No
shipmentMethodId / shipmentMethodName integer / string id or name of the shipmen method this quotation uses No No
status string whether this quotation is accepted, rejected or in progress No Yes
termOfPaymentId / termOfPaymentName integer / string id or name of term of payment No No

/quotation

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/quotation
Definition https://<tenant>.weclapp.com/webapp/api/v1/quotation
Result Format
Success Failure


{
    "result": [
        {
            "id": "1473",
            "version": "4",
            "createdDate": 1425816916120,
            "customerId": "1413",
            "customerNumber": "C1001",
            "deliveryAddress": {
                "countryCode": "DE"
            },
            "invoiceAddress": {
                "countryCode": "DE"
            },
            "lastModifiedDate": 1425816916165,
            "pricingDate": 1425816916120,
            "quotationDate": 1425816916103,
            "quotationItems": [
                {
                    "id": "1476",
                    "version": "0",
                    "articleId": "1457",
                    "articleNumber": "DemoTA1",
                    "createdDate": 1425816916141,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1425816916141,
                    "manualUnitPrice": false,
                    "positionNumber": 1,
                    "quantity": "2",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                },
                {
                    "id": "1477",
                    "version": "0",
                    "articleId": "1458",
                    "articleNumber": "DemoTA2",
                    "createdDate": 1425816916152,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1425816916152,
                    "manualUnitPrice": false,
                    "positionNumber": 2,
                    "quantity": "5",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                },
                {
                    "id": "1478",
                    "version": "0",
                    "articleId": "1459",
                    "articleNumber": "DemoTA3",
                    "createdDate": 1425816916158,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1425816916158,
                    "manualUnitPrice": false,
                    "positionNumber": 3,
                    "quantity": "10",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                }
            ],
            "quotationNumber": "1000",
            "recordAddress": {
                "countryCode": "DE"
            },
            "recordCurrencyId": "248",
            "recordCurrencyName": "EUR",
            "responsibleUserId": "1349",
            "responsibleUserUsername": "test@example.com",
            "status": "REJECTED"
        },
        {
            "id": "1482",
            "version": "4",
            "createdDate": 1428495316183,
            "customerId": "1413",
            "customerNumber": "C1001",
            "deliveryAddress": {
                "countryCode": "DE"
            },
            "invoiceAddress": {
                "countryCode": "DE"
            },
            "lastModifiedDate": 1428495316213,
            "pricingDate": 1428495316183,
            "quotationDate": 1428495316176,
            "quotationItems": [
                {
                    "id": "1485",
                    "version": "0",
                    "articleId": "1457",
                    "articleNumber": "DemoTA1",
                    "createdDate": 1428495316194,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1428495316194,
                    "manualUnitPrice": false,
                    "positionNumber": 1,
                    "quantity": "2",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                },
                {
                    "id": "1486",
                    "version": "0",
                    "articleId": "1458",
                    "articleNumber": "DemoTA2",
                    "createdDate": 1428495316200,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1428495316200,
                    "manualUnitPrice": false,
                    "positionNumber": 2,
                    "quantity": "5",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                },
                {
                    "id": "1487",
                    "version": "0",
                    "articleId": "1459",
                    "articleNumber": "DemoTA3",
                    "createdDate": 1428495316206,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1428495316206,
                    "manualUnitPrice": false,
                    "positionNumber": 3,
                    "quantity": "10",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales Tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "0"
                }
            ],
            "quotationNumber": "1001",
            "recordAddress": {
                "countryCode": "DE"
            },
            "recordCurrencyId": "248",
            "recordCurrencyName": "EUR",
            "responsibleUserId": "1349",
            "responsibleUserUsername": "test@example.com",
            "status": "ACCEPTED"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/quotation/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/quotation/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/quotation/id/:id
Result Format
Success Failure


{
        "id": "1482",
        "version": "4",
        "createdDate": 1428495316183,
        "customerId": "1413",
        "customerNumber": "C1001",
        "deliveryAddress": {
                "countryCode": "DE"
        },
        "invoiceAddress": {
                "countryCode": "DE"
        },
        "lastModifiedDate": 1428495316213,
        "pricingDate": 1428495316183,
        "quotationDate": 1428495316176,
        "quotationItems": [
                {
                        "id": "1485",
                        "version": "0",
                        "articleId": "1457",
                        "articleNumber": "DemoTA1",
                        "createdDate": 1428495316194,
                        "description": "Testarticle",
                        "discountPercentage": "0",
                        "lastModifiedDate": 1428495316194,
                        "manualUnitPrice": false,
                        "positionNumber": 1,
                        "quantity": "2",
                        "reductionAdditionItems": [],
                        "taxId": "907",
                        "taxName": "Sales Tax",
                        "unitId": "926",
                        "unitName": "pc.",
                        "unitPrice": "0"
                },
                {
                        "id": "1486",
                        "version": "0",
                        "articleId": "1458",
                        "articleNumber": "DemoTA2",
                        "createdDate": 1428495316200,
                        "description": "Testarticle",
                        "discountPercentage": "0",
                        "lastModifiedDate": 1428495316200,
                        "manualUnitPrice": false,
                        "positionNumber": 2,
                        "quantity": "5",
                        "reductionAdditionItems": [],
                        "taxId": "907",
                        "taxName": "Sales Tax",
                        "unitId": "926",
                        "unitName": "pc.",
                        "unitPrice": "0"
                },
                {
                        "id": "1487",
                        "version": "0",
                        "articleId": "1459",
                        "articleNumber": "DemoTA3",
                        "createdDate": 1428495316206,
                        "description": "Testarticle",
                        "discountPercentage": "0",
                        "lastModifiedDate": 1428495316206,
                        "manualUnitPrice": false,
                        "positionNumber": 3,
                        "quantity": "10",
                        "reductionAdditionItems": [],
                        "taxId": "907",
                        "taxName": "Sales Tax",
                        "unitId": "926",
                        "unitName": "pc.",
                        "unitPrice": "0"
                }
        ],
        "quotationNumber": "1001",
        "recordAddress": {
                "countryCode": "DE"
        },
        "recordCurrencyId": "248",
        "recordCurrencyName": "EUR",
        "responsibleUserId": "1349",
        "responsibleUserUsername": "test@example.com",
        "status": "ACCEPTED"
}
                        



{
    "error": "not found"
}
                        

/quotation

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"leadId" :
1428}'
https://<tenant>.weclapp.com/webapp/api/v1/quotation
Definition https://<tenant>.weclapp.com/webapp/api/v1/quotation
Result Format
Success Failure


{
    "id": "2370",
    "version": "0",
    "createdDate": 1435052989583,
    "deliveryAddress": {
        "city": "New Town",
        "company": "New Company",
        "countryCode": "DE",
        "street1": "Mainstreet 2a",
        "zipcode": "12345"
    },
    "invoiceAddress": {
        "city": "New Town",
        "company": "New Company",
        "countryCode": "DE",
        "street1": "Mainstreet 2a",
        "zipcode": "12345"
    },
    "lastModifiedDate": 1435052989583,
    "quotationId": "1428",
    "quotationNumber": "1000",
    "pricingDate": 1435052989574,
    "quotationDate": 1435052989548,
    "quotationItems": [],
    "quotationNumber": "1007",
    "recordAddress": {
        "city": "New Town",
        "company": "New Company",
        "countryCode": "DE",
        "street1": "Mainstreet 2a",
        "zipcode": "12345"
    },
    "recordCurrencyId": "248",
    "recordCurrencyName": "EUR",
    "responsibleUserId": "1349",
    "responsibleUserUsername": "test@example.com",
    "status": "OPEN"
}
                        



{
    "error": "not found"
}
                        

/quotation/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/quotation/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/quotation/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Sales Order

see all operations for sales orders.

name type description required default
version integer version of this sales order No Yes
commercialLanguage string used languager No No
commission integer commission of this customer No No
customerId integer id of involved customer Yes No
customerNumber integer number of involved customer No Yes
deliveryAddress array holds delivery addresses No Yes
invoiceAddress array holds invoice addresses No Yes
nonStandardTaxId / nonStandardTaxName integer / string id or name of the non standard tax No No
orderDate timestamp date at which this order was given No Yes
orderItems array holds all items which are used in this sales order No Yes
orderNumber string number of this order No Yes
paymentMethodId / paymentMethodName integer / string id or name of the payment method which this sales order is using No No
pricingDate timestamp sales order is valid thru this date No Yes
quotationId integer id of related quotation No No
quotationNumber integer number of related quotation No No
recordAddress array address of the person visible on the pdf No Yes
recordComment string custom comment of the pdf No No
recordCurrencyId / recordCurrencyName integer / string id or name of the currency visible on the pdf No Yes
recordFreeText string custom text visible on the pdf No No
recordOpening string custom text at the beginning of the pdf No No
responsibleUserId / responsibleUserUsername integer / string id or name of the user who is repsonsible for this sales order No Yes
salesOrderPaymentType string how the sales order should be payed No Yes
shipmentMethodId / shipmentMethodName integer / string id or name of the shipmen method this sales order uses No No
status string whether this sales order is accepted, rejected or in progress No Yes
termOfPaymentId / termOfPaymentName integer / string id or name of the terms of payment which are used No No
withShipment boolean whether the items should be shipped or not No Yes

/salesOrder

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/salesOrder
Definition https://<tenant>.weclapp.com/webapp/api/v1/salesOrder
Result Format
Success Failure


{
    "result": [
        {
            "id": "1715",
            "version": "10",
            "commercialLanguage": "de",
            "commission": "564545454",
            "createdDate": 1433766479780,
            "customerId": "1603",
            "deliveryAddress": {
                "city": "Linden",
                "company": "New Company",
                "countryCode": "DE",
                "firstName": "John",
                "lastName": "Doe",
                "street1": "New Street 88a"
            },
            "invoiceAddress": {
                "city": "Linden",
                "company": "New Company",
                "countryCode": "DE",
                "firstName": "John",
                "lastName": "Doe",
                "street1": "BuNew Street 88a"
            },
            "lastModifiedDate": 1433767086895,
            "orderDate": 1433714400000,
            "orderItems": [
                {
                    "id": "1728",
                    "version": "3",
                    "articleId": "1457",
                    "articleNumber": "DemoTA1",
                    "createdDate": 1433767056431,
                    "description": "Testarticle",
                    "discountPercentage": "0",
                    "lastModifiedDate": 1433767086728,
                    "manualUnitPrice": true,
                    "positionNumber": 1,
                    "quantity": "5",
                    "reductionAdditionItems": [],
                    "taxId": "907",
                    "taxName": "Sales tax",
                    "unitId": "926",
                    "unitName": "pc.",
                    "unitPrice": "40"
                }
            ],
            "orderNumber": "1000",
            "paymentMethodId": "1056",
            "paymentMethodName": "Cash",
            "pricingDate": 1433766486660,
            "recordAddress": {
                "city": "Linden",
                "company": "New Company",
                "countryCode": "DE",
                "firstName": "John",
                "lastName": "Doe",
                "street1": "New Street 88a"
            },
            "recordCurrencyId": "248",
            "recordCurrencyName": "EUR",
            "salesOrderPaymentType": "COUNTER_SALES",
            "status": "CLOSED",
            "withShipment": true
        },
        {
            "id": "1838",
            "version": "1",
            "createdDate": 1433769507139,
            "customerId": "835",
            "customerNumber": "ANONYMOUS_DEBITOR",
            "deliveryAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
            },
            "invoiceAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
            },
            "lastModifiedDate": 1433771521328,
            "orderDate": 1433714400000,
            "orderItems": [],
            "orderNumber": "1001",
            "paymentMethodId": "1056",
            "paymentMethodName": "Cash",
            "pricingDate": 1433769510233,
            "recordAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
            },
            "recordCurrencyId": "248",
            "recordCurrencyName": "EUR",
            "salesOrderPaymentType": "COUNTER_SALES",
            "status": "ORDER_ENTRY_IN_PROGRESS",
            "withShipment": true
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/salesOrder/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/id/:id
Result Format
Success Failure


{
        "id": "1838",
        "version": "1",
        "createdDate": 1433769507139,
        "customerId": "835",
        "customerNumber": "ANONYMOUS_DEBITOR",
        "deliveryAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
        },
        "invoiceAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
        },
        "lastModifiedDate": 1433771521328,
        "orderDate": 1433714400000,
        "orderItems": [],
        "orderNumber": "1001",
        "paymentMethodId": "1056",
        "paymentMethodName": "Cash",
        "pricingDate": 1433769510233,
        "recordAddress": {
                "company": "ANONYMOUS_COMPANY",
                "countryCode": "DE"
        },
        "recordCurrencyId": "248",
        "recordCurrencyName": "EUR",
        "salesOrderPaymentType": "COUNTER_SALES",
        "status": "ORDER_ENTRY_IN_PROGRESS",
        "withShipment": true
}
                        



{
    "error": "not found"
}
                        

/salesOrder

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d
'{"customerId" : "835"}'
https://<tenant>.weclapp.com/webapp/api/v1/salesOrder
Definition https://<tenant>.weclapp.com/webapp/api/v1/salesOrder
Result Format
Success Failure


{
    "id": "2381",
    "version": "0",
    "createdDate": 1435056712899,
    "customerId": "835",
    "customerNumber": "ANONYMOUS_DEBITOR",
    "deliveryAddress": {
        "company": "ANONYMOUS_COMPANY",
        "countryCode": "DE"
    },
    "invoiceAddress": {
        "company": "ANONYMOUS_COMPANY",
        "countryCode": "DE"
    },
    "lastModifiedDate": 1435056712909,
    "orderDate": 1435056712899,
    "orderItems": [],
    "orderNumber": "1004",
    "pricingDate": 1435056712905,
    "recordAddress": {
        "company": "ANONYMOUS_COMPANY",
        "countryCode": "DE"
    },
    "recordCurrencyId": "248",
    "recordCurrencyName": "EUR",
    "salesOrderPaymentType": "STANDARD",
    "status": "ORDER_ENTRY_IN_PROGRESS",
    "withShipment": true
}
                        



{
    "error": "not found"
}
                        

/salesOrder/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/salesOrder/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Sector

see all operations for sector.

name type description required default
version integer version of this sector No Yes
name string name of this sector Yes No
active boolean whether this sector can be used or not Yes Yes
positionNumber integer position of this sector in the sector list No No

/sector

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/sector
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector
Result Format
Success Failure


{
    "result": [
        {
            "id": "1177",
            "version": "0",
            "active": true,
            "createdDate": 1433765714868,
            "lastModifiedDate": 1433765714868,
            "name": "IT Marketing",
            "positionNumber": 1
        },
        {
            "id": "1178",
            "version": "0",
            "active": true,
            "createdDate": 1433765714869,
            "lastModifiedDate": 1433765714869,
            "name": "Consulting",
            "positionNumber": 2
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/sector/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Result Format
Success Failure


 {
        "id": "1177",
        "version": "0",
        "active": true,
        "createdDate": 1433765714868,
        "lastModifiedDate": 1433765714868,
        "name": "IT Marketing",
        "positionNumber": 1
}
                        



{
    "error": "not found"
}
                        

/sector

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"IT Marketing"}'
https://<tenant>.weclapp.com/webapp/api/v1/sector
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector
Result Format
Success Failure


{
    "id": "2386",
    "version": "0",
    "active": true,
    "createdDate": 1435065314728,
    "lastModifiedDate": 1435065314728,
    "name": "IT Marketing",
    "positionNumber": 11
}
                        



{
    "error": "not found"
}
                        

/sector/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"Consulting", "active" : false}'
https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Result Format
Success Failure


{
    "id": "2386",
    "version": "0",
    "active": false,
    "createdDate": 1435065314728,
    "lastModifiedDate": 1435065314728,
    "name": "Consulting",
    "positionNumber": 11
}
                        



{
    "error": "not found"
}
                        

/sector/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/sector/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/sector/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/sector/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Shipment Method

see all operations for shipment methods.

name type description required default
version integer version of this shipment method No Yes
name string name of this shipment method No No

/shipmentMethod

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod
Result Format
Success Failure


{
    "result": [
        {
            "id": "1010",
            "version": "0",
            "createdDate": 1433765714601,
            "description": "Customer will collect it",
            "lastModifiedDate": 1433765714601,
            "name": "Will collect"
        },
        {
            "id": "1011",
            "version": "0",
            "createdDate": 1433765714601,
            "description": null,
            "lastModifiedDate": 1433765714601,
            "name": "DHL"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/shipmentMethod/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Result Format
Success Failure


 {
        "id": "1011",
        "version": "0",
        "createdDate": 1433765714601,
        "description": null,
        "lastModifiedDate": 1433765714601,
        "name": "DHL"
}
                        



{
    "error": "not found"
}
                        

/shipmentMethod

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"Will collect"}'
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod
Result Format
Success Failure


 {
        "id": "1021",
        "version": "0",
        "createdDate": 1433765714601,
        "description": null,
        "lastModifiedDate": 1433765714601,
        "name": "Will collect"
}
                        



{
    "error": "not found"
}
                        

/shipmentMethod/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"Shipping by UPS", "description" : "UPS will ship it"}'
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Result Format
Success Failure


 {
        "id": "1021",
        "version": "0",
        "createdDate": 1433765714601,
        "description": "UPS will ship it",
        "lastModifiedDate": 1433765714601,
        "name": "Shipping by UPS"
}
                        



{
    "error": "not found"
}
                        

/shipmentMethod/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/shipmentMethod/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/shipmentMethod/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Supplier

see all operations for suppliers.

name type description required default
version integer version of this supplier No Yes
addresses array holds all addresses of this supplier No Yes
birthDate timestamp the birthdate of this supplier No No
company string the name of this company Yes No
company2 string second name of this company No No
contacts array holds all contacts of this supplier No Yes
currencyId / currencyName integer / string id or name of the currency this supplier uses No Yes
description string short description of this supplier No No
email string email address of this supllier No No
fax integer fax number of this supplier No No
firstName string firstname of this supplier No No
lastName string lastname of this supplier No No
middleName string middlename of this supplier No No
mobilePhone1 string mobilephone number of this supplier No No
orderBlock boolean whether orders should be blocked or not No Yes
partyType string supplier is always an organization No Yes
paymentMethodId / paymentMethodName integer / string id or name of the payment method which this supplier is using No No
personCompany string name of the company No No
personDepartment string department of the person in this company No No
personRole string role of the person in this company No No
phone string phonenumber of this supplier No No
primaryContactId string id of the primary contact of this supplier No No
salutation string salutation of this person No No
shipmentMethodId / shipmentMethodName integer / string id or name of the shipment method this supplier uses No No
supplierNumber integer number of this supplier No Yes
supplierRating string rating of this supplier No No
termOfPaymentId / termOfPaymentName integer / string id or name of the terms of payment that should be used for this supplier No No
title string title of this person No No
vatRegistrationNumber integer registration number for vat of this supplier No No
website string website of this supplier No No

/supplier

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/supplier
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier
Result Format
Success Failure


{
    "result": [
         {
            "id": "1662",
            "version": "0",
            "addresses": [
                {
                    "id": "1664",
                    "version": "0",
                    "city": "Dillenburg",
                    "countryCode": "DE",
                    "createdDate": 1433765946153,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433765946153,
                    "primeAddress": true,
                    "street1": "Mainstreet 1",
                    "zipcode": "2223"
                }
            ],
            "company": "DeliveryCompany",
            "contacts": [],
            "createdDate": 1433765946152,

            "lastModifiedDate": 1433765946153,
            "orderBlock": false,
            "partyType": "ORGANIZATION",
            "supplierNumber": "1000"
        },
        {
            "id": "1813",
            "version": "0",
            "addresses": [
                {
                    "id": "1815",
                    "version": "0",
                    "countryCode": "DE",
                    "createdDate": 1433769202127,
                    "deliveryAddress": false,
                    "lastModifiedDate": 1433769202127,
                    "primeAddress": true
                }
            ],
            "company": "New Company",
            "contacts": [],
            "createdDate": 1433769202126,
            "currencyId": "248",
            "currencyName": "EUR",
            "lastModifiedDate": 1433769202127,
            "orderBlock": false,
            "partyType": "ORGANIZATION",
            "supplierNumber": "1001"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/supplier/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Result Format
Success Failure


 {
        "id": "1813",
        "version": "0",
        "addresses": [
                {
                        "id": "1815",
                        "version": "0",
                        "countryCode": "DE",
                        "createdDate": 1433769202127,
                        "deliveryAddress": false,
                        "lastModifiedDate": 1433769202127,
                        "primeAddress": true
                }
        ],
        "company": "New Company",
        "contacts": [],
        "createdDate": 1433769202126,
        "currencyId": "248",
        "currencyName": "EUR",
        "lastModifiedDate": 1433769202127,
        "orderBlock": false,
        "partyType": "ORGANIZATION",
        "supplierNumber": "1001"
}
                        



{
    "error": "not found"
}
                        

/supplier

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"company"
: "New Company"}'
https://<tenant>.weclapp.com/webapp/api/v1/supplier
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier
Result Format
Success Failure


 {
    "id": "2426",
    "version": "0",
    "addresses": [
        {
            "id": "2428",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1435070677139,
            "deliveryAddress": false,
            "lastModifiedDate": 1435070677139,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1435070677134,
    "currencyId": "248",
    "currencyName": "EUR",
    "lastModifiedDate": 1435070677137,
    "orderBlock": false,
    "partyType": "ORGANIZATION",
    "supplierNumber": "1006"
}

                        



{
    "error": "not found"
}
                        

/supplier/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"company" :
"New Company", "currencyId" : 222}'
https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Result Format
Success Failure


  {
    "id": "2426",
    "version": "0",
    "addresses": [
        {
            "id": "2428",
            "version": "0",
            "countryCode": "DE",
            "createdDate": 1435070677139,
            "deliveryAddress": false,
            "lastModifiedDate": 1435070677139,
            "primeAddress": true
        }
    ],
    "company": "New Company",
    "contacts": [],
    "createdDate": 1435070677134,
    "currencyId": "222",
    "currencyName": "CHF",
    "lastModifiedDate": 1435070677137,
    "orderBlock": false,
    "partyType": "ORGANIZATION",
    "supplierNumber": "1006"
}
                        



{
    "error": "not found"
}
                        

/supplier/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/supplier/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/supplier/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/supplier/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Tax

see all operations for taxes.

name type description required default
version integer version of this tax No Yes
name string name of this tax Yes No
taxType string type of this tax Yes No
taxValue integer value of this tax Yes No

/tax

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/tax
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax
Result Format
Success Failure


{
    "result": [
          {
            "id": "904",
            "version": "0",
            "createdDate": 1433765714133,
            "lastModifiedDate": 1433765714133,
            "name": "tax free",
            "taxType": "TAX_FREE",
            "taxValue": "0"
        },
        {
            "id": "905",
            "version": "0",
            "createdDate": 1433765714133,
            "lastModifiedDate": 1433765714133,
            "name": "input tax",
            "taxType": "INPUT_VAT",
            "taxValue": "19"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/tax/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Result Format
Success Failure


 {
        "id": "905",
        "version": "0",
        "createdDate": 1433765714133,
        "lastModifiedDate": 1433765714133,
        "name": "input tax",
        "taxType": "INPUT_VAT",
        "taxValue": "19"
}
                        



{
    "error": "not found"
}
                        

/tax

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"tax free", "taxType" : "TAX_FREE", "taxValue" : 0}'
https://<tenant>.weclapp.com/webapp/api/v1/tax
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax
Result Format
Success Failure


 {
        "id": "904",
        "version": "0",
        "createdDate": 1433765714133,
        "lastModifiedDate": 1433765714133,
        "name": "tax free",
        "taxType": "TAX_FREE",
        "taxValue": "0"
}
                        



{
    "error": "not found"
}
                        

/tax/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"sales tax", "taxType" : "VALUE_ADDED_TAX", "taxValue" : 19}'
https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Result Format
Success Failure


  {
        "id": "904",
        "version": "0",
        "createdDate": 1433765714133,
        "lastModifiedDate": 1433765714133,
        "name": "sales tax",
        "taxType": "VALUE_ADDED_TAX",
        "taxValue": "19"
}
                        



{
    "error": "not found"
}
                        

/tax/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/tax/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/tax/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/tax/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Term Of Payment

see all operations for terms of payment.
/termOfPayment

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment
Definition https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment
Result Format
Success Failure


{
    "result": [
                {
            "id": "1074",
            "version": "0",
            "createdDate": 1433765714664,
            "description": "pay now",
            "lastModifiedDate": 1433765714664,
            "name": "net sofort"
                },
                {
            "id": "1076",
            "version": "0",
            "createdDate": 1433765714665,
            "description": "pay within 14 days without abatement",
            "lastModifiedDate": 1433765714665,
            "name": "net 14"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/termOfPayment/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment/id/:id
Result Format
Success Failure


{
        "id": "1074",
        "version": "0",
        "createdDate": 1433765714664,
        "description": "pay now",
        "lastModifiedDate": 1433765714664,
        "name": "net sofort"
}
                        



{
    "error": "not found"
}
                        

/termOfPayment/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/termOfPayment/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Unit

see all operations for units.

name type description required default
version integer version of this unit No Yes
name string name of this unit Yes No
description string short discription of this unit No No

/unit

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/unit
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit
Result Format
Success Failure


{
    "result": [
                {
            "id": "923",
            "version": "0",
            "createdDate": 1433765714360,
            "description": "kilogram",
            "lastModifiedDate": 1433765714360,
            "name": "Kg"
        },
        {
            "id": "924",
            "version": "0",
            "createdDate": 1433765714365,
            "description": "gram",
            "lastModifiedDate": 1433765714365,
            "name": "g"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/unit/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Result Format
Success Failure


{
        "id": "924",
        "version": "0",
        "createdDate": 1433765714365,
        "description": "gram",
        "lastModifiedDate": 1433765714365,
        "name": "g"
}
                        



{
    "error": "not found"
}
                        

/unit

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X POST -d '{"name" :
"kg"}'
https://<tenant>.weclapp.com/webapp/api/v1/unit
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit
Result Format
Success Failure


{
    "id": "2496",
    "version": "0",
    "createdDate": 1435558605163,
    "lastModifiedDate": 1435558605163,
    "name": "kg"
}
                        



{
    "error": "not found"
}
                        

/unit/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -H "Content-type: application/json" -X PUT -d '{"name" :
"mg", "description" : "milligram"}'
https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Result Format
Success Failure


{
    "id": "2496",
    "version": "1",
    "createdDate": 1435558605163,
    "description": "milligram",
    "lastModifiedDate": 1435558643619,
    "name": "mg"
}
                        



{
    "error": "not found"
}
                        

/unit/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> -X DELETE
https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit/id/:id
Result Format
Success Failure


No Content
                                                



{
    "error": "not found"
}
                        

/unit/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/unit/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/unit/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

User

see all operations for users.
/user

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/user
Definition https://<tenant>.weclapp.com/webapp/api/v1/user
Result Format
Success Failure


{
    "result": [
                {
            "id": "885",
            "version": "6",
            "createdDate": 1433765565559,
            "email": "test@test.de",
            "lastModifiedDate": 1433774205281,
            "username": "Tester"
        },
        {
            "id": "886",
            "version": "2",
            "createdDate": 1433765563359,
            "email": "NewAddress@addresses.com",
                        "firstName": "John",
            "lastModifiedDate": 1433774205281,
                        "lastName": "Doe",
            "username": "NewName"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/user/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id
Result Format
Success Failure


{
        "id": "886",
        "version": "2",
        "createdDate": 1433765563359,
        "email": "NewAddress@addresses.com",
        "firstName": "John",
        "lastModifiedDate": 1433774205281,
        "lastName": "Doe",
        "username": "NewName"
}
                        



{
    "error": "not found"
}
                        

/user/id/:id/userImage

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id/userImage
Definition https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id/userImage
Result Format
Success Failure


No Content
                        



{
    "error": "not user image"
}
                        

/user/id/:id/userImageThumbnail

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN> https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id/userImageThumbnail
Definition https://<tenant>.weclapp.com/webapp/api/v1/user/id/:id/userImageThumbnail
Result Format
Success Failure


No Content
                        



{
    "error": "not user image"
}
                        

/user/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/user/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/user/count
Result Format
Success Failure


{
    "result": 2
}
                            



{
    "error": "not found"
}
                        

Warehouse

see all operations for warehouses.
/warehouse

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouse
/warehouse/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouse/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouse
Result Format
Success Failure


{
    "result": [
                {
            "id": "1324",
            "version": "0",
            "active": true,
            "createdDate": 1433765715057,
            "defaultIncommingGoodsLevelId": "1326",
            "defaultLevelId": "1326",
            "defaultOutgoingGoodsLevelId": "1326",
            "defaultProductionLevelId": "1326",
            "defaultReturnsLevelId": "1326",
            "lastModifiedDate": 1433765715057,
            "name": "Second warehouse"
        },
        {
            "id": "1327",
            "version": "0",
            "active": true,
            "createdDate": 1433765715059,
            "defaultIncommingGoodsLevelId": "1329",
            "defaultLevelId": "1329",
            "defaultOutgoingGoodsLevelId": "1329",
            "defaultProductionLevelId": "1329",
            "defaultReturnsLevelId": "1329",
            "lastModifiedDate": 1433765715059,
            "name": "Main warehouse"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/warehouse/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouse/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouse/id/:id
Result Format
Success Failure


{
        "id": "1324",
        "version": "0",
        "active": true,
        "createdDate": 1433765715057,
        "defaultIncommingGoodsLevelId": "1326",
        "defaultLevelId": "1326",
        "defaultOutgoingGoodsLevelId": "1326",
        "defaultProductionLevelId": "1326",
        "defaultReturnsLevelId": "1326",
        "lastModifiedDate": 1433765715057,
        "name": "Second warehouse"

}
                        



{
    "error": "not found"
}
                        

Warehouse Level

see all operations for warehouse levels.
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouse/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

/warehouseLevel

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel
Result Format
Success Failure


{
    "result": [
                 {
            "id": "1325",
            "version": "1",
            "createdDate": 1433765715058,
            "lastModifiedDate": 1433765715072,
            "warehouseId": "1324"
        },
        {
            "id": "1326",
            "version": "1",
            "createdDate": 1433765715058,
            "lastModifiedDate": 1433765715072,
            "name": "Level",
            "parentLevelId": "1325",
            "warehouseId": "1324"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/warehouseLevel/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel/id/:id
Result Format
Success Failure


{
        "id": "1326",
        "version": "1",
        "createdDate": 1433765715058,
        "lastModifiedDate": 1433765715072,
        "name": "Level",
        "parentLevelId": "1325",
        "warehouseId": "1324"
}
                        



{
    "error": "not found"
}
                        

/warehouseLevel/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseLevel/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}
                        

Warehouse stock

see all operations for warehouse stocks.
/warehouseStock

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock
Result Format
Success Failure


{
    "result": [
                {
            "id": "1992",
            "version": "1",
            "articleId": "1939",
            "articleNumber": "11345",
            "createdDate": 1433773083553,
            "lastModifiedDate": 1433773083563,
            "quantity": "10",
            "warehouseId": "1327",
            "warehouseLevelId": "1329"
        },
        {
            "id": "1993",
            "version": "1",
            "articleId": "2039",
            "articleNumber": "123",
            "createdDate": 1433773083553,
            "lastModifiedDate": 1433773083563,
            "quantity": "20",
            "warehouseId": "1327",
            "warehouseLevelId": "1329"
        }
    ]
}
                        



{
    "error": "not found"
}
                        

/warehouseStock/id/:id

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock/id/:id
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock/id/:id
Result Format
Success Failure


{
        "id": "1992",
        "version": "1",
        "articleId": "1939",
        "articleNumber": "11345",
        "createdDate": 1433773083553,
        "lastModifiedDate": 1433773083563,
        "quantity": "10",
        "warehouseId": "1327",
        "warehouseLevelId": "1329"
}
                        



{
    "error": "not found"
}
                        

/warehouseStock/count

EXAMPLE:

curl -H "AuthenticationToken:<TOKEN>
https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock/count
Definition https://<tenant>.weclapp.com/webapp/api/v1/warehouseStock/count
Result Format
Success Failure


{
    "result": 5
}
                            



{
    "error": "not found"
}