Peppox API — API Documentation

Godkendelse

Type
APIKEY — API-NØGLE
Beliggenhed
forespørgsel / parameter: apikey
Fallback via forespørgsel/body-parameter "apikey"
HENT https://api.peppox.com//sendsms/?apikey=YOUR_API_KEY

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: 200Faktura oprettet (kladde).
JSON
{ "ok": sand, "faktura_guid": "faktura-8c3b4a99-2025-10-17", "status": "UDKAST" }
Status: 400Ugyldige eller manglende felter.
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 500Intern 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: 200Fakturalinje tilføjet.
JSON
{ "ok": sand, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400Ugyldige parametre (manglende invoice_guid eller ugyldige numeriske felter).
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 500Intern 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: 200PDF-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: 400Ugyldige parametre eller manglende indhold (ingen Base64, fil eller URL).
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 404Faktura ikke fundet.
Status: 500Intern 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: 200XML 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: 400Manglende invoice_guid eller fakturalinjer.
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 404Faktura ikke fundet.
Status: 500Intern 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: 200Kreditnota er oprettet.
JSON
{ "ok": sand, "fakturavejledning": "cn-8c3b4a99-2025-10-17", "dokumenttype": "KREDITNOTE", "status": "KLADDE" }
Status: 400Ugyldige eller manglende felter.
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 500Intern 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: 200Kreditnotalinje er tilføjet.
JSON
{ "ok": sand, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400Manglende obligatoriske værdier såsom creditnote_guid, quantity eller price_amount.
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 500Intern 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: 200PDF-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: 400Ugyldig anmodning: manglende creditnote_guid, ugyldig Base64, ugyldig URL eller intet indhold angivet.
Status: 401Ugyldig eller udløbet API-nøgle.
Status: 404Kreditnota ikke fundet.
Status: 500Intern database- eller filhåndteringsfejl.

Sendte dokumenter

/doc-sendt/header/liste • Metoder:

Liste over sendte fakturaoverskrifter

Viser en liste over sendte salgsfakturaoverskrifter for en leverandør. Understøtter søgeord, datofiltre, Peppol-statusfiltre, lokale statusfiltre, inkludering af rå svar, sortering og paginering.
/doc-sendt/header/liste • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Påkrævet leverandør-id. Denne værdi er knyttet til invoices.apikey.
q snor Ingen Søgning efter søgeord på tværs af fakturahovedfelter.
side heltal Ingen 1 Sidetal.
pr._side heltal Ingen 300 Rækker pr. side. Maksimum: 300.
dato snor Ingen Filter for præcis dato i formatet ÅÅÅÅ-MM-DD.
dato_fra snor Ingen Startdato for periodefilter i formatet ÅÅÅÅ-MM-DD.
dato_til snor Ingen Slutdato for periodefilter i formatet ÅÅÅÅ-MM-DD.
datofelt snor Ingen sendt_på Datofelt brugt til date/date_from/date_to. Tilladt: issue_date, due_date, delivery_date, xml_built_at, sent_at, created_at, updated_at, status_from_peppol_date.
status_fra_peppol snor Ingen Filtrer efter Peppol-status. Understøtter CSV-værdier.
peppol_status snor Ingen Alias for status_from_peppol.
status snor Ingen Alias for status_from_peppol.
lokal_status snor Ingen Filtrer efter lokal fakturastatus fra invoices.status. Understøtter CSV-værdier.
include_raw boolsk Ingen 0 Sæt til 1 for at inkludere sent_reply_api og all_response_api i svaret.
search_raw boolsk Ingen 0 Sæt til 1 for at inkludere sent_reply_api og all_response_api i søgeordssøgningen.
sorter_efter snor Ingen sendt_på Sortér kolonne. Tilladt: id, invoice_guid, inv_id, issue_date, due_date, xml_built_at, sent_at, status, created_at, updated_at, status_from_peppol, status_from_peppol_date, c_name, s_name, currency, network.
sorteringsmappe snor Ingen BESKRIVELSE Sorteringsretning: ASC eller DESC.

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
PYTHON
krølle "https://api.peppox.com/doc-sent/header/list/?supplier_id=DIN_LEVERANDØR_ID"

Svar

Status: 200Succes — returnerer fakturaoverskrifter med filtre, sorteringsoplysninger, paginering og datarækker.
JSON
{ "ok": sand, "endpoint": "doc-sendt/header/liste", "method": "HENT", "filtre": { "supplier_id": "DIT_LEVERANDØR_ID", "q": "", "date": "", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "sendt_at", "status_from_peppol": "sendt", "local_status": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "sendt_at", "sort_dir": "DESC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "id": 125, "invoice_guid": "inv-8c3b4a99-2025-10-17", "inv_id": "INV-2025-001", "issue_date": "2025-10-17", "due_date": "2025-11-17", "invoice_type_code": "380", "currency": "EUR", "buyer_reference": "PO-12345", "s_name": "Leverandørvirksomhed", "s_endpoint_id": "0208:0123456789", "c_name": "Kundevirksomhed", "c_endpoint_id": "0208:0987654321", "status": "SENDT", "sent_at": "2025-10-17 14:30:00", "sent_http_code": 200, "network": "peppol", "status_from_peppol": "sendt", "status_from_peppol_date": "2025-10-17 14:31:00", "status_from_peppol_error": null, "flowin_invoice_id_from_sent_reply_api": "flowin-doc-id-123", "flowin_document_endpoint_used": "/peppol/leverandører/.../fakturaer" } ] }
Status: 400Mangler påkrævet leverandør_id.
Status: 500Serverfejl.
/doc-sendt/linjer/liste • Metoder:

Liste over sendte fakturalinjer

Viser linjerne i en sendt faktura ved hjælp af supplier_id og invoice_guid. supplier_id'et skal af sikkerhedsmæssige årsager matche invoices.apikey.
/doc-sendt/linjer/liste • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id forespørgsel snor Ja Påkrævet leverandør-id. Denne værdi skal matche invoices.apikey.
faktura_guide forespørgsel snor Ja Faktura-GUID, der bruges til at vise fakturalinjer.
q forespørgsel snor Ingen Valgfri søgeordssøgning på tværs af fakturalinjefelter.
side forespørgsel heltal Ingen 1 Sidetal.
pr._side forespørgsel heltal Ingen 300 Rækker pr. side. Maksimum: 300.

Anmod om eksempler

KRØLLE
KRØLLE
PYTHON
krølle "https://api.peppox.com/doc-sent/lines/list/?supplier_id=YOUR_SUPPLIER_ID&invoice_guid=inv-8c3b4a99-2025-10-17"

Svar

Status: 200Succes — returnerer fakturametadata, filtre, paginering og fakturalinjer.
JSON
{ "ok": sand, "endpoint": "doc-send/lines/list", "invoice": { "invoice_guid": "inv-8c3b4a99-2025-10-17", "inv_id": "INV-2025-001", "status": "SENDT", "sendt_på": "2025-10-17 14:30:00" }, "filters": { "supplier_id": "DIT_LEVERANDØR_ID", "invoice_guid": "inv-8c3b4a99-2025-10-17", "q": "konsultation" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "id": 1, "invoice_guid": "inv-8c3b4a99-2025-10-17", "line_guid": "line-001", "line_id": "1", "quantity": "2.00", "unit_code": "H87", "price_amount": "49.99", "item_description": "Konsulentydelse", "item_name": "Konsulentydelse", "seller_item_id": "SKU-001", "std_item_id_scheme": "0088", "std_item_id": null, "origin_country": "BE", "tax_category": "S", "tax_percent": "21.00", "created_at": "2025-10-17 14:00:00", "updated_at": null } ] }
Status: 400Mangler påkrævet supplier_id eller invoice_guid.
Status: 404Faktura ikke fundet eller ikke tilladt for dette supplier_id.
Status: 500Serverfejl.

Modtagne dokumenter

/doc-modtaget/header/liste • Metoder:

Liste overskrifter på modtagne købsfakturaer

Viser en liste over købsfakturaoverskrifter modtaget af en leverandør via Peppol. Understøtter søgeord, datofiltre, importstatus, dokumenttypekode, rå felter, sortering og paginering.
/doc-modtaget/header/liste • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Påkrævet leverandør-id. Denne værdi knyttes til peppox_inbound_purchase_invoices.supplier_id.
q snor Ingen Søgning efter søgeord på tværs af felter i headeren for modtagne fakturaer.
side heltal Ingen 1 Sidetal.
pr._side heltal Ingen 300 Rækker pr. side. Maksimum: 300.
dato snor Ingen Filter for præcis dato i formatet ÅÅÅÅ-MM-DD.
dato_fra snor Ingen Startdato for periodefilter i formatet ÅÅÅÅ-MM-DD.
dato_til snor Ingen Slutdato for periodefilter i formatet ÅÅÅÅ-MM-DD.
datofelt snor Ingen api_oprettet_at Datofelt brugt til date/date_from/date_to. Tilladt: api_created_at, issue_date, due_date, tax_point_date, created_at, updated_at.
importstatus snor Ingen Filtrer efter importstatus. Understøtter CSV-værdier.
status snor Ingen Alias for import_status.
dokumenttypekode snor Ingen Filtrer efter dokumenttypekode. Understøtter CSV-værdier. Eksempel: 380-faktura, 381-kreditnota.
type_kode snor Ingen Alias for dokumenttypekode.
include_raw boolsk Ingen 0 Sæt til 1 for at inkludere customization_id, profile_id, xml_without_pdf, api_attributes_json, parser_json og notification_sent_by_email_response.
search_raw boolsk Ingen 0 Indstil til 1 for at søge i rå/lange felter.
sorter_efter snor Ingen api_oprettet_at Sorteringskolonne. Tilladt: id, customer_id, supplier_id, flowin_document_id, api_created_at, document_type_code, document_number, issue_date, due_date, tax_point_date, currency, supplier_name, customer_name, total_excl_moms, total_moms, total_incl_moms, payable_amount, import_status, created_at, updated_at.
sorteringsmappe snor Ingen BESKRIVELSE Sorteringsretning: ASC eller DESC.

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
PYTHON
krølle "https://api.peppox.com/doc-received/header/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148"

Svar

Status: 200Succes — returnerer modtagne købsfakturaoverskrifter med filtre, sortering, paginering og datarækker.
JSON
{ "ok": sand, "endpoint": "doc-received/header/list", "method": "GET", "filters": { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "q": "", "date": "", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "api_created_at", "import_status": "importeret", "document_type_code": "380", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "api_created_at", "sort_dir": "DESC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": falsk, "has_next": falsk }, "count": 1, "data": [ { "id": 25, "customer_id": 7, "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "flowin-doc-id-123", "environment": "production", "api_created_at": "2025-10-17 14:30:00", "document_type_label": "Faktura", "document_type_code": "380", "document_number": "INV-2025-001", "issue_date": "2025-10-17", "due_date": "2025-11-17", "tax_point_date": "2025-10-17", "currency": "EUR", "buyer_reference": "PO-12345", "order_reference": "ORD-987", "supplier_name": "Leverandørvirksomhed", "supplier_company_id": "0123456789", "supplier_endpoint_id": "0208:0123456789", "supplier_vat_id": "BE0123456789", "supplier_street": "Leverandørgade 1", "supplier_city": "Bruxelles", "supplier_zip": "1000", "supplier_country": "BE", "customer_name": "Kundevirksomhed", "customer_company_id": "0987654321", "customer_endpoint_id": "0208:0987654321", "customer_vat_id": "BE0987654321", "customer_street": "Kundegade 2", "customer_city": "Namur", "customer_zip": "5000", "customer_country": "BE", "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00", "payable_amount": "121.00", "line_extension_amount": "100.00", "tax_exclusive_amount": "100.00", "tax_inclusive_amount": "121.00", "allowance_total_amount": "0.00", "charge_total_amount": "0.00", "prepaid_amount": "0.00", "payment_means_code": "30", "payment_id": "INV-2025-001", "iban": "BE12345678901234", "bic": "GEBABEBB", "has_embedded_pdf": 1, "created_at": "2025-10-17 14:31:00" } ] }
Status: 400Mangler påkrævet leverandør_id.
Status: 500Serverfejl.
/doc-modtaget/linjer/liste • Metoder:

Liste over modtagne købsfakturalinjer

Viser linjerne i en modtaget købsfaktura ved hjælp af supplier_id og document_id. document_id'et knyttes til peppox_inbound_purchase_invoices.flowin_document_id.
/doc-modtaget/linjer/liste • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Påkrævet leverandør-id.
dokument_id snor Ja Påkrævet modtaget dokument-ID. Kortlægges til flowin_document_id.
q snor Ingen Søgning efter søgeord på tværs af felter for modtagne fakturalinjer.
side heltal Ingen 1 Sidetal.
pr._side heltal Ingen 300 Rækker pr. side. Maksimum: 300.
include_raw boolsk Ingen 0 Sæt til 1 for at inkludere raw_line_xml og parser_json.
search_raw boolsk Ingen 0 Sæt til 1 for at søge i raw_line_xml og parser_json.
sorter_efter snor Ingen linjenummer Sorteringskolonne. Tilladt: id, invoice_header_id, customer_id, supplier_id, flowin_document_id, line_no, line_id, item_name, quantity, unit_code, unit_price, moms_rate, line_total_excl_vat, line_total_vat, line_total_incl_vat, currency, created_at.
sorteringsmappe snor Ingen ASC Sorteringsretning: ASC eller DESC.

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
PYTHON
krølle "https://api.peppox.com/doc-received/lines/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148&document_id=e1de8615-ce41-425a-ba88-0b834bf3ccf9"

Svar

Status: 200Succes — returnerer modtagne fakturametadata, filtre, sortering, paginering og linjerækker.
JSON
{ "ok": sand, "endpoint": "doc-received/lines/list", "method": "GET", "invoice": { "id": 25, "customer_id": 7, "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "document_number": "INV-2025-001", "document_type_code": "380", "document_type_label": "Faktura", "issue_date": "2025-10-17", "due_date": "2025-11-17", "currency": "EUR", "supplier_name": "Leverandørvirksomhed", "customer_name": "Kundevirksomhed", "total_excl_vat": "100,00", "total_vat": "21,00", "total_incl_vat": "121,00", "payable_amount": "121,00", "import_status": "importeret", "api_created_at": "2025-10-17 14:30:00" }, "filters": { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "q": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "linjenummer", "sort_dir": "ASC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "line_id": "1", "description": "Konsulentydelse", "item_name": "Konsulentydelse", "item_seller_id": "SKU-001", "item_buyer_id": null, "quantity": "2.00", "unit_code": "H87", "unit_price": "50.00", "base_quantity": "1,00", "vat_category_id": "S", "vat_rate": "21,00", "vat_scheme": "Moms", "line_total_excl_vat": "100,00", "line_total_vat": "21,00", "line_total_incl_vat": "121,00", "currency": "EUR", "created_at": "2025-10-17 14:31:00" } ] }
Status: 400Mangler obligatorisk supplier_id eller document_id.
Status: 404Modtaget faktura blev ikke fundet eller er ikke tilladt for dette supplier_id/document_id.
Status: 500Serverfejl.

PDF til Peppol

/pdf2peppol/tilføj • Metoder: STOLPE

Upload en PDF til Peppol-konvertering

Modtager et PDF-dokument via filupload, base64 eller URL. Peppox gemmer det i PDF til Peppol-køen og starter konverteringsprocessen. Dokumentet sendes ikke med det samme til Peppol: det skal først behandles, kontrolleres, bekræftes og derefter sendes.
STOLPE /pdf2peppol/tilføj • Bedøm: 50 PDF/måned som standard

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Leverandør-id. Accepteret alias: apikey eller api_key.
pdf_url snor Ingen Offentlig URL til den PDF, der skal importeres. Alias: file_url, document_url, url.
pdf_base64 legeme snor Ingen PDF-indhold kodet i base64. Alias: content_base64, file_base64, document_base64, base64.
pdf-fil fil Ingen Upload af PDF-fil. Accepterede feltnavne: pdf, fil, faktura_pdf, dokument, pdf_fil.
filnavn snor Ingen dokument.pdf Oprindeligt filnavn. Bruges ved afsendelse af base64 eller URL.
netværk snor Ingen produktion Peppol-netværk. Tilladt: produktion eller integration. Alias: net_work, environment.
dokumenttypekode snor Ingen 380 Dokumenttype. 380 = salgsfaktura, 381 = kreditnota. Aliaser: fakturatypekode, dokumenttype, type.

Anmod om eksempler

KRØLLE
KRØLLE
KRØLLE
krølle "https://api.peppox.com/pdf2peppol/add/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&pdf_url=https://peppox.com/invoice2.pdf"

Svar

Status: 200PDF accepteret og føjet til konverteringskøen.
JSON
{ "success": true, "message": "PDF-dokument modtaget. Det venter nu på behandling.", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "status": "afventer", "from_api": 1, "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "queue_customer_id": 12, "document_type_code": "380", "document_type_label": "Salgsfaktura", "network": "production", "pdf_source": "url", "filename": "invoice2.pdf", "monthly_limit": { "limit": 50, "used": 4, "remaining_before_upload": 46 } }
Status: 400Ugyldig anmodning, ugyldig leverandør, ugyldig PDF, fil for stor eller månedlig grænse nået.
/pdf2peppol/tjek • Metoder:

Tjek PDF til Peppol-konvertering

Returnerer konverteringsstatus, udtrukne headerdata, udtrukne linjer, PDF-link og Peppol-parathedskontroller for et PDF-dokument i kø.
/pdf2peppol/tjek • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Leverandør-id. Accepteret alias: apikey eller api_key.
kø_guid snor Ja Kø-GUID returneret af /pdf2peppol/add. Alias: guid.
download_pdf forespørgsel boolsk Ingen 0 Hvis den er indstillet til 1, returneres den originale PDF i stedet for JSON.

Anmod om eksempler

KRØLLE
KRØLLE
krølle "https://api.peppox.com/pdf2peppol/check/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Konverteringen er indlæst.
JSON
{ "success": true, "message": "PDF til Peppol konvertering indlæst.", "queue": { "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "document_type_code": "380", "document_type_label": "Salgsfaktura", "network": "production", "filename": "invoice.pdf", "pdf_url": "https://api.peppox.com/pdf2peppol/check/?download_pdf=1&supplier_id=de5c569-0f03-4248-9dae-9f9520c2a477e&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa", "processing": { "status": "parsed", "is_waiting": false, "is_finished": true, "has_error": false }, "verification": { "confirmed": false, "confirmed_at": "" }, "peppol_send": { "status": "blokeret", "requested_at": "", "completed_at": "", "peppox_invoice_guid": "", "error": "" } }, "peppol_readiness": { "ready_for_peppol": true, "can_be_verified": sand, "verification_confirmed": falsk, "can_be_sent_now": falsk, "send_block_reason": "Dokumentet skal verificeres, før det kan sendes." }, "converted_data": { "header": { "document": { "document_number": "INV-2025-001", "document_date": "2025-10-17", "document_type_code": "380", "document_type_label": "Salgsfaktura", "currency": "EUR", "peppol_ready": true }, "buyer": { "name": "Kunde Virksomhed", "company_number": "0123456789", "country": "BE" }, "totals": { "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00" } }, "lines_count": 1, "lines": [ { "line_no": 1, "description": "Konsulentydelse", "quantity": "1", "unit_price": "100.00", "vat_rate": "21" } ] } }
Status: 400Ugyldigt supplier_id, queue_guid eller konvertering ikke fundet.
/pdf2peppol/bekræft • Metoder: STOLPE

Bekræft konverterede PDF-oplysninger

Bekræfter, at de udtrukne faktura- eller kreditnotaoplysninger er korrekte. Denne bekræftelse er påkrævet, før dokumentet kan sendes til Peppol.
STOLPE /pdf2peppol/bekræft • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Leverandør-id. Accepteret alias: apikey eller api_key.
kø_guid snor Ja Kø-GUID returneret af /pdf2peppol/add. Alias: guid.
bekræftet boolsk Ingen 1 Valgfrit bekræftelsesflag. Slutpunktet bekræfter dokumentet, hvis alle obligatoriske Peppol-felter er tilgængelige.

Anmod om eksempler

KRØLLE
KRØLLE
krølle "https://api.peppox.com/pdf2peppol/confirm/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Dokumentbekræftelse bekræftet og klar til afsendelse.
JSON
{ "success": true, "message": "Dokumentbekræftelse bekræftet. Dokumentet er klar til at blive sendt til Peppol.", "supplier_id": "ed751d5a-661e-4f6e-9d74-2d7447be4a9d", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "document_type_code": "380", "document_type_label": "Salgsfaktura", "verification_confirmed": true, "verification_confirmed_at": "2025-10-17 15:10:00", "send_status": "ready", "ready_for_peppol": true, "checks": { "document_number": true, "document_date": true, "buyer_name": true, "buyer_identifier": true, "buyer_street": true, "buyer_city": sand, "buyer_postal": sand, "buyer_country": sand, "document_lines": sand }, "missing_fields": [] }
Status: 400Dokumentet kan ikke bekræftes, da der mangler data, eller konverteringen ikke er klar.
/pdf2peppol/send • Metoder: STOLPE

Send bekræftet PDF-dokument til Peppol

Sender en bekræftet PDF til Peppol. Peppox opretter fakturaen eller kreditnotaen, tilføjer linjer, vedhæfter den originale PDF, genererer Peppol XML og starter afsendelsesarbejdsgangen. Vigtigt: Efter kald af dette slutpunkt skal der tillades en forsinkelse på et par minutter, da flere interne processer fuldfører og validerer dokumentet før den endelige Peppol-levering.
STOLPE /pdf2peppol/send • Bedøm: 300 r/min

Parametre

NavnITypePåkrævetMisligholdelseBeskrivelse
leverandør_id snor Ja Leverandør-id. Accepteret alias: apikey eller api_key.
kø_guid snor Ja Kø-GUID returneret af /pdf2peppol/add. Alias: guid.

Anmod om eksempler

KRØLLE
KRØLLE
krølle "https://api.peppox.com/pdf2peppol/send/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Dokument sendt eller allerede sendt. Den endelige leveringsstatus for Peppol kan tage et par minutter, da den interne behandling fortsætter efter anmodningen.
JSON
{ "success": true, "message": "Salgsfaktura sendt til Peppol.", "supplier_id": "ed751d5a-661e-4f6e-9d74-2d7447be4a9d", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "peppox_document_guid": "0e8b3c9d-1111-4444-9999-aabbccddeeff", "document_type_code": "380", "document_type_label": "Salgsfaktura", "network": "production", "send_status": "sendt", "payment_reference": "INV-2025-001", "buyer": { "name": "Kunde/Virksomhed", "vat_id": "BE0123456789", "company_id": "0123456789", "street": "Kunde Gade 1", "city": "Bruxelles", "postal": "1000", "country": "BE", "phone": "+32123456789", "email": "customer@example.com" }, "steps": { "document_create": "ok", "document_lines": "ok", "pdf_attachment": "ok", "xml_generate": "ok" }, "peppox_responses": { "invoice_add": { "ok": true, "invoice_guid": "0e8b3c9d-1111-4444-9999-aabbccddeeff", "status": "DRAFT" }, "xml_generate": { "ok": true, "status": "XML_BUILT", "xml_path": "oprettet" } } }
Status: 400Dokumentet kan ikke sendes. Det er muligvis ikke parset, ikke bekræftet, allerede sendt, der mangler data, eller Peppox API har returneret en fejl.
Status: 405Metode ikke tilladt.

Webhooks

Ingen webhooks dokumenteret.

SDK'er

Ingen SDK'er angivet.

Fejlkatalog

Ingen fejl defineret.

Ændringslog

Ingen udgivelser endnu.