SAGE connection

zrsPOS issues every document in your own SAGE, through SAGE's SmartAPI. This page connects the two and reads your company from SAGE, so you never type it.

You need two things from your SAGE partner. If you do not have them yet, send them the page for your SAGE partner.

SAGE address

The fixed public https address of your SmartAPI, with its port, for example https://sage.yourcompany.pt:5581. zrsPOS sends every document to this address. An address that starts with http:// works, but the page warns that it is not secure: the key and the documents cross the internet unencrypted. Ask your SAGE partner for https. The warning never stops you from issuing.

Access key

The key (x-api-key) your SAGE partner creates in SmartAPI for zrsPOS. It belongs to one SAGE company, so there is no company to choose. zrsPOS stores it encrypted and never shows it again: once saved, the page says A key is saved and offers Replace key. A new address needs its key again.

Save tests first

Enter the address and the key and press Save. Nothing is saved until SAGE answers: Save first tests what you typed (Reaching SAGE · Reading your company · Reading the SAGE functions). If SAGE does not answer, the page names the cause at the field it is about, and nothing changes.

Test connection tests what is saved and never saves. It reads your company and the licensed functions again, and also refreshes what the setup checks read from SAGE. A read-only plan can still test.

If a test fails, the cause stays on the page after a reload, with one way out: Show me how when SAGE cannot be reached (Put SAGE on the internet), Replace key when the key is refused, or the page for your SAGE partner. The causes are at the end of this page.

Your company in SAGE

After a good test the page shows the company as SAGE has it: name, NIF, address, postal code, locality, country, VAT region, phone, e-mail and share capital. They are read-only on purpose. SAGE is the certified issuer, so these come from SAGE and print on every document. If one is wrong, change it in SAGE, then test the connection. Contacts and logo for your documents are in Document design.

The page also lists every change of SAGE company: when, by whom, from which company to which.

SAGE functions

SAGE only exposes the functions your licence includes. zrsPOS reads them on every good test and shows them in plain words: sales documents, credit notes, items, customers, payment methods, tills, salespeople, warehouses, séries, taxes and zones, company and licence. Each is Working or Needs attention; the exact paths are under Details for support. A missing function is named, so you can ask your SAGE partner for it (licence missing). An inactive licence says so: SAGE accepts nothing until it is renewed. The last read is kept, so the page is never empty.

Lists read from SAGE

To suggest your settings, zrsPOS reads 17 lists from SAGE: séries, document types, warehouses, payment terms, SAGE payment methods, salespeople and more. Each list is Read or Could not be read, with what that affects. Read the lists again reads them all and shows the progress. This is the one place to read SAGE again; other pages link here when a list could not be read.

For your SAGE partner

One text, ready to send, personalised with your shop, your company and its NIF: what your SAGE partner prepares. Copy it, send it by e-mail or print it.

Put SAGE on the internet

zrsPOS runs in the cloud, so the SmartAPI must answer on a fixed public https address with a valid certificate. Your SAGE partner sets it up; the steps are in Put SAGE on the internet. Every "SAGE can't be reached" problem opens it with Show me how.

What Working means

The SAGE connection is Working when all three are true:

SAGE answered within the last 24 hours;
your company and NIF were read;
every function zrsPOS needs is licensed.

If SAGE stops answering for more than a day, it falls back to Needs attention and says so. The rules for every part of the setup are in What Working means.

Changing SAGE company

If the address or the key leads to another company (another NIF), zrsPOS always asks first, naming both companies. Test connection never switches: it says that the SAGE belongs to another company and offers Change company. Confirming pauses issuing before anything is saved, forgets the items and lists read from the old company, and asks you to check Stores, SAGE items and Payments again, each confirmed on its own page. Documents already issued keep the company that issued them. If the change cannot finish, issuing stays paused and the new connection is not saved: try again, or write to support@zrspos.com.

Disconnect SAGE

In the Danger zone. zrsPOS stops issuing until you connect SAGE again, and the saved key is dropped. Sales go on and wait for their document; issued documents stay in SAGE.

If the test fails

Each cause has its own title on the page, and its own page here:

SAGE did not answer in time (timeout): it may be off, slow, or not on the internet yet.
Nothing answers at this address (refused): SAGE's connection service may be stopped.
This address does not exist (unknown address): check it with your SAGE partner.
SAGE's secure connection is broken (certificate): the certificate has expired or is for another address.
SAGE refused this key (key refused): it is wrong or has expired; your SAGE partner gives you a new one.
Something answered here, but not SAGE (not the SmartAPI): check the address.
This address sends zrsPOS elsewhere (redirect): save the direct address.
This address only works inside your shop (local network): zrsPOS needs a public address.
SAGE refused the request (refused request): the page shows SAGE's reason.

You do not need to allow any zrsPOS address in your firewall: there is none.

Problems on this page

Each one has a page that says what you see, what happened and what to do.