INTRODUCTION

Linet API is bidirectional. Meaning:

• Your application can make actions on Linet subscribers’ Objects .
• Your application can get webhook notifications on  Objects events within a Linet subscriber.

Linet implements a RESTful approach to its API.

All data sent and received as JSON, by standard http POST, GET requests.

So, what can Linet API do for your app? It can:

• DOCUMENTS: Create, Print, Send, Delete, Update (Delete/Update: Only draft documents)
• ITEMS: Create, Search (Includes inventory query), Update, Delete
• ACCOUNTS: Create, Search, Update, Delete (Customers, suppliers etc, Warehouses are accounts as well)
• COMPANY: Create, Search, Delete

Every Linet subscriber can manage multiple businesses (“Companies”) under a single Linet subscription. If you have an app that needs legally acceptable accounting documents, inventory management, etc, for your multiple customers' businesses, under your single subscription, you can create a "company" for each one of them and let them have completely isolated access for each company. This will include creating documents with their own logo, digital signature etc.

• SETTINGS: Update company settings
• INVENTORY TRANSACTIONS: Can be executed through API by creating relevant types of documents.
• ACCOUNTING TRANSACTIONS: Can be executed through API by creating relevant types of documents

NOTE: There are some documents that can make both accounting and inventory transactions.

What Linet webhooks can do for you? It can notify your app about:

• ITEMS: On Create, Update, Delete
• DOCUMENTS: On Create, Update, Delete (Only draft status documents can be deleted)
• ACCOUNTS: On Create, Update, Delete
• ITEM CATEGORIES: On Create, Update, Delete

AUTHENTICATION

All API request to Linet endpoint must be authenticated by:

1. A Pair of API ID and Key. Here is a guide How to retrieve this authentication pair from Linet UI.
2. Company ID, Since all Linet tenants that have access to the API, are allowed to run at least 3 companies on a single subscription, whoever makes an API request, must provide the ID of the specific company within a subscriber. The same guide to retrieve authentication pair explains how to retrieve the company ID from Linet user interface.

API Authentication pair is associated to a Linet User

Every pair of ID and Key is associated with a specific Linet User and operates under this user's permissions and identity.

Therefore, all API requests authenticated by a pair will be recorded in the Linet system as executed by the user associated with this pair.

This feature is very useful on almost all reports, where we can identify which user made the deal/collected the payment.

Therefore, it is a very good practice to create a separate, specific, user for each integration with each external application and create an authentication pair associated with each one of those users.

Use case example for segregating API requests by two or more Linet users, authenticated each with its own API auth. pair:

Let's say we want to integrate two different websites to a single company under a Linet subscriber. We will certainly want to segregate the sales reports as by easily identifiable indicator which one of the websites made whatever sales have been made.
To accomplish this goal we will:

• Create 2 new users (Users can be created by UI).
• Give, each one, a human recognizable name like “Customers Site” and “Dealers Site”.
• Create two authentication pairs associated with each user.
• Then use the pair associated with the user named “Customers  site” to execute requests from one site.
• Use the other pair on the Dealers site.

The result: Documents created by requests initiated at Dealers site will be recorded in the Linet system as created by the user “Dealers Site” and documents created by the customer's site will be recorded as created by the user “Customers site” . Later, we can get accurate sales reports which are associated with each website by the user who created the sales document.

QUICK GUIDE

Endpoints:

All API requests are made by https POST or GET requests to a Linet API Endpoint that will always start with: https://app.linet.org.il/api

Endpoints examples:

• Create document: https://app.linet.org.il/api/create/docs
• Update account: https://app.linet.org.il/api/update/accounts?id=435

Extended endpoints guide here

Actions available through API are:

• Create
• Update
• Delete (Should Not be used on Documents, Items and Accounts)
• Search
• Print (Includes send action, Print action is available only for documents module).
• Inventory query (This action is available

Objects (Models) available for making actions through API are:

ENDPOINTS

On the following endpoint guide we will not repeat the full endpoint URI.

We will assume that you have understood that all endpoint URI start with https://app.linet.org.il/api

Documents

/create/doc

/newsearch/doc  

/print/doc

Items

/create/item*

/update/item*

/delete/item*

/stockall/item?id=456

Search active items by created date since …, and belong to category ID 1, and value in custom field is “כן”

Search items by custom field ID 3 (eav3) value

Item Categories

/create/itemcategory

/update/itemcategory

/delete/itemcategory

/search/itemcategory

Accounts

/create/account*

/update/account*

/delete/account*

/newsearch/account

Account Categories

Company

Settings

WEBHOOKS-NOTIFICATIONS

External applications can get notifications about events in Linet objects to their own endpoints (URI).

 Objects (Models) in Linet with support for sending webhook notifications:

• Items (Insert, Update, Delete)
• Item categories (Insert, Update, Delete)
• Accounts (Insert, Update, Delete)
• Documents (Insert, Update)

Some important highlights about notifications

• Notifications sent out from Linet to external URI can be filtered by (extended explanation for this):

• Attribute
• Condition for an attributes’ value. Supported Conditions:

• Equals
• Starts with
• Smaller then
• Bigger then

• Value of attribute

• Notifications can be sent to multiple endpoints, even for the same events.
• For the time being, the notifications creation and configuration interface is not accessible for subscribers and users. All creation and configuration of those notifications are made by Linet support staff after a written request from a subscriber, accompanied with provided endpoint/s for sending the notifications to.

Filtering notifications explained

Sometimes we want to get conditional notifications about events. Filtering notifications gives us the tool to place a value of an attribute that if it has fulfilled its condition, it will be granted the permission to be sent out to its endpoint.

Notification filtering use case example

Let’s say we have a website to update with a list of selected items.

Let's say one of the attributes of items is a field, labeled “upload to web?”.

If this fields’ value is “Yes”, Linet will send a notification, as soon as the item gets updated  within the Linet environment. If the value of this attribute is any other, no notification won’t be ever sent. This way, the website will have updates only about items that should be uploaded to it and save overhead for unnecessary data traffic and compute power.

Webhook Examples:

Example 1: Item Update

Example 2: Item Category Create (Insert)

Example 3: Account Create (Insert)