Accounting system integration sandbox — API

In the admin panel: API → accounting system API testing.

What this is

A sandbox for the integration with your accounting system. All the endpoints through which our system itself calls the accounting system are gathered here: it requests prices, checks stock availability, pulls material↔edge bindings and so on. On the page you can see which endpoints you have configured and which you do not; each one can be tested live with a real request and you can see what the accounting system returned.

What you see

A list of accounting system call points — cards with the same structure:

Name and a short description of the point.
What it gives — in plain words: what functionality is enabled by setting up this endpoint.
Setup steps — a short instruction: what to ask your accounting system developer for, which parameter key to find in the admin panel, where to paste the URL.
Current URL — if already configured. Empty — means the endpoint is not working.
"Test" button — opens a tab with the real request form, shows request/response.

Available integration points

The basic set (may be extended as the system evolves):

Getting material prices — our system asks the accounting system for the up-to-date prices of sheet materials. Without this setup the prices are taken from the local database and may differ from the accounting system.
Getting service prices — the same for services (treatment, fittings).
Stock availability check — before launching an order to production, the system asks the accounting system whether all the required materials are available. Without this orders may go into production and fall with "no material".
Getting the edge for the material — which edge ships with a specific sheet material. Used when synchronising the catalogue; otherwise the material→edge mapping has to be configured manually.

When requesting prices for materials and services, the platform sends the accounting system the order's real counterparty — the customer sees their contract prices, not retail ones. If the counterparty is not set up or not linked to the accounting system, the calculation does not fail: retail prices are returned with a clear explanation of what needs to be filled in. Also fixed: the case where a user of one firm works with another firm's catalog — the price request now goes strictly to the accounting system of the firm whose catalog is used.

How to configure

The general recipe is the same for each point:

Ask your accounting system developer to create an HTTP service (endpoint) with the required request/response format. The format description is inside the card on the testing page.
Get the URL of this service from the developer (it should start with https://; a local accounting system may be on http://).
Go to Parameters → Firm parameters, find the parameter with the key shown in the card and paste the URL.
Go back to the testing page and click "Test" — you immediately see whether the accounting system is responding and what data it returns.

Request test

On the test tab for the chosen point you see:

Endpoint URL — where the request will go.
HTTP method (usually POST).
Headers (including the accounting system API key, if set).
Request body — a typical example that can be sent immediately or adjusted (for example, by substituting a real code1c of an existing product/order).
"Send" button — gives the raw response from the accounting system: response code, body, duration.

What matters

Test requests are real: they actually go to your accounting system and can change its data (for example, the "Accept order" test will create a record in the accounting system). Be careful in production — first test on a staging accounting system.
All endpoint settings are stored in the production parameters of your firm — they can be changed without a redeploy.
In one of the keys there is a historical typo in the system ("avilable" instead of "available") — it is not a bug, left for backward compatibility with old installations. The hint in the card warns about it.
Access — all admins of your firm.