Skip to content

Postman & examples

Everything a developer needs to get started: one YAML file (OpenAPI) and one Postman collection for each API.

The files

API OpenAPI (YAML) Postman
Provider API: issuing documents novus-provider-api.openapi.yaml Novus_Provider_API.postman_collection.json
Onboarding API: activating customers novus-onboarding-api.openapi.yaml Novus_Onboarding_API.postman_collection.json
  • You can read the YAML (OpenAPI 3.1) as text or feed it to a code generator (NSwag, OpenAPI Generator, Kiota). It starts with the flow and the important notes. Every field that takes an AADE code lists the allowed values with their descriptions.
  • The Postman collection has every call, organized into scenarios, with explanations and ready-made tests.

Postman in 3 steps

  1. In Postman: Import → drag in the collection file.

  2. Open the collection → Variables tab and fill in:

    Variable Provider API Onboarding API
    apiKey Your sandbox API key (where to find it) The same key
    issuerVat The VAT number (ΑΦΜ) you signed up with —
    vatNumber — The VAT number of the customer you are activating
    b2gApiKey B2G only: the separate B2G key —

  3. Run folder 1 of the collection, one request at a time, in order.

baseUrl points to the sandbox by default (https://provider-dev.timologisi.online). For production, change it to https://provider.timologisi.online.

You do not need to change the date and number

In the Provider API collection, today's date ({{today}}) and a new number ({{aa}}) are set automatically before each call. The MARKs, UIDs and tokens that later steps need are saved automatically. In the Postman Console you see the statusCode, the MARK and the AADE errors of each response.

Provider API scenarios

Folder What it tests In order
1. Flow: your first document Credits → receipt 11.1 → search → PDF → myDATA XML ✔
2. Invoices & receipts 1.1, 2.1, 11.2, 3.1, 8.2, taxes per line and at document level
3. Credit notes Invoice → 5.1 that credits it · 5.2 · 11.4 ✔
4. Card / IRIS through POS Provider signature → completion · paying an old invoice by card · 8.4 · 8.5 ✔
5. Food service (8.6) Order → item cancellation → open tables → closing with 11.1 · full cancellation ✔
6. Goods movement Invoice / receipt - delivery note · 9.3 → invoice that closes it · delivery note cancellation ✔
7. B2G (public sector) 6 invoices to public bodies (needs b2gApiKey)
8. OSS 11.1 to a consumer in another EU member state
9. Error scenarios 401 without a key · 400 wrong payment total · 228 duplicate ✔

For the Onboarding API, the flow and the scenarios are described in How it works.

The whole collection with one command

With the Postman Runner, or with Newman in your CI, you run all scenarios in order:

newman run Novus_Provider_API.postman_collection.json \
  --env-var apiKey=ΤΟ_ΚΛΕΙΔΙ_ΣΑΣ --env-var issuerVat=ΤΟΝ_ΑΦΜ_ΣΑΣ

Without b2gApiKey, folder 7 fails, which is expected.

Ready-made JSON

Each file is a valid request for SendInvoices (or SendInvoicesB2G). Amounts, VAT, totals and classifications are checked automatically for every release of the docs. Before you send them, change the issuer VAT number, issueDate and aa.

Category Files Guide
Invoices & receipts 1.1 · 2.1 · 3.1 · 8.2 · 11.1 · 11.2 Invoices & receipts
Credit notes 5.1 · 5.2 · 11.4 Credit notes
Taxes Per line · At document level Taxes, fees, deductions
Card / IRIS 11.1 by card · Completion · 8.4 · 8.5 Card / IRIS payment
Food service Order · Item cancellation · Closing with 11.1 · Full cancellation Food service
Goods movement 1.1 - Delivery note · 11.1 - Delivery note · 9.3 · 1.1 closing delivery notes Goods movement
B2G 1.1 · 1.1 VAT exemption · 1.1 fuel · 1.1 - Delivery note · 2.1 · 5.2 Public sector (B2G)
OSS 11.1 OSS OSS
Onboarding New request · New webhook Onboarding API

Test data

The company names, emails and MARKs in the examples are fictitious. 123456789 stands for your own issuer VAT number: change it.

For AI tools

The whole documentation is also available as one text file (Markdown), to hand to AI tools such as Claude, ChatGPT, Copilot or Cursor, e.g. "read this and build the SendInvoices integration". It is generated on every release, so it is always current.

File Contents
/llms-full.txt Every page in English, with the JSON examples inlined. This is the file to give the tool.
/llms.txt Index: one line per page, with link and description.
/el/llms-full.txt · /el/llms.txt The same in Greek.

Along with the file, give the tool the OpenAPI (YAML) of the API you use.