Peppox API — API Documentation

Godkendelse

Type
APIKEY — API-NØGLE
Beliggenhed
forespørgsel / parameter: apikey
Fallback via forespørgsel/body-parameter "apikey"
HENT /sendsms/?apikey=DIN_API_NØGLE

Fakturahåndtering

/faktura/tilføj • Metoder: STOLPE

Tilføj en salgsfakturahoved

Opretter en ny fakturahoved med status KLADDE. Endpointen registrerer alle leverandør- og kundeoplysninger, udstedelsesdatoer, betalingsbetingelser og leveringsdetaljer. Leverandørdata indlæses automatisk fra din API-nøgleregistrering (customer_api).
STOLPE /faktura/tilføj • Bedøm: 60 r/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle (fra din registrerede leverandørkonto).
netværk snor Ingen Valgfri netværksidentifikator (Peppol som standard).
inv_id snor Ingen Valgfrit internt fakturanummer.
udstedelsesdato snor Ja Fakturaudstedelsesdato (ÅÅÅÅ-MM-DD).
forfaldsdato snor Ingen Fakturaens forfaldsdato (ÅÅÅÅ-MM-DD).
fakturatypekode snor Ingen 380 Peppol fakturatypekode (f.eks. 380 = Faktura, 381 = Kreditnota).
valuta snor Ingen EUR ISO-valutakode.
regnskabsomkostninger snor Ingen Reference til intern regnskabskode.
køberreference snor Ingen Købers reference/indkøbsordrenummer.
betalingsmiddelkode snor Ingen 1 Betalingsmidler (Peppol-kodeliste).
betaling.betalings-id snor Ingen Betalingsidentifikator / -reference.
betaling.iban snor Ingen Modtagers IBAN.
betalingskontonavn snor Ingen Navn på indehaver af betalingsmodtagerkonto.
betaling.bic snor Ingen Modtagers BIC/SWIFT-kode.
betalingsbetingelser_note snor Ingen Bemærkning om betalingsbetingelser.
leveringsdato snor Ingen Leveringsdato.
levering.lokationsordning snor Ingen 0088 Identifikator for leveringsstedsordning.
levering.lokation_id snor Ingen Leveringssteds-ID.
levering.gade snor Ingen Leveringsadresse gade.
leveringsby snor Ingen Leveringsadresse by.
levering.post snor Ingen Leveringsadresse postnummer.
leveringsland snor Ingen Leveringsadresse landekode.
leveringspartnernavn snor Ingen Navn på leveringspartner.
kunde.slutpunktsordning snor Ingen 0208 Kundens Peppol-ordnings-ID.
kunde.slutpunkt_id snor Ingen Kundens Peppol-deltager-ID.
kundenavn snor Ingen Kundens navn.
kunde.gade snor Ingen Kundegade.
kunde.by snor Ingen Kundeby.
kunde.post snor Ingen Kundens postnummer.
kunde.land snor Ingen Kundens landekode.
kunde.moms_id snor Ingen Kundens momsnummer.
kunde.virksomheds-id-ordning snor Ingen 0208 Kundens virksomheds-ID-ordning.
kunde.virksomheds-id snor Ingen Kundens virksomheds-ID (nationalt nummer).
kunde.telefon snor Ingen Kunde kontakt telefon.
kunde.e-mail snor Ingen Kundekontakt e-mail.

Anmod om eksempler

KRØLLE
PYTHON
curl -X POST "https://api.peppox.com/invoice/add/" \ -H "Godkendelse: Bærer YOUR_API_NØGLE" \ -H "Indholdstype: 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 oprettet (kladde).
JSON
{ "ok": sand, "faktura_guid": "faktura-8c3b4a99-2025-10-17", "status": "UDKAST" }
Status: 400 — Ugyldige eller manglende felter.
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 500 — Intern server- eller databasefejl.
/fakturalinje/tilføj • Metoder: STOLPE

Tilføj en fakturalinje til en eksisterende faktura

Tilføjer en ny linje til en eksisterende faktura (identificeret af invoice_guid). Understøtter identifikationskoder for enhed, antal, pris, momskategori og produkt.
STOLPE /fakturalinje/tilføj • Bedøm: 60 r/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle (påkrævet til godkendelse).
faktura_guide snor Ja Det unikke faktura-GUID, der returneres fra /invoice/add.
linje_id snor Ingen Valgfri intern linje-id (standard er genereret GUID).
mængde antal Ja Mængden af varen eller tjenesteydelsen.
enhedskode snor Ingen Enhedskode i henhold til UNECE Rec 20 (f.eks. H87 for "stykke").
prisbeløb antal Ja Enhedspris (ekskl. moms).
varebeskrivelse snor Ingen Beskrivelse af varen eller tjenesten.
varenavn snor Ingen Varens navn eller titel.
sælger_vare_id snor Ingen Sælgers interne vare-ID eller SKU.
std_item_id_scheme snor Ingen 0088 Standardskema-ID til vareidentifikation (f.eks. GTIN).
std_item_id snor Ingen Standardiseret vare-ID (GTIN, EAN osv.).
oprindelsesland snor Ingen Oprindelsesland (ISO 3166-1 alpha-2).
skattekategori snor Ingen Momskategorikode (f.eks. S, Z, AE).
skatteprocent antal Ingen Momssats i procent (f.eks. 21,00).

Anmod om eksempler

KRØLLE
PYTHON
curl -X POST "https://api.peppox.com/invoice_line/add/" \ -H "Godkendelse: Bærer YOUR_API_NØGLE" \ -H "Indholdstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "mængde": 2, "enhedskode": "H87", "prisbeløb": 49,99, "varenavn": "Konsulentydelse", "tax_percent": 21 }"

Svar

Status: 200 — Fakturalinje tilføjet.
JSON
{ "ok": sand, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Ugyldige parametre (manglende invoice_guid eller ugyldige numeriske felter).
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 500 — Intern database- eller serverfejl.
/faktura_vedhæft_pdf/tilføj • Metoder: STOLPE

Vedhæft en PDF til en eksisterende faktura

Vedhæfter et PDF-dokument (via upload, Base64 eller fjern-URL) til en eksisterende faktura identificeret af invoice_guid. Kun én vedhæftet fil pr. faktura gemmes; enhver tidligere fil erstattes.
STOLPE /faktura_vedhæft_pdf/tilføj • Bedøm: 30 req/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle (godkendelse).
faktura_guide snor Ja GUID'et for den faktura, som PDF-filen skal vedhæftes til.
doc_id snor Ingen Valgfrit dokument-id (standardindstilling er faktura-id eller et genereret UUID).
filnavn snor Ingen vedhæftet fil.pdf Navn på vedhæftet fil (f.eks. faktura.pdf).
mime snor Ingen ansøgning/pdf Filens MIME-type.
indholdsbase64 snor Ingen PDF-indhold som Base64-streng. Accepterer data-URI-format.
fil_url snor Ingen Fjern HTTPS-URL til en PDF, der skal downloades og vedhæftes.
fil fil Ingen Filuploadfelt (flerdelt/formular-data).

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Godkendelse: Bærer YOUR_API_NØGLE" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "fil=@invoice.pdf"

Svar

Status: 200 — PDF-filen er vedhæftet fakturaen.
JSON
{ "ok": sand, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "filnavn": "invoice-2025-10.pdf", "mime": "applikation/pdf", "size_bytes": 184527 }
Status: 400 — Ugyldige parametre eller manglende indhold (ingen Base64, fil eller URL).
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 404 — Faktura ikke fundet.
Status: 500 — Intern server- eller databasefejl.

XML-generering

/xml/generer • Metoder: STOLPE

Generer en UBL XML-fil til en faktura eller kreditnota

Kombinerer faktura-/kreditnotahoved, linjer og vedhæftet PDF (hvis relevant) i et Peppol-kompatibelt UBL 3.0 XML-dokument. Returnerer den lokale sti til den genererede fil og opdaterer faktura-/kreditnotastatus til XML_BUILT.
STOLPE /xml/generer • Bedøm: 30 req/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle til godkendelse.
faktura_guide snor Ja Det unikke id for den faktura, der skal konverteres til XML.
guide snor Ingen Alternativ nøgle til invoice_guid.

Anmod om eksempler

KRØLLE
PYTHON
curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Godkendelse: Bearer YOUR_API_NØGLE" \ -H "Indholdstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"

Svar

Status: 200 — XML blev genereret og gemt på serveren.
JSON
{ "ok": sand, "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 udløbet API-nøgle.
Status: 404 — Faktura ikke fundet.
Status: 500 — Intern XML-genererings- eller skrivefejl.

Kreditnotaer

/kreditnota/tilføj • Metoder: STOLPE

Tilføj en kreditnotaoverskrift

Opretter en ny kreditnotaoverskrift med status KLADDE. Leverandørdata indlæses automatisk fra API-nøglekontoen, mens felterne kunde, betaling og levering accepteres fra anmodningen.
STOLPE /kreditnota/tilføj • Bedøm: 60 r/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle.
netværk snor Ingen Valgfri netværksidentifikator.
kreditnota_id snor Ingen Foretrukket kreditnotanummer/identifikator.
cn_id snor Ingen Alternativt alias for kreditnota-ID.
kreditnota-id snor Ingen Alternativt alias for kreditnota-ID.
inv_id snor Ingen Alternativt ældre id.
udstedelsesdato snor Ja Udstedelsesdato for kreditnota (ÅÅÅÅ-MM-DD).
forfaldsdato snor Ingen Forfaldsdato (ÅÅÅÅ-MM-DD).
fakturatypekode snor Ingen 381 Dokumenttypekode. Standard 381 = Kreditnota.
valuta snor Ingen EUR ISO-valutakode.
regnskabsomkostninger snor Ingen Intern regnskabsreference.
køberreference snor Ingen Køberreference / kundeordrereference.
betalingsmiddelkode snor Ingen 1 Betaling betyder kode.
betaling.betalings-id snor Ingen Betalingsreference.
betaling.iban snor Ingen Modtagers IBAN.
betalingskontonavn snor Ingen Navn på betalingsmodtagerkonto.
betaling.bic snor Ingen Modtager BIC / SWIFT.
betalingsbetingelser_note snor Ingen Bemærkning om betalingsbetingelser.
leveringsdato snor Ingen Leveringsdato.
levering.lokationsordning snor Ingen 0088 Ordning for leveringssted.
levering.lokation_id snor Ingen Leveringsstedsidentifikator.
levering.gade snor Ingen Leveringsgade.
leveringsby snor Ingen Leveringsby.
levering.post snor Ingen Leverings postnummer.
leveringsland snor Ingen Leverings landekode.
leveringspartnernavn snor Ingen Navn på leveringspartner.
leverandør.slutpunktsordning snor Ingen 0208 Leverandørens slutpunktsskema. Leverandørværdier indlæses ellers fra API-kontoen.
kunde.slutpunktsordning snor Ingen 0208 Kundens slutpunktsskema.
kunde.slutpunkt_id snor Ingen Kundens slutpunkts-ID.
kundenavn snor Ingen Kundens juridiske navn.
kunde.gade snor Ingen Kundegade.
kunde.by snor Ingen Kundeby.
kunde.post snor Ingen Kundens postnummer.
kunde.land snor Ingen Kundens landekode.
kunde.moms_id snor Ingen Kundens momsnummer.
kunde.virksomheds-id-ordning snor Ingen 0208 Kundens virksomheds-ID-ordning.
kunde.virksomheds-id snor Ingen Kundens virksomheds-ID.
kunde.telefon snor Ingen Kundens telefon.
kunde.e-mail snor Ingen Kundens e-mail.

Anmod om eksempler

KRØLLE
PYTHON
curl -X POST "https://api.peppox.com/creditnote/add/" -H "Godkendelse: Bærer YOUR_API_NØGLE" -H "Indholdstype: 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 — Kreditnota er oprettet.
JSON
{ "ok": sand, "fakturavejledning": "cn-8c3b4a99-2025-10-17", "dokumenttype": "KREDITNOTE", "status": "KLADDE" }
Status: 400 — Ugyldige eller manglende felter.
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 500 — Intern server- eller databasefejl.
/kreditnota_linje/tilføj • Metoder: STOLPE

Tilføj en kreditnotalinje

Tilføjer en linje til en eksisterende kreditnota. Accepterer automatisk aliasser for creditnote_guid og beregner tax_category ud fra tax_percent, når det er muligt.
STOLPE /kreditnota_linje/tilføj • Bedøm: 60 r/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle.
kreditnota_guide snor Ja Målkreditnotaens GUID.
faktura_guide snor Ingen Alias for creditnote_guid.
guide snor Ingen Alias for creditnote_guid.
linje_id snor Ingen Valgfri intern linjeidentifikator.
ordrelinje-id snor Ingen Alias for linje_id.
mængde antal Ja Linjemængde.
antal antal Ingen Alias for mængde.
q antal Ingen Alias for mængde.
enhedskode snor Ingen Enhedskode.
enhed snor Ingen Alias for enhedskode.
dig snor Ingen Alias for enhedskode.
prisbeløb antal Ja Enhedsprisbeløb.
pris antal Ingen Alias for price_amount.
enhedspris antal Ingen Alias for price_amount.
varebeskrivelse snor Ingen Linjebeskrivelse.
beskrivelse snor Ingen Alias for varebeskrivelse.
beskrivelse snor Ingen Alias for varebeskrivelse.
varenavn snor Ingen Varenavn/titel.
navn snor Ingen Alias for varenavn.
titel snor Ingen Alias for varenavn.
sælger_vare_id snor Ingen Sælgers vare-ID / SKU.
sælger_id snor Ingen Alias for seller_item_id.
varenummer snor Ingen Alias for seller_item_id.
std_item_id_scheme snor Ingen 0088 Standardordning for vareidentifikation.
std_scheme snor Ingen Alias for std_item_id_scheme.
ordning snor Ingen Alias for std_item_id_scheme.
std_item_id snor Ingen Standard vare-ID (EAN, GTIN osv.).
gtin snor Ingen Alias for std_item_id.
ean snor Ingen Alias for std_item_id.
oprindelsesland snor Ingen Oprindelsesland.
land snor Ingen Alias for oprindelsesland.
skattekategori snor Ingen Momskategorikode. Automatisk tvunget til S eller Z afhængigt af momsprocent.
skattekat snor Ingen Alias for skattekategori.
momskategori snor Ingen Alias for skattekategori.
skatteprocent antal Ingen Momsprocent.
momssats antal Ingen Alias for skatteprocent.
skat antal Ingen Alias for skatteprocent.
moms antal Ingen Alias for skatteprocent.

Anmod om eksempler

KRØLLE
PYTHON
curl -X POST "https://api.peppox.com/creditnote_line/add/" -H "Godkendelse: Bærer YOUR_API_NØGLE" -H "Indholdstype: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "mængde": 2, "enhedskode": "H87", "prisbeløb": 49,99, "varenavn": "Returneret konsulentydelse", "tax_percent": 21 }"

Svar

Status: 200 — Kreditnotalinje er tilføjet.
JSON
{ "ok": sand, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Manglende obligatoriske værdier såsom creditnote_guid, quantity eller price_amount.
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 500 — Intern databasefejl.
/kreditnota_vedhæft_pdf/tilføj • Metoder: STOLPE

Vedhæft en PDF til en kreditnota

Vedhæfter et PDF-dokument til en eksisterende kreditnota ved hjælp af flerdelt upload, Base64-nyttelast eller fjern-URL. Den tidligere vedhæftede fil erstattes.
STOLPE /kreditnota_vedhæft_pdf/tilføj • Bedøm: 30 req/min • Godkendelse påkrævet

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
apikey snor Ja Din Peppox API-nøgle.
kreditnota_guide snor Ja Kreditnotaens GUID, som PDF-filen skal vedhæftes til.
faktura_guide snor Ingen Alias for creditnote_guid.
guide snor Ingen Alias for creditnote_guid.
doc_id snor Ingen Valgfri dokumentidentifikator. Standardværdien er inv_id eller et genereret UUID.
filnavn snor Ingen vedhæftet fil.pdf Vedhæftet filnavn.
mime snor Ingen ansøgning/pdf Vedhæftet MIME-type.
indholdsbase64 snor Ingen PDF-indhold kodet som Base64.
pdf_base64 snor Ingen Alias for content_base64.
fil_url snor Ingen HTTP/HTTPS-URL til PDF-filen, der skal downloades og vedhæftes.
pdf_url snor Ingen Alias for file_url.
fil fil Ingen Flerdelt uploadet fil.

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Godkendelse: Bærer YOUR_API_NØGLE" -F "creditnote_guid=cn-8c3b4a99-2025-10-17" -F "fil=@creditnote.pdf"

Svar

Status: 200 — PDF-filen er vedhæftet til kreditnotaen.
JSON
{ "ok": sand, "creditnote_guid": "cn-8c3b4a99-2025-10-17", "doc_id": "CN-2025-001", "filnavn": "creditnote.pdf", "mime": "applikation/pdf", "size_bytes": 184527 }
Status: 400 — Ugyldig anmodning: manglende creditnote_guid, ugyldig Base64, ugyldig URL eller intet indhold angivet.
Status: 401 — Ugyldig eller udløbet API-nøgle.
Status: 404 — Kreditnota ikke fundet.
Status: 500 — Intern database- eller filhåndteringsfejl.

Webhooks

Ingen webhooks dokumenteret.

SDK'er

Ingen SDK'er angivet.

Fejlkatalog

Ingen fejl defineret.

Ændringslog

Ingen udgivelser endnu.
Genereret fra database • Peppox API • Alle rettigheder forbeholdes.