Autentisering
Type
APIKEY — API-nøkkel
Sted
spørring / parameter:
apikeyReserve via spørring/kroppsparameter «apikey»
HENT /sendsms/?apikey=DIN_API_NØKKEL
Fakturahåndtering
/faktura/legg til
• Metoder:
STOLPE
Legg til en salgsfakturahode
Oppretter en ny fakturahode med statusen UTKAST. Endepunktet registrerer all leverandør- og kundeinformasjon, utstedelsesdatoer, betalingsbetingelser og leveringsdetaljer. Leverandørdata lastes automatisk inn fra API-nøkkelregistreringen din (customer_api).
STOLPE
/faktura/legg til
• Vurder: 60 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel (fra din registrerte leverandørkonto). | ||
nettverk |
streng | Ingen | Valgfri nettverksidentifikator (Peppol som standard). | ||
inv_id |
streng | Ingen | Valgfritt internt fakturanummer. | ||
utstedelsesdato |
streng | Ja | Fakturautstedelsesdato (ÅÅÅÅ-MM-DD). | ||
forfallsdato |
streng | Ingen | Fakturaens forfallsdato (ÅÅÅÅ-MM-DD). | ||
fakturatypekode |
streng | Ingen | 380 | Peppol fakturatypekode (f.eks. 380 = Faktura, 381 = Kreditnota). | |
valuta |
streng | Ingen | EUR | ISO-valutakode. | |
regnskapskostnad |
streng | Ingen | Referanse til intern regnskapskode. | ||
kjøperreferanse |
streng | Ingen | Kjøperreferanse / PO-nummer. | ||
betalingsmiddelkode |
streng | Ingen | 1 | Betalingsmidler (Peppol-kodeliste). | |
betaling.betalings-ID |
streng | Ingen | Betalingsidentifikator / referanse. | ||
betaling.iban |
streng | Ingen | Mottakerens IBAN. | ||
betalingskontonavn |
streng | Ingen | Navn på innehaver av betalingsmottakerkonto. | ||
betaling.bic |
streng | Ingen | Betalingsmottakers BIC/SWIFT-kode. | ||
betalingsvilkår_merknad |
streng | Ingen | Merknad om betalingsbetingelser. | ||
leveringsdato |
streng | Ingen | Leveringsdato. | ||
levering.lokasjonsskjema |
streng | Ingen | 0088 | Identifikator for leveringsstedordning. | |
levering.steds-ID |
streng | Ingen | Leveringssteds-ID. | ||
levering.gate |
streng | Ingen | Leveringsadresse gate. | ||
leveringsby |
streng | Ingen | Leveringsadresse by. | ||
levering.post |
streng | Ingen | Postnummer for leveringsadresse. | ||
leveringsland |
streng | Ingen | Landskode for leveringsadresse. | ||
leveringsselskapsnavn |
streng | Ingen | Navn på leveringsselskap. | ||
kunde.endepunkt_skjema |
streng | Ingen | 0208 | Kundens Peppol-ordnings-ID. | |
kunde.sluttpunkt_id |
streng | Ingen | Kundens Peppol-deltaker-ID. | ||
kundenavn |
streng | Ingen | Kundens navn. | ||
kunde.gate |
streng | Ingen | Kundegate. | ||
kunde.by |
streng | Ingen | Kundeby. | ||
kunde.post |
streng | Ingen | Kundens postnummer. | ||
kunde.land |
streng | Ingen | Kundens landskode. | ||
kunde.mva_id |
streng | Ingen | Kundens MVA-nummer. | ||
kunde.bedrifts-ID-ordning |
streng | Ingen | 0208 | Kundens bedrifts-ID-ordning. | |
kunde.bedrifts-ID |
streng | Ingen | Kundens bedrifts-ID (nasjonalt nummer). | ||
kunde.telefon |
streng | Ingen | Kundekontakt telefon. | ||
kunde.e-post |
streng | Ingen | Kundekontakt-e-postadresse. |
Be om eksempler
KRØLL
PYTON
curl -X POST "https://api.peppox.com/invoice/add/" \ -H "Autorisasjon: Bærer YOUR_API_KEY" \ -H "Innholdstype: application/json" \ -d "{ "issue_date": "2025-10-17", "due_date": "2025-11-17", "customer": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "country": "BE" }, "payment": { "iban": "BE12345678901234", "bic": "GEBABEBB", "account_name": "Peppox-leverandør" } }"
Svar
Status: 200 — Faktura opprettet (utkast).
JSON
{ "ok": sann, "faktura_guide": "faktura-8c3b4a99-2025-10-17", "status": "UTKAST" }
Status: 400 — Ugyldige eller manglende felt.
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 500 — Intern server- eller databasefeil.
/fakturalinje/legg til
• Metoder:
STOLPE
Legge til en fakturalinje i en eksisterende faktura
Legger til en ny linje på en eksisterende faktura (identifisert av invoice_guid). Støtter enhets-, mengde-, pris-, mva-kategori- og produktidentifikasjonskoder.
STOLPE
/fakturalinje/legg til
• Vurder: 60 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel (påkrevd for autentisering). | ||
faktura_guide |
streng | Ja | Den unike faktura-GUID-en som ble returnert fra /invoice/add. | ||
linje_id |
streng | Ingen | Valgfri intern linjeidentifikator (standard er generert GUID). | ||
mengde |
tall | Ja | Mengde av varen eller tjenesten. | ||
enhetskode |
streng | Ingen | Enhetskode i henhold til UNECE Rec 20 (f.eks. H87 for «stykke»). | ||
prisbeløp |
tall | Ja | Enhetspris (ekskl. mva.). | ||
varebeskrivelse |
streng | Ingen | Beskrivelse av varen eller tjenesten. | ||
varenavn |
streng | Ingen | Varenavn eller tittel. | ||
selger_vare_id |
streng | Ingen | Selgers interne vare-ID eller SKU. | ||
std_item_id_scheme |
streng | Ingen | 0088 | Standard skjema-ID for vareidentifikasjon (f.eks. GTIN). | |
std_item_id |
streng | Ingen | Standardisert vare-ID (GTIN, EAN osv.). | ||
opprinnelsesland |
streng | Ingen | Opprinnelsesland (ISO 3166-1 alpha-2). | ||
skattekategori |
streng | Ingen | Mva-kategorikode (f.eks. S, Z, AE). | ||
skatteprosent |
tall | Ingen | MVA-sats i prosent (f.eks. 21,00). |
Be om eksempler
KRØLL
PYTON
curl -X POST "https://api.peppox.com/invoice_line/add/" \ -H "Autorisering: Bærer YOUR_API_KEY" \ -H "Innholdstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "antall": 2, "enhetskode": "H87", "prisbeløp": 49,99, "varenavn": "Konsulenttjeneste", "avgiftsprosent": 21 }"
Svar
Status: 200 — Fakturalinje lagt til.
JSON
{ "ok": sant, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Ugyldige parametere (mangler invoice_guid eller ugyldige numeriske felt).
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 500 — Intern database- eller serverfeil.
/faktura_vedlegg_pdf/legg til
• Metoder:
STOLPE
Legg ved en PDF-fil til en eksisterende faktura
Legger ved et PDF-dokument (via opplasting, Base64 eller ekstern URL) til en eksisterende faktura identifisert av invoice_guid. Bare ett vedlegg per faktura lagres; eventuelle tidligere filer erstattes.
STOLPE
/faktura_vedlegg_pdf/legg til
• Vurder: 30 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel (autentisering). | ||
faktura_guide |
streng | Ja | GUID-en til fakturaen som PDF-filen skal legges ved. | ||
dok_id |
streng | Ingen | Valgfri dokumentidentifikator (standard er faktura-ID eller en generert UUID). | ||
filnavn |
streng | Ingen | vedlegg.pdf | Vedleggets filnavn (f.eks. faktura.pdf). | |
mime |
streng | Ingen | søknad/pdf | MIME-typen til filen. | |
innholdsbase64 |
streng | Ingen | PDF-innhold som Base64-streng. Godtar data-URI-format. | ||
fil_url |
streng | Ingen | Ekstern HTTPS-URL til en PDF som skal lastes ned og legges ved. | ||
fil |
fil | Ingen | Filopplastingsfelt (flerdelt/skjemadata). |
Be om eksempler
KRØLL
KRØLL
KRØLL
curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorisering: Bærer YOUR_API_KEY" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "file=@invoice.pdf"
Svar
Status: 200 — PDF-filen er lagt ved fakturaen.
JSON
{ "ok": true, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "filnavn": "invoice-2025-10.pdf", "mime": "applikasjon/pdf", "size_bytes": 184527 }
Status: 400 — Ugyldige parametere eller manglende innhold (ingen Base64, fil eller URL).
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 404 — Fakturaen ble ikke funnet.
Status: 500 — Intern server- eller databasefeil.
XML-generering
/xml/generer
• Metoder:
STOLPE
Generer en UBL XML-fil for en faktura eller kreditnota
Kombinerer faktura-/kreditnotahode, linjer og vedlagt PDF (hvis noen) til et Peppol-kompatibelt UBL 3.0 XML-dokument. Returnerer den lokale banen til den genererte filen og oppdaterer faktura-/kreditnotastatusen til XML_BUILT.
STOLPE
/xml/generer
• Vurder: 30 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel for autentisering. | ||
faktura_guide |
streng | Ja | Den unike identifikatoren til fakturaen som skal konverteres til XML. | ||
veileder |
streng | Ingen | Alternativ nøkkel for invoice_guid. |
Be om eksempler
KRØLL
PYTON
curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Autorisering: Bærer YOUR_API_KEY" \ -H "Innholdstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"
Svar
Status: 200 — XML er generert og lagret på serveren.
JSON
{ "ok": sann, "status": "XML_BUILT", "xml_path": "/var/www/vhosts/peppox.com/httpdocs/invoices_xml/inv-8c3b4a99-2025-10-17.xml" }
Status: 400 — Manglende invoice_guid eller fakturalinjer.
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 404 — Fakturaen ble ikke funnet.
Status: 500 — Intern XML-genererings- eller skrivefeil.
Kreditnotater
/kreditnota/legg til
• Metoder:
STOLPE
Legg til en kreditnotaoverskrift
Oppretter en ny kreditnotaoverskrift med statusen UTKAST. Leverandørdata lastes automatisk inn fra API-nøkkelkontoen, mens felt for kunde, betaling og levering godtas fra forespørselen.
STOLPE
/kreditnota/legg til
• Vurder: 60 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel. | ||
nettverk |
streng | Ingen | Valgfri nettverksidentifikator. | ||
kreditnota_id |
streng | Ingen | Foretrukket kreditnotanummer/identifikator. | ||
cn_id |
streng | Ingen | Alternativt alias for kreditnota-ID. | ||
kreditnota-ID |
streng | Ingen | Alternativt alias for kreditnota-ID. | ||
inv_id |
streng | Ingen | Alternativ eldre identifikator. | ||
utstedelsesdato |
streng | Ja | Utstedelsesdato for kreditnota (ÅÅÅÅ-MM-DD). | ||
forfallsdato |
streng | Ingen | Forfallsdato (ÅÅÅÅ-MM-DD). | ||
fakturatypekode |
streng | Ingen | 381 | Dokumenttypekode. Standard 381 = Kreditnota. | |
valuta |
streng | Ingen | EUR | ISO-valutakode. | |
regnskapskostnad |
streng | Ingen | Intern regnskapsreferanse. | ||
kjøperreferanse |
streng | Ingen | Kjøperreferanse / kundes innkjøpsordrereferanse. | ||
betalingsmiddelkode |
streng | Ingen | 1 | Betaling betyr kode. | |
betaling.betalings-ID |
streng | Ingen | Betalingsreferanse. | ||
betaling.iban |
streng | Ingen | Mottakerens IBAN. | ||
betalingskontonavn |
streng | Ingen | Navn på betalingsmottakerkonto. | ||
betaling.bic |
streng | Ingen | Betalingsmottaker BIC / SWIFT. | ||
betalingsvilkår_merknad |
streng | Ingen | Merknad om betalingsbetingelser. | ||
leveringsdato |
streng | Ingen | Leveringsdato. | ||
levering.lokasjonsskjema |
streng | Ingen | 0088 | Ordning med leveringssted. | |
levering.steds-ID |
streng | Ingen | Identifikator for leveringssted. | ||
levering.gate |
streng | Ingen | Leveringsgate. | ||
leveringsby |
streng | Ingen | Leveringsby. | ||
levering.post |
streng | Ingen | Leveringspostnummer. | ||
leveringsland |
streng | Ingen | Leveringslandskode. | ||
leveringsselskapsnavn |
streng | Ingen | Navn på leveringsselskap. | ||
leverandør.endepunktsordning |
streng | Ingen | 0208 | Leverandørens endepunktskjema. Leverandørverdier lastes ellers inn fra API-kontoen. | |
kunde.endepunkt_skjema |
streng | Ingen | 0208 | Kundens endepunktskjema. | |
kunde.sluttpunkt_id |
streng | Ingen | Kundens endepunkt-ID. | ||
kundenavn |
streng | Ingen | Kundens juridiske navn. | ||
kunde.gate |
streng | Ingen | Kundegate. | ||
kunde.by |
streng | Ingen | Kundeby. | ||
kunde.post |
streng | Ingen | Kundens postnummer. | ||
kunde.land |
streng | Ingen | Kundens landskode. | ||
kunde.mva_id |
streng | Ingen | Kundens MVA-nummer. | ||
kunde.bedrifts-ID-ordning |
streng | Ingen | 0208 | Kundens bedrifts-ID-ordning. | |
kunde.bedrifts-ID |
streng | Ingen | Kundens firma-ID. | ||
kunde.telefon |
streng | Ingen | Kundetelefon. | ||
kunde.e-post |
streng | Ingen | Kundens e-post. |
Be om eksempler
KRØLL
PYTON
curl -X POST "https://api.peppox.com/creditnote/add/" -H "Autorisering: Bærer YOUR_API_KEY" -H "Innholdstype: application/json" -d "{ "creditnote_id": "CN-2025-001", "issue_date": "2025-10-17", "currency": "EUR", "customer": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "country": "BE" } }"
Svar
Status: 200 — Kreditnotaen er opprettet.
JSON
{ "ok": true, "invoice_guid": "cn-8c3b4a99-2025-10-17", "document_type": "KREDITNOTATE", "status": "UTKAST" }
Status: 400 — Ugyldige eller manglende felt.
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 500 — Intern server- eller databasefeil.
/kreditnota_linje/legg til
• Metoder:
STOLPE
Legg til en kreditnotalinje
Legger til en linje i en eksisterende kreditnota. Godtar automatisk alias for creditnote_guid og beregner tax_category fra tax_percent når det er mulig.
STOLPE
/kreditnota_linje/legg til
• Vurder: 60 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel. | ||
kreditnota_guide |
streng | Ja | GUID for målkreditnotaen. | ||
faktura_guide |
streng | Ingen | Alias for creditnote_guid. | ||
veileder |
streng | Ingen | Alias for creditnote_guid. | ||
linje_id |
streng | Ingen | Valgfri intern linjeidentifikator. | ||
ordrelinje-ID |
streng | Ingen | Alias for linje_id. | ||
mengde |
tall | Ja | Linjemengde. | ||
antall |
tall | Ingen | Alias for mengde. | ||
q |
tall | Ingen | Alias for mengde. | ||
enhetskode |
streng | Ingen | Enhetskode. | ||
enhet |
streng | Ingen | Alias for enhetskode. | ||
du |
streng | Ingen | Alias for enhetskode. | ||
prisbeløp |
tall | Ja | Enhetsprisbeløp. | ||
pris |
tall | Ingen | Alias for price_amount. | ||
enhetspris |
tall | Ingen | Alias for price_amount. | ||
varebeskrivelse |
streng | Ingen | Linjebeskrivelse. | ||
beskrivelse |
streng | Ingen | Alias for varebeskrivelse. | ||
beskrivelse |
streng | Ingen | Alias for varebeskrivelse. | ||
varenavn |
streng | Ingen | Varenavn/tittel. | ||
navn |
streng | Ingen | Alias for varenavn. | ||
tittel |
streng | Ingen | Alias for varenavn. | ||
selger_vare_id |
streng | Ingen | Selgers vare-ID / SKU. | ||
selger_ID |
streng | Ingen | Alias for selger_vare_id. | ||
sku |
streng | Ingen | Alias for selger_vare_id. | ||
std_item_id_scheme |
streng | Ingen | 0088 | Standard skjema for gjenstandsidentifikasjon. | |
std_scheme |
streng | Ingen | Alias for std_item_id_scheme. | ||
ordning |
streng | Ingen | Alias for std_item_id_scheme. | ||
std_item_id |
streng | Ingen | Standard vare-ID (EAN, GTIN osv.). | ||
gtin |
streng | Ingen | Alias for std_item_id. | ||
ean |
streng | Ingen | Alias for std_item_id. | ||
opprinnelsesland |
streng | Ingen | Opprinnelsesland. | ||
land |
streng | Ingen | Alias for opprinnelsesland. | ||
skattekategori |
streng | Ingen | Mva-kategorikode. Automatisk tvunget til S eller Z avhengig av avgiftsprosent. | ||
skattekatt |
streng | Ingen | Alias for skattekategori. | ||
momskategori |
streng | Ingen | Alias for skattekategori. | ||
skatteprosent |
tall | Ingen | MVA-prosent. | ||
momssats |
tall | Ingen | Alias for skatteprosent. | ||
avgift |
tall | Ingen | Alias for skatteprosent. | ||
moms |
tall | Ingen | Alias for skatteprosent. |
Be om eksempler
KRØLL
PYTON
curl -X POST "https://api.peppox.com/creditnote_line/add/" -H "Autorisering: Bærer YOUR_API_KEY" -H "Innholdstype: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "antall": 2, "enhetskode": "H87", "prisbeløp": 49,99, "varenavn": "Returnert konsulenttjeneste", "avgiftsprosent": 21 }"
Svar
Status: 200 — Kreditnotalinje er lagt til.
JSON
{ "ok": sant, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Mangler obligatoriske verdier som creditnote_guid, quantity eller price_amount.
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 500 — Intern databasefeil.
/kreditnota_vedlegg_pdf/legg til
• Metoder:
STOLPE
Legg ved en PDF-fil til en kreditnota
Legger ved et PDF-dokument til en eksisterende kreditnota ved hjelp av flerdelt opplasting, Base64-nyttelast eller ekstern URL. Forrige vedlegg erstattes.
STOLPE
/kreditnota_vedlegg_pdf/legg til
• Vurder: 30 req/min
• Godkjenning kreves
Parametere
| Navn | I | Type | Obligatorisk | Misligholde | Beskrivelse |
|---|---|---|---|---|---|
apikey |
streng | Ja | Din Peppox API-nøkkel. | ||
kreditnota_guide |
streng | Ja | Kreditnota-GUID-en som PDF-filen skal legges ved. | ||
faktura_guide |
streng | Ingen | Alias for creditnote_guid. | ||
veileder |
streng | Ingen | Alias for creditnote_guid. | ||
dok_id |
streng | Ingen | Valgfri dokumentidentifikator. Standardinnstillingen er inv_id eller en generert UUID. | ||
filnavn |
streng | Ingen | vedlegg.pdf | Vedleggets filnavn. | |
mime |
streng | Ingen | søknad/pdf | Vedlegg MIME-type. | |
innholdsbase64 |
streng | Ingen | PDF-innhold kodet som Base64. | ||
pdf_base64 |
streng | Ingen | Alias for content_base64. | ||
fil_url |
streng | Ingen | HTTP/HTTPS-URL-en til PDF-filen som skal lastes ned og legges ved. | ||
pdf_url |
streng | Ingen | Alias for file_url. | ||
fil |
fil | Ingen | Flerdelt opplastet fil. |
Be om eksempler
KRØLL
KRØLL
KRØLL
curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Autorisering: Bærer YOUR_API_KEY" -F "creditnote_guid=cn-8c3b4a99-2025-10-17" -F "fil=@creditnote.pdf"
Svar
Status: 200 — PDF-filen er lagt ved kreditnotaen.
JSON
{ "ok": true, "creditnote_guid": "cn-8c3b4a99-2025-10-17", "doc_id": "CN-2025-001", "filnavn": "creditnote.pdf", "mime": "applikasjon/pdf", "size_bytes": 184527 }
Status: 400 — Ugyldig forespørsel: manglende creditnote_guid, ugyldig Base64, ugyldig URL eller intet innhold oppgitt.
Status: 401 — Ugyldig eller utløpt API-nøkkel.
Status: 404 — Kreditnota ikke funnet.
Status: 500 — Intern database- eller filhåndteringsfeil.
Webhooks
Ingen webhooks dokumentert.
SDK-er
Ingen SDK-er oppført.
Feilkatalog
Ingen feil definert.
Endringslogg
Ingen utgivelser ennå.
Norwegian 
English 
French 
Spanish 
German 
Dutch 
Danish