Peppox API — API Documentation

Autentisering

Typ
APIKEY — API-NYCKEL
Plats
fråga / parameter: apikey
Reserv via fråga/kroppsparameter "apikey"
HÄMTA https://api.peppox.com//sendsms/?apikey=YOUR_API_KEY

Fakturahantering

/faktura/lägg till • Metoder: POSTA

Lägg till en försäljningsfakturarubrik

Skapar en ny fakturarubrik med statusen UTKAST. Slutpunkten registrerar all leverantörs- och kundinformation, utgivningsdatum, betalningsvillkor och leveransdetaljer. Leverantörsdata laddas automatiskt från din API-nyckelregistrering (customer_api).
POSTA /faktura/lägg till • Betygsätt: 60 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel (från ditt registrerade leverantörskonto).
nätverk sträng Inga Valfri nätverksidentifierare (Peppol som standard).
inv_id sträng Inga Valfritt internt fakturanummer.
utgivningsdatum sträng Ja Fakturautgivningsdatum (ÅÅÅÅ-MM-DD).
förfallodatum sträng Inga Fakturans förfallodatum (ÅÅÅÅ-MM-DD).
fakturatypkod sträng Inga 380 Peppol fakturatypkod (t.ex. 380 = Faktura, 381 = Kreditnota).
valuta sträng Inga euro ISO-valutakod.
redovisningskostnad sträng Inga Referens till intern redovisningskod.
köparreferens sträng Inga Köparreferens/inköpsordernummer.
betalning.medel_kod sträng Inga 1 Betalningsmedel (Peppol-kodlista).
betalning.betalnings-id sträng Inga Betalningsidentifierare/referens.
betalning.iban sträng Inga Betalningsmottagarens IBAN.
betalning.kontonamn sträng Inga Namn på betalningsmottagarens kontoinnehavare.
betalning.bic sträng Inga Betalningsmottagarens BIC/SWIFT-kod.
betalningsvillkor_anmärkning sträng Inga Betalningsvillkor anmärkning.
leveransdatum sträng Inga Leveransdatum.
leverans.platsschema sträng Inga 0088 Identifierare för leveransplatsschema.
leverans.plats-id sträng Inga Leveransplats-ID.
leverans.gata sträng Inga Leveransadress gata.
leveransstad sträng Inga Leveransadress stad.
leverans.post sträng Inga Leveransadress postnummer.
leveransland sträng Inga Leveransadress landskod.
leverans.partsnamn sträng Inga Namn på leveranspart.
kund.slutpunktsschema sträng Inga 0208 Kundens Peppol-schema-ID.
kund.slutpunkts-id sträng Inga Kundens Peppol-deltagares ID.
kundnamn sträng Inga Kundens namn.
kund.gata sträng Inga Kundgatan.
kund.stad sträng Inga Kundens stad.
kund.post sträng Inga Kundens postnummer.
kund.land sträng Inga Kundens landskod.
kund.moms_id sträng Inga Kundens momsregistreringsnummer.
kund.företags-id-schema sträng Inga 0208 Kundföretagets ID-schema.
kund.företags-id sträng Inga Kundens företags-ID (nationellt nummer).
kund.telefon sträng Inga Kundkontakt telefon.
kund.e-postadress sträng Inga Kundens kontakt-e-postadress.

Begär exempel

RINGLA
PYTONORM
curl -X POST "https://api.peppox.com/invoice/add/" \ -H "Auktorisering: Bärare YOUR_API_KEY" \ -H "Innehållstyp: 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-leverantör" } }"

Svar

Status: 200Faktura skapad (utkast).
JSON
{ "ok": sant, "faktura_guid": "inv-8c3b4a99-2025-10-17", "status": "UTKAST" }
Status: 400Ogiltiga eller saknade fält.
Status: 401Ogiltig eller utgången API-nyckel.
Status: 500Internt server- eller databasfel.
/fakturarad/lägg till • Metoder: POSTA

Lägg till en fakturarad till en befintlig faktura

Lägger till en ny rad till en befintlig faktura (identifierad av invoice_guid). Stöder enhets-, kvantitets-, pris-, momskategori- och produktidentifieringskoder.
POSTA /fakturarad/lägg till • Betygsätt: 60 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel (krävs för autentisering).
faktura_guid sträng Ja Det unika faktura-GUID som returneras från /invoice/add.
rad_id sträng Inga Valfri intern radidentifierare (standard är genererat GUID).
kvantitet antal Ja Kvantitet av varan eller tjänsten.
enhetskod sträng Inga Enhetskod enligt UNECE Rec 20 (t.ex. H87 för ”styck”).
prisbelopp antal Ja Enhetspris (exklusive moms).
artikelbeskrivning sträng Inga Beskrivning av varan eller tjänsten.
artikelnamn sträng Inga Objektets namn eller titel.
säljarens_artikel-id sträng Inga Säljarens interna artikel-ID eller SKU.
std_item_id_schema sträng Inga 0088 Standardschema-ID för artikelidentifiering (t.ex. GTIN).
std_item_id sträng Inga Standardiserat artikel-ID (GTIN, EAN, etc.).
ursprungsland sträng Inga Ursprungsland (ISO 3166-1 alpha-2).
skattekategori sträng Inga Momskategorikod (t.ex. S, Z, AE).
skatteprocent antal Inga Momssats i procent (t.ex. 21,00).

Begär exempel

RINGLA
PYTONORM
curl -X POST "https://api.peppox.com/invoice_line/add/" \ -H "Auktorisering: Bärare YOUR_API_KEY" \ -H "Innehållstyp: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "quantity": 2, "unit_code": "H87", "price_amount": 49.99, "item_name": "Konsulttjänst", "tax_percent": 21 }"

Svar

Status: 200Fakturarad har lagts till.
JSON
{ "ok": sant, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400Ogiltiga parametrar (saknad invoice_guid eller ogiltiga numeriska fält).
Status: 401Ogiltig eller utgången API-nyckel.
Status: 500Internt databas- eller serverfel.
/faktura_bifoga_pdf/lägg till • Metoder: POSTA

Bifoga en PDF till en befintlig faktura

Bifogar ett PDF-dokument (via uppladdning, Base64 eller fjärr-URL) till en befintlig faktura identifierad av invoice_guid. Endast en bilaga per faktura lagras; alla tidigare filer ersätts.
POSTA /faktura_bifoga_pdf/lägg till • Betygsätt: 30 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel (autentisering).
faktura_guid sträng Ja GUID för fakturan som PDF-filen ska bifogas till.
doc_id sträng Inga Valfri dokumentidentifierare (standard är faktura-ID eller ett genererat UUID).
filnamn sträng Inga bilaga.pdf Bifogad filnamn (t.ex. faktura.pdf).
mima sträng Inga ansökan/pdf MIME-typen för filen.
innehållsbas64 sträng Inga PDF-innehåll som Base64-sträng. Accepterar data-URI-format.
fil_url sträng Inga Fjärr-HTTPS-URL för en PDF att ladda ner och bifoga.
fil fil Inga Filuppladdningsfält (flerdelat/formulär-data).

Begär exempel

RINGLA
RINGLA
RINGLA
curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Auktorisering: Bärare YOUR_API_KEY" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "file=@invoice.pdf"

Svar

Status: 200PDF-filen har bifogats till fakturan.
JSON
{ "ok": sant, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "filnamn": "invoice-2025-10.pdf", "mime": "applikation/pdf", "size_bytes": 184527 }
Status: 400Ogiltiga parametrar eller saknat innehåll (ingen Base64, fil eller URL).
Status: 401Ogiltig eller utgången API-nyckel.
Status: 404Fakturan hittades inte.
Status: 500Internt server- eller databasfel.

XML-generering

/xml/generera • Metoder: POSTA

Generera en UBL XML-fil för en faktura eller kreditnota

Kombinerar fakturans/kreditnotans rubrik, rader och bifogad PDF (om sådan finns) till ett Peppol-kompatibelt UBL 3.0 XML-dokument. Returnerar den lokala sökvägen till den genererade filen och uppdaterar fakturans/kreditnotans status till XML_BUILT.
POSTA /xml/generera • Betygsätt: 30 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel för autentisering.
faktura_guid sträng Ja Den unika identifieraren för fakturan som ska konverteras till XML.
guide sträng Inga Alternativ nyckel för invoice_guid.

Begär exempel

RINGLA
PYTONORM
curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Auktorisering: Bärare YOUR_API_KEY" \ -H "Innehållstyp: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"

Svar

Status: 200XML har genererats och lagrats på servern.
JSON
{ "ok": sant, "status": "XML_BUILT", "xml_path": "/var/www/vhosts/peppox.com/httpdocs/invoices_xml/inv-8c3b4a99-2025-10-17.xml" }
Status: 400invoice_guid eller fakturarader saknas.
Status: 401Ogiltig eller utgången API-nyckel.
Status: 404Fakturan hittades inte.
Status: 500Intern XML-genererings- eller skrivfel.

Kreditanteckningar

/kreditnota/lägg till • Metoder: POSTA

Lägg till en rubrik för kreditnota

Skapar en ny kreditnotarubrik med statusen UTKAST. Leverantörsdata laddas automatiskt från API-nyckelkontot, medan kund-, betalnings- och leveransfält accepteras från begäran.
POSTA /kreditnota/lägg till • Betygsätt: 60 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel.
nätverk sträng Inga Valfri nätverksidentifierare.
kreditnota-id sträng Inga Föredraget kreditnotanummer/identifierare.
cn_id sträng Inga Alternativt alias för kreditnota-ID.
kreditnota-id sträng Inga Alternativt alias för kreditnota-ID.
inv_id sträng Inga Alternativ äldre identifierare.
utgivningsdatum sträng Ja Kreditnotans utfärdandedatum (ÅÅÅÅ-MM-DD).
förfallodatum sträng Inga Förfallodatum (ÅÅÅÅ-MM-DD).
fakturatypkod sträng Inga 381 Dokumenttypkod. Standard 381 = Kreditfaktura.
valuta sträng Inga euro ISO-valutakod.
redovisningskostnad sträng Inga Intern redovisningsreferens.
köparreferens sträng Inga Köparreferens / kundorderreferens.
betalning.medel_kod sträng Inga 1 Betalning innebär kod.
betalning.betalnings-id sträng Inga Betalningsreferens.
betalning.iban sträng Inga Betalningsmottagarens IBAN.
betalning.kontonamn sträng Inga Betalningsmottagarens kontonamn.
betalning.bic sträng Inga Betalningsmottagarens BIC/SWIFT.
betalningsvillkor_anmärkning sträng Inga Betalningsvillkor anmärkning.
leveransdatum sträng Inga Leveransdatum.
leverans.platsschema sträng Inga 0088 Schema för leveransplats.
leverans.plats-id sträng Inga Leveransplatsidentifierare.
leverans.gata sträng Inga Leveransgata.
leveransstad sträng Inga Leveransstad.
leverans.post sträng Inga Leverans postnummer.
leveransland sträng Inga Leveranslandskod.
leverans.partsnamn sträng Inga Namn på leveranspart.
leverantör.slutpunktsschema sträng Inga 0208 Leverantörens slutpunktsschema. Leverantörsvärden laddas annars från API-kontot.
kund.slutpunktsschema sträng Inga 0208 Kundens slutpunktsschema.
kund.slutpunkts-id sträng Inga Kundens slutpunkts-ID.
kundnamn sträng Inga Kundens juridiska namn.
kund.gata sträng Inga Kundgatan.
kund.stad sträng Inga Kundens stad.
kund.post sträng Inga Kundens postnummer.
kund.land sträng Inga Kundens landskod.
kund.moms_id sträng Inga Kundens momsregistreringsnummer.
kund.företags-id-schema sträng Inga 0208 Kundföretagets ID-schema.
kund.företags-id sträng Inga Kundens företags-ID.
kund.telefon sträng Inga Kundens telefon.
kund.e-postadress sträng Inga Kundens e-postadress.

Begär exempel

RINGLA
PYTONORM
curl -X POST "https://api.peppox.com/creditnote/add/" -H "Auktorisering: Bärare YOUR_API_KEY" -H "Innehållstyp: 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: 200Kreditnotan har skapats.
JSON
{ "ok": sant, "faktura_guid": "cn-8c3b4a99-2025-10-17", "dokumenttyp": "KREDITNOTA", "status": "UTKAST" }
Status: 400Ogiltiga eller saknade fält.
Status: 401Ogiltig eller utgången API-nyckel.
Status: 500Internt server- eller databasfel.
/kreditnoteringsrad/lägg till • Metoder: POSTA

Lägg till en kreditnotarad

Lägger till en rad i en befintlig kreditnota. Accepterar automatiskt alias för creditnote_guid och beräknar tax_category från tax_percent när det är möjligt.
POSTA /kreditnoteringsrad/lägg till • Betygsätt: 60 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel.
kreditnota_guid sträng Ja Målkreditnotans GUID.
faktura_guid sträng Inga Alias för creditnote_guid.
guide sträng Inga Alias för creditnote_guid.
rad_id sträng Inga Valfri intern linjeidentifierare.
orderrads-id sträng Inga Alias för rad_id.
kvantitet antal Ja Linjekvantitet.
antal antal Inga Alias för kvantitet.
q antal Inga Alias för kvantitet.
enhetskod sträng Inga Enhetskod.
enhet sträng Inga Alias för enhetskod.
du sträng Inga Alias för enhetskod.
prisbelopp antal Ja Enhetsprisbelopp.
pris antal Inga Alias för price_amount.
enhetspris antal Inga Alias för price_amount.
artikelbeskrivning sträng Inga Linjebeskrivning.
beskrivning sträng Inga Alias för artikelbeskrivning.
beskriv sträng Inga Alias för artikelbeskrivning.
artikelnamn sträng Inga Artikelnamn/titel.
namn sträng Inga Alias för objektnamn.
titel sträng Inga Alias för objektnamn.
säljarens_artikel-id sträng Inga Säljarens artikel-ID/SKU.
säljar-id sträng Inga Alias för seller_item_id.
sku sträng Inga Alias för seller_item_id.
std_item_id_schema sträng Inga 0088 Standardiserat schema för artikelidentifiering.
std_schema sträng Inga Alias för std_item_id_scheme.
schema sträng Inga Alias för std_item_id_scheme.
std_item_id sträng Inga Standardartikel-ID (EAN, GTIN, etc.).
gtin sträng Inga Alias för std_item_id.
ean sträng Inga Alias för std_item_id.
ursprungsland sträng Inga Ursprungsland.
land sträng Inga Alias för ursprungsland.
skattekategori sträng Inga Momskategorikod. Tvingas automatiskt till S eller Z beroende på momsprocent.
tax_cat sträng Inga Alias för skattekategori.
momskategori sträng Inga Alias för skattekategori.
skatteprocent antal Inga Momsprocent.
momssats antal Inga Alias för tax_procent.
beskatta antal Inga Alias för tax_procent.
moms antal Inga Alias för tax_procent.

Begär exempel

RINGLA
PYTONORM
curl -X POST "https://api.peppox.com/creditnote_line/add/" -H "Auktorisering: Bärare YOUR_API_KEY" -H "Innehållstyp: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "kvantitet": 2, "enhetskod": "H87", "prisbelopp": 49,99, "artikelnamn": "Returnerad konsulttjänst", "skatteprocent": 21 }"

Svar

Status: 200Kreditnotalinjen har lagts till.
JSON
{ "ok": sant, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400Obligatoriska värden som creditnote_guid, quantity eller price_amount saknas.
Status: 401Ogiltig eller utgången API-nyckel.
Status: 500Internt databasfel.
/kreditnota_bifoga_pdf/lägg till • Metoder: POSTA

Bifoga en PDF till en kreditnota

Bifogar ett PDF-dokument till en befintlig kreditfaktura med hjälp av flerdelad uppladdning, Base64-nyttolast eller fjärr-URL. Tidigare bilaga ersätts.
POSTA /kreditnota_bifoga_pdf/lägg till • Betygsätt: 30 req/min Auktorisering krävs

Parametrar

NamnITypNödvändigStandardBeskrivning
apikey sträng Ja Din Peppox API-nyckel.
kreditnota_guid sträng Ja Kreditnotans GUID att bifoga PDF-filen till.
faktura_guid sträng Inga Alias för creditnote_guid.
guide sträng Inga Alias för creditnote_guid.
doc_id sträng Inga Valfri dokumentidentifierare. Standardvärdet är inv_id eller ett genererat UUID.
filnamn sträng Inga bilaga.pdf Filnamn för bilaga.
mima sträng Inga ansökan/pdf Bifogad fil MIME-typ.
innehållsbas64 sträng Inga PDF-innehåll kodat som Base64.
pdf_base64 sträng Inga Alias för content_base64.
fil_url sträng Inga HTTP/HTTPS-URL till PDF-filen som ska laddas ner och bifogas.
pdf_url sträng Inga Alias för file_url.
fil fil Inga Flerdelad uppladdad fil.

Begär exempel

RINGLA
RINGLA
RINGLA
curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Auktorisering: Bärare YOUR_API_KEY" -F "creditnote_guid=cn-8c3b4a99-2025-10-17" -F "fil=@creditnote.pdf"

Svar

Status: 200PDF-filen har bifogats till kreditnotan.
JSON
{ "ok": sant, "creditnote_guid": "cn-8c3b4a99-2025-10-17", "doc_id": "CN-2025-001", "filnamn": "creditnote.pdf", "mime": "applikation/pdf", "size_bytes": 184527 }
Status: 400Ogiltig begäran: creditnote_guid saknas, ogiltig Base64, ogiltig URL eller inget innehåll tillhandahålls.
Status: 401Ogiltig eller utgången API-nyckel.
Status: 404Kreditnotan hittades inte.
Status: 500Internt databas- eller filhanteringsfel.

Skickade dokument

/dokument-skickat/rubrik/lista • Metoder:

Lista skickade fakturarubriker

Listar skickade fakturahuvuden för en leverantör. Stöder sökord, datumfilter, Peppol-statusfilter, lokala statusfilter, inkludering av råa svar, sortering och paginering.
/dokument-skickat/rubrik/lista • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Obligatorisk leverantörsidentifierare. Detta värde mappas till invoices.apikey.
q sträng Inga Nyckelordssökning i fakturarubrikfält.
sida heltal Inga 1 Sidnummer.
per_sida heltal Inga 300 Rader per sida. Maximalt: 300.
datum sträng Inga Filter för exakt datum i formatet ÅÅÅÅ-MM-DD.
datum_från sträng Inga Startdatum för periodfiltret i formatet ÅÅÅÅ-MM-DD.
datum_till sträng Inga Slutdatum för periodfiltret i formatet ÅÅÅÅ-MM-DD.
datumfält sträng Inga skickat_vid Datumfält som används för date/date_from/date_to. Tillåtet: issue_date, due_date, delivery_date, xml_built_at, sent_at, created_at, updated_at, status_from_peppol_date.
status_från_peppol sträng Inga Filtrera efter Peppol-status. Stöder CSV-värden.
peppol_status sträng Inga Alias för status_från_peppol.
status sträng Inga Alias för status_från_peppol.
lokal_status sträng Inga Filtrera efter lokal fakturastatus från invoices.status. Stöder CSV-värden.
include_raw boolesk Inga 0 Sätt till 1 för att inkludera sent_reply_api och all_response_api i svaret.
sök_rå boolesk Inga 0 Ställ in på 1 för att inkludera sent_reply_api och all_response_api i nyckelordssökningen.
sortera_efter sträng Inga skickat_vid Sortera kolumn. Tillåtet: 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.
sorteringskatalog sträng Inga DESC Sorteringsriktning: ASC eller DESC.

Begär exempel

RINGLA
RINGLA
RINGLA
PYTONORM
curl "https://api.peppox.com/doc-sent/header/list/?supplier_id=DITT_LEVERANTÖRSID"

Svar

Status: 200Lyckades — returnerar fakturarubriker med filter, sorteringsinformation, paginering och datarader.
JSON
{ "ok": true, "endpoint": "doc-sent/header/list", "method": "GET", "filters": { "supplier_id": "DITT_LEVERANTÖRSID", "q": "", "date": "", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "sent_at", "status_from_peppol": "sent", "local_status": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "sent_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": "Leverantörsföretag", "s_endpoint_id": "0208:0123456789", "c_name": "Kundföretag", "c_endpoint_id": "0208:0987654321", "status": "SKICKAT", "sent_at": "2025-10-17 14:30:00", "sent_http_code": 200, "network": "peppol", "status_from_peppol": "skickat", "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/leverantörer/.../fakturor" } ] }
Status: 400Obligatoriskt leverantörs-id saknas.
Status: 500Serverfel.
/doc-sent/lines/list • Metoder:

Lista skickade fakturarader

Listar raderna i en skickad faktura med hjälp av supplier_id och invoice_guid. supplier_id måste matcha invoices.apikey av säkerhetsskäl.
/doc-sent/lines/list • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id fråga sträng Ja Obligatorisk leverantörsidentifierare. Detta värde måste matcha invoices.apikey.
faktura_guid fråga sträng Ja Faktura-GUID som används för att lista fakturarader.
q fråga sträng Inga Valfri sökordssökning i fakturarader.
sida fråga heltal Inga 1 Sidnummer.
per_sida fråga heltal Inga 300 Rader per sida. Maximalt: 300.

Begär exempel

RINGLA
RINGLA
PYTONORM
curl "https://api.peppox.com/doc-sent/lines/list/?supplier_id=YOUR_SUPPLIER_ID&invoice_guid=inv-8c3b4a99-2025-10-17"

Svar

Status: 200Lyckades — returnerar fakturametadata, filter, paginering och fakturarader.
JSON
{ "ok": true, "endpoint": "doc-send/lines/list", "invoice": { "invoice_guid": "inv-8c3b4a99-2025-10-17", "inv_id": "INV-2025-001", "status": "SKICKAD", "sent_at": "2025-10-17 14:30:00" }, "filters": { "supplier_id": "DITT_LEVERANTÖRSID", "invoice_guid": "inv-8c3b4a99-2025-10-17", "q": "konsulttjänster" }, "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": "Konsulttjänst", "item_name": "Konsulttjänst", "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: 400Saknar obligatoriskt supplier_id eller invoice_guid.
Status: 404Fakturan hittades inte eller är inte tillåten för detta supplier_id.
Status: 500Serverfel.

Mottagna dokument

/doc-mottaget/rubrik/lista • Metoder:

Lista mottagna fakturarubriker

Listar fakturarubriker som mottagits av en leverantör via Peppol. Stöder sökord, datumfilter, importstatus, dokumenttypkod, råa fält, sortering och paginering.
/doc-mottaget/rubrik/lista • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Obligatorisk leverantörsidentifierare. Detta värde mappas till peppox_inbound_purchase_invoices.supplier_id.
q sträng Inga Nyckelordssökning i fält för mottagna fakturorubriker.
sida heltal Inga 1 Sidnummer.
per_sida heltal Inga 300 Rader per sida. Maximalt: 300.
datum sträng Inga Filter för exakt datum i formatet ÅÅÅÅ-MM-DD.
datum_från sträng Inga Startdatum för periodfiltret i formatet ÅÅÅÅ-MM-DD.
datum_till sträng Inga Slutdatum för periodfiltret i formatet ÅÅÅÅ-MM-DD.
datumfält sträng Inga api_created_at Datumfält som används för date/date_from/date_to. Tillåtet: api_created_at, issue_date, due_date, tax_point_date, created_at, updated_at.
importstatus sträng Inga Filtrera efter importstatus. Stöder CSV-värden.
status sträng Inga Alias för import_status.
dokumenttypkod sträng Inga Filtrera efter dokumenttypkod. Stöder CSV-värden. Exempel: 380-faktura, 381-kreditfaktura.
typkod sträng Inga Alias för dokumenttypkod.
include_raw boolesk Inga 0 Sätt till 1 för att inkludera customization_id, profile_id, xml_without_pdf, api_attributes_json, parser_json och notification_sent_by_email_response.
sök_rå boolesk Inga 0 Ställ in på 1 för att söka inom råa/långa fält.
sortera_efter sträng Inga api_created_at Sorteringskolumn. Tillåtet: id, kund_id, leverantör_id, flowin_document_id, api_created_at, dokument_typ_kod, dokument_nummer, utfärdande_datum, förfallodatum, skattepunktsdatum, valuta, leverantörsnamn, kundnamn, total_exkl_moms, total_moms, total_inkl_moms, betalbart_belopp, import_status, created_at, updated_at.
sorteringskatalog sträng Inga DESC Sorteringsriktning: ASC eller DESC.

Begär exempel

RINGLA
RINGLA
RINGLA
PYTONORM
curl "https://api.peppox.com/doc-received/header/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148"

Svar

Status: 200Lyckades — returnerar mottagna fakturarubriker med filter, sortering, paginering och datarader.
JSON
{ "ok": true, "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": "importerad", "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": false, "has_next": false }, "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": "Leverantörsföretag", "supplier_company_id": "0123456789", "supplier_endpoint_id": "0208:0123456789", "supplier_vat_id": "BE0123456789", "supplier_street": "Leverantörsgata 1", "supplier_city": "Bryssel", "supplier_zip": "1000", "supplier_country": "BE", "customer_name": "Kundföretag", "customer_company_id": "0987654321", "customer_endpoint_id": "0208:0987654321", "customer_vat_id": "BE0987654321", "customer_street": "Kundgata 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: 400Obligatoriskt leverantörs-id saknas.
Status: 500Serverfel.
/doc-mottaget/rader/lista • Metoder:

Lista mottagna inköpsfakturarader

Listar raderna i en mottagen inköpsfaktura med hjälp av supplier_id och document_id. document_id mappas till peppox_inbound_purchase_invoices.flowin_document_id.
/doc-mottaget/rader/lista • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Obligatorisk leverantörsidentifiering.
dokument_id sträng Ja Krävs mottaget dokument-ID. Mappas till flowin_document_id.
q sträng Inga Nyckelordssökning i fält för mottagna fakturorader.
sida heltal Inga 1 Sidnummer.
per_sida heltal Inga 300 Rader per sida. Maximalt: 300.
include_raw boolesk Inga 0 Sätt till 1 för att inkludera raw_line_xml och parser_json.
sök_rå boolesk Inga 0 Sätt till 1 för att söka i raw_line_xml och parser_json.
sortera_efter sträng Inga radnr Sorteringskolumn. Tillåtet: 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.
sorteringskatalog sträng Inga ASC Sorteringsriktning: ASC eller DESC.

Begär exempel

RINGLA
RINGLA
RINGLA
PYTONORM
curl "https://api.peppox.com/doc-received/lines/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148&document_id=e1de8615-ce41-425a-ba88-0b834bf3ccf9"

Svar

Status: 200Lyckades — returnerar mottagna fakturametadata, filter, sortering, paginering och radrader.
JSON
{ "ok": true, "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": "Leverantörsföretag", "customer_name": "Kundföretag", "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00", "payable_amount": "121.00", "import_status": "importerad", "api_created_at": "2025-10-17 14:30:00" }, "filter": { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "q": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "radnummer", "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": "Konsulttjänst", "item_name": "Konsulttjänst", "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: 400Saknar obligatoriskt supplier_id eller document_id.
Status: 404Mottagen faktura hittades inte eller är inte tillåten för detta supplier_id/document_id.
Status: 500Serverfel.

PDF till Peppol

/pdf2peppol/lägg till • Metoder: POSTA

Ladda upp en PDF för Peppol-konvertering

Tar emot ett PDF-dokument via filuppladdning, base64 eller URL. Peppox lagrar det i PDF till Peppol-kön och startar konverteringsprocessen. Dokumentet skickas inte omedelbart till Peppol: det måste först bearbetas, kontrolleras, bekräftas och sedan skickas.
POSTA /pdf2peppol/lägg till • Betygsätt: 50 PDF/månad som standard

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Leverantörsidentifierare. Godkänt alias: apikey eller api_key.
pdf_url sträng Inga Offentlig URL för PDF-filen som ska importeras. Alias: file_url, document_url, url.
pdf_base64 kropp sträng Inga PDF-innehåll kodat i base64. Alias: content_base64, file_base64, document_base64, base64.
pdf-fil fil Inga Uppladdning av PDF-fil. Godkända fältnamn: pdf, fil, faktura_pdf, dokument, pdf_fil.
filnamn sträng Inga dokument.pdf Ursprungligt filnamn. Används vid sändning av base64 eller URL.
nätverk sträng Inga produktion Peppol-nätverk. Tillåtet: produktion eller integration. Alias: net_work, miljö.
dokumenttypkod sträng Inga 380 Dokumenttyp. 380 = försäljningsfaktura, 381 = kreditfaktura. Alias: fakturatypkod, dokumenttyp, typ.

Begär exempel

RINGLA
RINGLA
RINGLA
curl "https://api.peppox.com/pdf2peppol/add/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&pdf_url=https://peppox.com/invoice2.pdf"

Svar

Status: 200PDF-filen har accepterats och lagts till i konverteringskön.
JSON
{ "success": true, "message": "PDF-dokument mottaget. Det väntar nu på bearbetning.", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "status": "väntar", "from_api": 1, "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "queue_customer_id": 12, "document_type_code": "380", "document_type_label": "Försäljningsfaktura", "network": "production", "pdf_source": "url", "filename": "invoice2.pdf", "monthly_limit": { "limit": 50, "used": 4, "remaining_before_upload": 46 } }
Status: 400Ogiltig begäran, ogiltig leverantör, ogiltig PDF, fil för stor eller månadsgräns uppnådd.
/pdf2peppol/check • Metoder:

Kontrollera konverteringen av PDF till Peppol

Returnerar konverteringsstatus, extraherade rubrikdata, extraherade rader, PDF-länk och Peppol-beredskapskontroller för ett PDF-dokument i kö.
/pdf2peppol/check • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Leverantörsidentifierare. Godkänt alias: apikey eller api_key.
kö_guid sträng Ja Kö-GUID returnerad av /pdf2peppol/add. Alias: guid.
nedladdning_pdf fråga boolesk Inga 0 Om den är satt till 1 returneras den ursprungliga PDF-filen istället för JSON.

Begär exempel

RINGLA
RINGLA
curl "https://api.peppox.com/pdf2peppol/check/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Konverteringen har laddats.
JSON
{ "success": true, "message": "Konverteringen från PDF till Peppol har laddats.", "queue": { "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "document_type_code": "380", "document_type_label": "Försäljningsfaktura", "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": "blockerad", "requested_at": "", "completed_at": "", "peppox_invoice_guid": "", "error": "" } }, "peppol_readiness": { "ready_for_peppol": true, "can_be_verified": sant, "verification_confirmed": falskt, "can_be_sent_now": falskt, "send_block_reason": "Dokumentet måste verifieras innan det kan skickas." }, "converted_data": { "header": { "document": { "document_number": "INV-2025-001", "document_date": "2025-10-17", "document_type_code": "380", "document_type_label": "Försäljningsfaktura", "currency": "EUR", "peppol_ready": true }, "buyer": { "name": "Kundföretag", "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": "Konsulttjänst", "quantity": "1", "unit_price": "100.00", "moms_rate": "21" } ] } }
Status: 400Ogiltigt supplier_id, queue_guid eller konvertering hittades inte.
/pdf2peppol/bekräfta • Metoder: POSTA

Bekräfta konverterad PDF-information

Bekräftar att den extraherade faktura- eller kreditnotainformationen är korrekt. Denna bekräftelse krävs innan dokumentet kan skickas till Peppol.
POSTA /pdf2peppol/bekräfta • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Leverantörsidentifierare. Godkänt alias: apikey eller api_key.
kö_guid sträng Ja Kö-GUID returnerad av /pdf2peppol/add. Alias: guid.
bekräftad boolesk Inga 1 Valfri bekräftelseflagga. Slutpunkten bekräftar dokumentet om alla obligatoriska Peppol-fält är tillgängliga.

Begär exempel

RINGLA
RINGLA
curl "https://api.peppox.com/pdf2peppol/confirm/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Dokumentverifiering bekräftad och klar att skickas.
JSON
{ "success": true, "message": "Dokumentverifiering bekräftad. Dokumentet är klart att skickas till Peppol.", "supplier_id": "ed751d5a-661e-4f6e-9d74-2d7447be4a9d", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "document_type_code": "380", "document_type_label": "Försäljningsfaktura", "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": true, "buyer_postal": true, "buyer_country": true, "document_lines": true }, "missing_fields": [] }
Status: 400Dokumentet kan inte bekräftas eftersom data saknas eller konverteringen inte är klar.
/pdf2peppol/skicka • Metoder: POSTA

Skicka bekräftat PDF-dokument till Peppol

Skickar en bekräftad PDF till Peppol. Peppox skapar fakturan eller kreditnotan, lägger till rader, bifogar den ursprungliga PDF-filen, genererar Peppol XML och startar sändningsarbetsflödet. Viktigt: efter att denna slutpunkt har anropats, tillåt en fördröjning på några minuter eftersom flera interna processer slutför och validerar dokumentet innan den slutliga Peppol-leveransen.
POSTA /pdf2peppol/skicka • Betygsätt: 300 räckvidder/min

Parametrar

NamnITypNödvändigStandardBeskrivning
leverantörs-id sträng Ja Leverantörsidentifierare. Godkänt alias: apikey eller api_key.
kö_guid sträng Ja Kö-GUID returnerad av /pdf2peppol/add. Alias: guid.

Begär exempel

RINGLA
RINGLA
curl "https://api.peppox.com/pdf2peppol/send/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Svar

Status: 200Dokument skickat eller redan skickat. Slutgiltig leveransstatus för Peppol kan ta några minuter eftersom intern bearbetning fortsätter efter begäran.
JSON
{ "success": true, "message": "Försäljningsfaktura skickad till 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": "Försäljningsfaktura", "network": "production", "send_status": "skickad", "payment_reference": "INV-2025-001", "buyer": { "name": "Kundföretag", "vat_id": "BE0123456789", "company_id": "0123456789", "street": "Kundens gata 1", "city": "Bryssel", "postal": "1000", "country": "BE", "phone": "+32123456789", "mail": "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": "UTKAST" }, "xml_generate": { "ok": true, "status": "XML_BUILT", "xml_path": "skapad" } } }
Status: 400Dokumentet kan inte skickas. Det kanske inte har analyserats, inte bekräftats, redan skickats, data saknas eller så returnerade Peppox API ett fel.
Status: 405Metoden är inte tillåten.

Webhooks

Inga webhooks dokumenterade.

SDK:er

Inga SDK:er listade.

Felkatalog

Inga fel definierade.

Ändringslogg

Inga utgåvor än.