Yona API
Yona is a licensed e-invoicing Access Point. It validates, signs, numbers and reports invoices to the tax authority, delivers them to buyers, and brings back the invoices other businesses send you. These docs cover two ways to use it.
For businesses: the Yona API
Your organisation already uses the Yona app. The API lets your own software do what the app does: create invoices, submit them, follow their status, record payments, and read the invoices you receive. You authenticate with an API key and the examples use plain HTTP, so any language works.
- Quickstart: a submitted invoice on the sandbox in ten minutes
- Authentication: keys, capabilities, and what stays in the app
- Sandbox and live: one host, two environments
- API Reference: every operation, generated from the API itself
For software platforms: the NRS Partner API
If you build software that issues invoices for many businesses, you connect once to the Yona Access Point and submit for each of them. That is a separate API with its own guide: NRS E-Invoicing.
Concepts
| Concept | What it means |
|---|---|
| Organisation | Your account on Yona, and the seller on every invoice you issue. There is no separate seller record to create. |
| Buyer | The business or person you invoice. Saved once, referenced by id. A buyer on the e-invoicing network receives invoices through it; others receive them by email or link. |
| Item | Something you sell, saved with its code, unit, price and tax category, so line items can reference it. |
| Invoice | A document with line items and computed totals. It is a draft until finalised, then submitted, registered by the authority, and delivered. |
| Submission | One attempt to have the authority register an invoice. It climbs a ladder and never climbs down. |
| Received invoice | An invoice another business issued to you through the network. |
| Credit | The unit actions are charged in. Your plan grants credits monthly; top-ups add more. |
| API key | Your credential. sk_test_ keys use the sandbox, sk_live_ keys the live service. |
How a request looks
POST https://gp.useyona.com/i/v1/invoices
Authorization: Bearer sk_test_your_key_here
Content-Type: application/jsonEvery response carries meta and data. meta.requestId identifies the request if you need to ask us about it. See the API Reference for the envelope, error codes and limits.