NONOX Connect API · v1.1.0 · OpenAPI 3.1
API-referens
Det öppna API:t för NONOX Ekonomisystem. Appar ansluts med OAuth 2.0 (auktoriseringskod med PKCE S256) och godkänns av en ägare eller administratör med passkey; skript använder API-nycklar som skapas under Anslutningar. Varje nyckel eller app gäller ett företag och får aldrig mer än sina behörigheter och vad personen som gav den får göra just nu. Fel kommer som problem+json med svensk förklaring. Varje POST kräver Idempotency-Key. Belopp anges i öre. Webhooks signeras med HMAC-SHA256 och skickas efter att ändringen har sparats. Testföretag med exempeldata finns för att prova API:t.
Referensen genereras från openapi.yaml (också som openapi.json), samma fil som testerna kontrollerar varje adress mot. Läs in den i Postman, Insomnia eller en kodgenerator.
https://nonox.app/api/v1
Företaget
Företaget som nyckeln eller appen gäller.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/company |
Hämta företaget | – |
Bokföring
Kontoplan, momskoder, räkenskapsår och verifikationsserier.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/accounts |
Lista kontoplanen | vouchers:view |
GET/accounts/{number} |
Hämta ett konto | vouchers:view |
GET/vat-codes |
Lista momskoder | vouchers:view |
GET/fiscal-years |
Lista räkenskapsår | vouchers:view |
GET/fiscal-years/{fiscalYear} |
Hämta ett räkenskapsår | vouchers:view |
GET/fiscal-years/{fiscalYear}/periods |
Räkenskapsårets perioder och låsning | vouchers:view |
GET/fiscal-years/{fiscalYear}/sie |
Hämta räkenskapsåret som SIE-fil | export:sie |
GET/voucher-series |
Lista verifikationsserier | vouchers:view |
Verifikationer
Verifikationer: utkast, bokföring, rättelser och underlag. En bokförd verifikation kan aldrig ändras.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/vouchers |
Lista verifikationer | vouchers:view |
POST/vouchers |
Skapa ett utkast | vouchers:create |
GET/vouchers/{voucher} |
Hämta en verifikation | vouchers:view |
PATCH/vouchers/{voucher} |
Ändra ett utkast | vouchers:create |
DELETE/vouchers/{voucher} |
Ta bort ett utkast | vouchers:create |
POST/vouchers/{voucher}/post |
Bokför en verifikation | vouchers:post |
POST/vouchers/{voucher}/correct |
Rätta en bokförd verifikation | vouchers:correct |
GET/vouchers/{voucher}/attachments |
Lista underlag | vouchers:view |
POST/vouchers/{voucher}/attachments |
Lägg till underlag | vouchers:create |
GET/vouchers/{voucher}/attachments/{attachment}/content |
Hämta underlagets fil | vouchers:view |
Kunder
Kundregistret.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/customers |
Lista kunder | invoices:view |
POST/customers |
Lägg till en kund | invoices:create |
GET/customers/{customer} |
Hämta en kund | invoices:view |
PATCH/customers/{customer} |
Ändra en kund | invoices:create |
Leverantörer
Leverantörsregistret.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/suppliers |
Lista leverantörer | supplier-invoices:create supplier-invoices:approve |
POST/suppliers |
Lägg till en leverantör | supplier-invoices:create |
GET/suppliers/{supplier} |
Hämta en leverantör | supplier-invoices:create supplier-invoices:approve |
PATCH/suppliers/{supplier} |
Ändra en leverantör | supplier-invoices:create |
Kostnadsställen och projekt
Kostnadsställen och projekt.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/cost-centers |
Lista kostnadsställen | vouchers:view |
POST/cost-centers |
Lägg till kostnadsställe | accounts:manage |
GET/cost-centers/{costCenter} |
Hämta kostnadsställe | vouchers:view |
PATCH/cost-centers/{costCenter} |
Ändra kostnadsställe | accounts:manage |
GET/projects |
Lista projekt | vouchers:view |
POST/projects |
Lägg till projekt | accounts:manage |
GET/projects/{project} |
Hämta projekt | vouchers:view |
PATCH/projects/{project} |
Ändra projekt | accounts:manage |
Rapporter
Saldobalans, huvudbok, balansrapport och resultatrapport.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/reports/trial-balance |
Saldobalans | reports:view |
GET/reports/general-ledger |
Huvudbok | reports:view |
GET/reports/balance-sheet |
Balansrapport | reports:view |
GET/reports/income-statement |
Resultatrapport | reports:view |
Moms
Momsperioder och momsdeklaration.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/vat-periods |
Lista momsperioder | vat:prepare |
GET/vat-return |
Hämta momsdeklarationen för en period | vat:prepare |
Artiklar
Artikelregistret.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/articles |
Lista artiklar | invoices:view |
POST/articles |
Lägg till en artikel | invoices:create |
GET/articles/{article} |
Hämta en artikel | invoices:view |
PATCH/articles/{article} |
Ändra en artikel | invoices:create |
Kundfakturor
Kundfakturor: utkast, skapa, mejla, kreditera, betalningar och PDF.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/invoices |
Lista kundfakturor | invoices:view |
POST/invoices |
Skapa ett fakturautkast | invoices:create |
GET/invoices/{invoice} |
Hämta en kundfaktura | invoices:view |
PATCH/invoices/{invoice} |
Ändra ett fakturautkast | invoices:create |
POST/invoices/{invoice}/issue |
Skapa (bokför) fakturan | invoices:send vouchers:create vouchers:post |
POST/invoices/{invoice}/send |
Mejla fakturan | invoices:send |
POST/invoices/{invoice}/credit |
Kreditera en faktura | invoices:credit |
POST/invoices/{invoice}/payments |
Registrera en inbetalning | payments:create vouchers:create vouchers:post |
GET/invoices/{invoice}/pdf |
Hämta fakturan som PDF | invoices:view |
Leverantörsfakturor
Leverantörsfakturor: utkast, fil, registrering, attest och betalning.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/supplier-invoices |
Lista leverantörsfakturor | supplier-invoices:create supplier-invoices:approve payments:create |
POST/supplier-invoices |
Skapa ett utkast till leverantörsfaktura | supplier-invoices:create |
GET/supplier-invoices/{supplierInvoice} |
Hämta en leverantörsfaktura | supplier-invoices:create supplier-invoices:approve payments:create |
PATCH/supplier-invoices/{supplierInvoice} |
Ändra ett utkast | supplier-invoices:create |
DELETE/supplier-invoices/{supplierInvoice} |
Ta bort ett utkast | supplier-invoices:create |
POST/supplier-invoices/{supplierInvoice}/file |
Lägg till fakturafilen | supplier-invoices:create |
POST/supplier-invoices/{supplierInvoice}/register |
Registrera leverantörsfakturan | supplier-invoices:create vouchers:create vouchers:post |
POST/supplier-invoices/{supplierInvoice}/approve |
Attestera leverantörsfakturan | supplier-invoices:approve |
POST/supplier-invoices/{supplierInvoice}/payments |
Registrera en betalning | payments:create vouchers:create vouchers:post |
Betalningar
In- och utbetalningar.
| Anrop | Gör | Behörighet |
|---|---|---|
GET/payments |
Lista inbetalningar | invoices:view |
GET/supplier-payments |
Lista utbetalningar | supplier-invoices:create supplier-invoices:approve payments:create |
Webhooks
voucher.posted, invoice.sent, invoice.paid och supplier_invoice.approved skickas till din https-adress när bokföringen är sparad, signerade med HMAC-SHA256. Guiden om webhooks visar hur signaturen kontrolleras i PHP, JavaScript och Python.