Peppox Developer Platform

Send din første faktura via Peppol, trinn for trinn.

Velg ruten som passer systemet ditt – fra første API-kall til leveringssporing.

PEPPOX / INTEGRATION FLOW
  1. 01Dashboard
  2. 02API-nøkkel
  3. 03Faktura
  4. 04Valider
  5. 05Peppol
READY TO BUILD
01 · Før første kall

Fire ting som klargjøres én gang

Konfigurer konto og leverandørprofil først. Deretter bruker applikasjonen de samme opplysningene for hvert dokument.

  1. 01

    Opprett Peppox-konto

    Registrer den juridiske virksomheten som sender dokumenter.

  2. 02

    Fullfør leverandørprofilen

    Bedrifts-, MVA-, bank- og Peppol-routingdata hentes fra kontoen.

  3. 03

    Åpne integrasjonsmiljøet

    Test trygt med dashboard-verktøyene før produksjon.

  4. 04

    Kopier API-nøkkelen

    Oppbevar den kun på serveren, aldri i nettleser- eller appkode.

02 · Velg den korteste ruten

Start med dataene du allerede har

GRUPPE 2 · API FOR STRUKTURERT FAKTURAERP / regnskap / SaaS
{ }

Bygg og kontroller hvert dokumentfelt.

Bruk denne endpoint-serien når ERP-et eller programvaren eier fakturadataene og trenger presis kontroll over hode, linjer, PDF og UBL XML.

  1. Hode
  2. Dokumentlinjer
  3. PDF-vedlegg
  4. Generer UBL XML
  5. Administrer og følg
Se denne flyten →
03 · PDF2Peppol

En komplett sending i fire API-kall

Den mest direkte dokumenterte ruten når systemet allerede produserer PDF-fakturaer.

  1. 01

    Last opp PDF

    Send fil, Base64 eller URL, og lagre queue_guid.

    POST/pdf2peppol/add
  2. 02

    Kontroller uttrukne data

    Spør til behandlingen er ferdig, og kontroller kjøper, totaler, MVA og linjer.

    GET/pdf2peppol/check
  3. 03

    Bekreft dokumentet

    Bekreft først når alle uttrukne data er riktige.

    POST/pdf2peppol/confirm
  4. 04

    Send til Peppol

    Send det bekreftede dokumentet og lagre dokumentets GUID.

    POST/pdf2peppol/send
Minimalt eksempel

Upload → check → confirm → send

Erstatt eksempelverdiene med din identifikator og ID-ene fra forrige kall.

pdf2peppol.sh
curl -X POST "https://api.peppox.com/pdf2peppol/add/" \
  -F "supplier_id=YOUR_SUPPLIER_ID" \
  -F "document_type_code=380" \
  -F "pdf_file=@invoice.pdf"

# Save queue_guid, then check it
curl "https://api.peppox.com/pdf2peppol/check/?supplier_id=YOUR_SUPPLIER_ID&queue_guid=QUEUE_GUID"

curl -X POST "https://api.peppox.com/pdf2peppol/confirm/" \
  -d "supplier_id=YOUR_SUPPLIER_ID" \
  -d "queue_guid=QUEUE_GUID"

curl -X POST "https://api.peppox.com/pdf2peppol/send/" \
  -d "supplier_id=YOUR_SUPPLIER_ID" \
  -d "queue_guid=QUEUE_GUID"
04 · API for strukturert faktura

Bygg en Peppol-klar faktura fra dine data

Ideelt når ERP-systemet allerede lagrer alle felt og linjer strukturert.

  1. 01

    Opprett hodet

    Send kunde, datoer, valuta, betaling og levering; lagre invoice_guid.

    POST/invoice/add
  2. 02

    Legg til linjene

    Gjenta kallet for hvert produkt eller hver tjeneste.

    POST/invoice_line/add
  3. 03

    Legg ved PDF (valgfritt)

    Legg til den lesbare fakturaen som fil, Base64 eller URL.

    POST/invoice_attach_pdf/add
  4. 04

    Generer og send UBL XML

    Peppox oppretter UBL XML for en faktura eller kreditnota. Når den er gyldig, sender den konfigurerte Peppox-flyten den til Peppol; et separat strukturert /send-kall er ikke nødvendig.

    POST/xml/generate
  5. 05

    Følg og administrer

    Se dokument og status i dashboardet eller via API-er for sendte dokumenter.

    GET/doc-sent/header/list
API NOTE

Viktig: /xml/generate/ deles av fakturaer og kreditnotaer. Et vellykket XML_BUILT-svar betyr at Peppox har generert dokumentet og fortsetter den konfigurerte Peppol-sendingen. Det finnes ikke et ekstra strukturert /send-endpoint.

07 · Fullstendig API-referanse

Hvert støttede endpoint med sin nøyaktige kontrakt.

Parametere, gyldige formater, forespørsler klare til å kopiere og representative vellykkede svar. Tekniske feltnavn beholdes bevisst på engelsk slik at de samsvarer nøyaktig med API-et.

01

PDF2Peppol · complete PDF send flow

POST/pdf2peppol/add/ Upload a PDF and create the conversion queue
Autentisering: supplier_id is the active Company API key. Aliases: apikey, api_key.Godkjente forespørselsformater: GET or POST; multipart, form data or JSON

Påkrevd

ParameterFormatDescription
supplier_idstringAccount API key.
PDF sourcefile or stringProvide exactly one: multipart pdf / file / invoice_pdf / document / pdf_file; or pdf_base64 / content_base64; or pdf_url / file_url / document_url / url.

Valgfritt

ParameterFormatDescription
document_type_code380 or 381380 by default; 381 is a credit note. Aliases: invoice_type_code, document_type, type.
networkproduction or integrationproduction by default. Aliases: net_work, environment.
filenamestringUsed with a Base64 or URL source; a .pdf extension is normalised.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/pdf2peppol/add/" \
  -F "supplier_id=YOUR_API_KEY" \
  -F "document_type_code=380" \
  -F "network=integration" \
  -F "pdf_file=@invoice.pdf"

Representativt vellykket svar

{
  "success": true,
  "queue_guid": "pdf-…",
  "status": "pending",
  "document_type_code": "380",
  "network": "integration",
  "monthly_limit": {"limit": 50, "used": 3}
}

Implementasjonsnotater

  • Maximum PDF size: 15 MB. The file must start with a valid PDF signature.
  • Store queue_guid. It is the state identifier for check, confirm and send.
  • The response contains the account monthly PDF conversion quota state.
GET/pdf2peppol/check/ Read extraction results and Peppol readiness
Autentisering: supplier_id is the active Company API key. Aliases: apikey, api_key.Godkjente forespørselsformater: GET or POST; query string, form data or JSON

Påkrevd

ParameterFormatDescription
supplier_idstringSame value used at upload.
queue_guidstringThe queue GUID returned by /pdf2peppol/add/. Alias: guid.

Eksempelforespørsel

curl "https://api.peppox.com/pdf2peppol/check/?supplier_id=YOUR_API_KEY&queue_guid=QUEUE_GUID"

Representativt vellykket svar

{
  "success": true,
  "queue": {"queue_guid": "pdf-…", "confirmed": false},
  "peppol_readiness": {"ready_for_peppol": true, "missing_required_fields": []},
  "converted_data": {"header": {}, "lines_count": 2, "lines": []}
}

Implementasjonsnotater

  • Poll this endpoint while conversion is pending; do not call confirm until ready_for_peppol is true.
  • Review missing_required_fields, header values, line values and totals before confirming.
POST/pdf2peppol/confirm/ Confirm the converted document
Autentisering: supplier_id is the active Company API key. Aliases: apikey, api_key.Godkjente forespørselsformater: GET or POST; query string, form data or JSON

Påkrevd

ParameterFormatDescription
supplier_idstringSame account key.
queue_guidstringThe queue GUID returned by upload. Alias: guid.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/pdf2peppol/confirm/" \
  -d "supplier_id=YOUR_API_KEY" \
  -d "queue_guid=QUEUE_GUID"

Representativt vellykket svar

{
  "success": true,
  "verification_confirmed": true,
  "ready_for_peppol": true,
  "send_status": "ready",
  "missing_fields": []
}

Implementasjonsnotater

  • Confirmation is refused if mandatory converted data is missing.
  • Confirm is a separate explicit action; uploading alone never sends the document.
POST/pdf2peppol/send/ Send the confirmed document through Peppol
Autentisering: supplier_id is the active Company API key. Aliases: apikey, api_key.Godkjente forespørselsformater: GET or POST; query string, form data or JSON

Påkrevd

ParameterFormatDescription
supplier_idstringSame account key.
queue_guidstringA confirmed and ready queue GUID. Alias: guid.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/pdf2peppol/send/" \
  -d "supplier_id=YOUR_API_KEY" \
  -d "queue_guid=QUEUE_GUID"

Representativt vellykket svar

{
  "success": true,
  "queue_guid": "pdf-…",
  "peppox_document_guid": "…",
  "send_status": "sent",
  "steps": {"document_create": "ok", "xml_generate": "ok"}
}

Implementasjonsnotater

  • The endpoint is idempotent for an already sent queue: it returns the existing sent state.
  • It checks document number, date, buyer identity/address and converted lines again before dispatch.
02

Structured sales invoice

POST/invoice/add/ Create an invoice header
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
inv_idstringYour unique invoice number; needed before UBL generation.
issue_dateYYYY-MM-DDInvoice issue date.
customer.endpoint_idstringBuyer Peppol endpoint identifier.
customer.namestringBuyer legal or trading name.
customer.street / city / postal / countrystringsBuyer postal address; needed for a Peppol-ready document.

Valgfritt

ParameterFormatDescription
due_dateYYYY-MM-DDDefaults to issue_date at XML generation if omitted.
invoice_type_code380380 by default for a sales invoice.
currencyISO 4217EUR by default.
buyer_reference, accounting_coststringAccounting references.
payment.*objectmeans_code, payment_id, iban, account_name, bic, terms_note.
delivery.*objectdate, location_scheme, location_id, street, city, postal, country, party_name.
networkstringAlias: net_work. Supplier identity and bank IBAN come from the Company profile.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/invoice/add/" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "YOUR_API_KEY",
    "inv_id": "INV-2026-0042",
    "issue_date": "2026-09-11",
    "currency": "EUR",
    "customer": {
        "endpoint_scheme": "0208",
        "endpoint_id": "0123456789",
        "name": "Buyer Ltd",
        "street": "Main Street 1",
        "city": "Brussels",
        "postal": "1000",
        "country": "BE"
    }
}'

Representativt vellykket svar

{
  "ok": true,
  "invoice_guid": "…",
  "status": "DRAFT"
}

Implementasjonsnotater

  • Save invoice_guid. It connects the header, every line, optional PDF and generated XML.
  • Supplier name, address, identifiers and payee IBAN are sourced from the configured Company profile.
POST/invoice_line/add/ Add one sales invoice line
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
invoice_guidstringGUID returned by /invoice/add/. Alias: guid.
quantitydecimalQuantity for the line.
unit_codeUNECE unit codeFor example C62 for one unit.
price_amountdecimalUnit price excluding VAT.
item_description / item_namestringLine description and item name.
tax_percentdecimalVAT rate; the API maps positive rates to category S and 0 to Z.

Valgfritt

ParameterFormatDescription
line_idstringAlias: order_line_id; a GUID is generated if omitted.
seller_item_idstringAliases: seller_id, sku.
std_item_idstringAliases: gtin, ean.
std_item_id_schemestring0088 by default.
origin_countryISO country codeAlias: country.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/invoice_line/add/" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "YOUR_API_KEY",
    "invoice_guid": "INVOICE_GUID",
    "line_id": "1",
    "quantity": "2",
    "unit_code": "C62",
    "price_amount": "49.50",
    "item_name": "Consulting",
    "item_description": "Consulting service",
    "tax_percent": "21"
}'

Representativt vellykket svar

{
  "ok": true,
  "line_guid": "…"
}

Implementasjonsnotater

  • Call once per line before XML generation.
  • Use decimal values with a dot in new integrations.
POST/invoice_attach_pdf/add/ Attach or replace the invoice PDF
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; multipart, JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
invoice_guidstringGUID returned by /invoice/add/. Alias: guid.
PDF sourcefile or stringProvide one: multipart file; content_base64 / pdf_base64; or file_url / pdf_url (HTTP or HTTPS).

Valgfritt

ParameterFormatDescription
doc_idstringDefaults to inv_id or a generated UUID.
filenamestringattachment.pdf by default.
mimestringapplication/pdf by default.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \
  -F "apikey=YOUR_API_KEY" \
  -F "invoice_guid=INVOICE_GUID" \
  -F "file=@invoice.pdf"

Representativt vellykket svar

{
  "ok": true,
  "invoice_guid": "…",
  "doc_id": "INV-2026-0042",
  "filename": "invoice.pdf",
  "mime": "application/pdf",
  "size_bytes": 248512
}

Implementasjonsnotater

  • A new attachment replaces the previous attachment for the same invoice GUID.
  • For a URL source, Peppox downloads the file server-side; only http and https are accepted.
POST/xml/generate/ Generate XML and submit a sales invoice to Peppol
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
invoice_guidstringRequired for an invoice. Use the GUID returned by /invoice/add/; guid is accepted as an alias.

Valgfritt

ParameterFormatDescription
networkstringStored operational network value.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/xml/generate/" \
  -d "apikey=YOUR_API_KEY" \
  -d "invoice_guid=INVOICE_GUID"

Representativt vellykket svar

{
  "ok": true,
  "status": "XML_BUILT",
  "xml_path": "…",
  "document_type": "INVOICE"
}

Implementasjonsnotater

  • Use only after the invoice header and every invoice line have been saved.
  • The invoice header determines document type 380. Do not add a separate document-type parameter to this call.
  • Peppox calculates totals and VAT subtotals from the saved invoice lines.
  • This is the final structured-invoice call: it creates the UBL XML and, when it is valid, continues the configured Peppol submission. There is no extra structured /send endpoint.
03

Structured credit note

POST/creditnote/add/ Create a credit note header
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
creditnote_idstringCredit note number. Aliases: cn_id, credit_note_id, inv_id.
issue_dateYYYY-MM-DDCredit note issue date.
customer.endpoint_id / name / addressobjectBuyer endpoint, name, street, city, postal code and country.

Valgfritt

ParameterFormatDescription
invoice_type_code381381 by default for a credit note.
due_date, currency, buyer_reference, accounting_costvaluesSame meaning as /invoice/add/.
payment.*, delivery.*, networkobjects / stringSame field structure as /invoice/add/.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/creditnote/add/" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "YOUR_API_KEY",
    "creditnote_id": "CN-2026-001",
    "issue_date": "2026-09-11",
    "customer": {
        "endpoint_id": "0123456789",
        "name": "Buyer Ltd",
        "street": "Main Street 1",
        "city": "Brussels",
        "postal": "1000",
        "country": "BE"
    }
}'

Representativt vellykket svar

{
  "ok": true,
  "invoice_guid": "…",
  "document_type": "CREDIT_NOTE",
  "status": "DRAFT"
}

Implementasjonsnotater

  • Save invoice_guid; it is also accepted by later credit-note endpoints.
  • Supplier profile data is loaded from the Company configuration.
POST/creditnote_line/add/ Add one credit note line
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
creditnote_guidstringGUID returned by /creditnote/add/. Aliases: invoice_guid, guid.
quantitydecimalRequired.
price_amountdecimalRequired unit price.
unit_code, item_name, item_description, tax_percentvaluesUse the same structure as /invoice_line/add/.

Valgfritt

ParameterFormatDescription
line_id, seller_item_id, std_item_id, std_item_id_scheme, origin_countryvaluesSame aliases and defaults as sales invoice lines.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/creditnote_line/add/" \
  -d "apikey=YOUR_API_KEY" \
  -d "creditnote_guid=CREDITNOTE_GUID" \
  -d "quantity=1" -d "unit_code=C62" \
  -d "price_amount=49.50" -d "item_name=Refund" \
  -d "item_description=Service refund" -d "tax_percent=21"

Representativt vellykket svar

{
  "ok": true,
  "line_guid": "…"
}

Implementasjonsnotater

  • Tax category is automatically S for a positive rate and Z for zero rate.
  • Add every line before generating XML.
POST/creditnote_attach_pdf/add/ Attach or replace the credit note PDF
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; multipart, JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
creditnote_guidstringCredit note GUID. Aliases: invoice_guid, guid.
PDF sourcefile or stringmultipart file, content_base64 / pdf_base64, or HTTP(S) file_url / pdf_url.

Valgfritt

ParameterFormatDescription
doc_id, filename, mimevaluesSame meaning and defaults as the sales invoice attachment endpoint.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" \
  -F "apikey=YOUR_API_KEY" \
  -F "creditnote_guid=CREDITNOTE_GUID" \
  -F "file=@credit-note.pdf"

Representativt vellykket svar

{
  "ok": true,
  "creditnote_guid": "…",
  "doc_id": "CN-2026-001",
  "filename": "credit-note.pdf",
  "size_bytes": 194221
}

Implementasjonsnotater

  • The endpoint verifies that the referenced document exists and is type 381.
  • A new attachment replaces the previous credit note attachment.
POST/xml/generate/ Generate XML and submit a credit note to Peppol
Autentisering: apikey or api_key is required.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.
creditnote_guidstringRequired for a credit note. Use the GUID returned by /creditnote/add/; invoice_guid or guid are accepted aliases.

Valgfritt

ParameterFormatDescription
networkstringStored operational network value.

Eksempelforespørsel

curl -X POST "https://api.peppox.com/xml/generate/" \
  -d "apikey=YOUR_API_KEY" \
  -d "creditnote_guid=CREDITNOTE_GUID"

Representativt vellykket svar

{
  "ok": true,
  "status": "XML_BUILT",
  "xml_path": "…",
  "document_type": "CREDIT_NOTE"
}

Implementasjonsnotater

  • Use only after the credit-note header and every credit-note line have been saved.
  • The credit-note header determines document type 381. Do not add a separate document-type parameter to this call.
  • Peppox calculates totals and VAT subtotals from the saved credit-note lines.
  • This is the final structured-credit-note call: it creates the UBL XML and, when it is valid, continues the configured Peppol submission. There is no extra structured /send endpoint.
04

Document retrieval and operations

GET/invoice/list/ List stored structured invoice records
Autentisering: apikey query/form value, or Authorization: Bearer API_KEY.Godkjente forespørselsformater: GET or POST; apikey can also be an Authorization: Bearer token

Påkrevd

ParameterFormatDescription
apikeystringAccount API key.

Valgfritt

ParameterFormatDescription
profilemini | customer | fullSelects a field preset.
fieldscomma-separated namesOverrides the preset with allowed fields.
invoice_guid, inv_id, status, networkstringsExact filters.
from, toYYYY-MM-DDIssue-date range.
limit, offsetintegerslimit defaults to 100 and is capped at 500.
pretty1Pretty-prints JSON.

Eksempelforespørsel

curl "https://api.peppox.com/invoice/list/?apikey=YOUR_API_KEY&profile=mini&status=XML_BUILT&limit=50"

Representativt vellykket svar

{
  "ok": true,
  "count": 1,
  "fields": ["invoice_guid", "inv_id", "status"],
  "filters": {"status": "XML_BUILT", "limit": 50},
  "data": [{"invoice_guid": "…", "inv_id": "INV-2026-0042", "status": "XML_BUILT"}]
}

Implementasjonsnotater

  • Use this for operational data saved by the structured flow.
  • For delivery-oriented sent status and richer filters, prefer /doc-sent/header/list/.
GET/doc-sent/header/list/ List sent document headers
Autentisering: supplier_id is the account API key associated with the documents.Godkjente forespørselsformater: GET, POST or JSON body

Påkrevd

ParameterFormatDescription
supplier_idstringAccount API key / supplier identifier.

Valgfritt

ParameterFormatDescription
page, per_pageintegerspage defaults to 1; per_page defaults to 300 and is capped at 300.
qstringKeyword search across indexed document fields.
date, date_from, date_toYYYY-MM-DDExact day or date range.
date_fieldfield nameissue_date, due_date, delivery_date, xml_built_at, sent_at, created_at, updated_at or status_from_peppol_date; sent_at by default.
status_from_peppol / statusstring or CSVOne or more Peppol statuses.
local_statusstring or CSVOne or more local invoice statuses.
include_raw, search_raw1 / trueInclude or search raw upstream fields.
sort_by, sort_dirfield / ASC|DESCsent_at and DESC by default.

Eksempelforespørsel

curl "https://api.peppox.com/doc-sent/header/list/?supplier_id=YOUR_API_KEY&page=1&per_page=50&status=accepted&date_from=2026-09-01"

Representativt vellykket svar

{
  "ok": true,
  "endpoint": "doc-sent/header/list",
  "pagination": {"page": 1, "per_page": 50, "total": 1, "has_next": false},
  "data": [{"invoice_guid": "…", "inv_id": "INV-2026-0042", "status_from_peppol": "accepted"}]
}

Implementasjonsnotater

  • CSV separators accepted for statuses: comma, semicolon or pipe.
  • Keep include_raw disabled unless you explicitly need the upstream raw payload.
GET/doc-sent/lines/list/ List lines of one sent document
Autentisering: supplier_id is the account API key associated with the invoice.Godkjente forespørselsformater: GET query string

Påkrevd

ParameterFormatDescription
supplier_idstringAccount API key / supplier identifier.
invoice_guidstringGUID returned by the sent-header list.

Valgfritt

ParameterFormatDescription
qstringSearch line fields.
page, per_pageintegerspage 1 and per_page 300 by default; maximum 300.

Eksempelforespørsel

curl "https://api.peppox.com/doc-sent/lines/list/?supplier_id=YOUR_API_KEY&invoice_guid=INVOICE_GUID&page=1&per_page=100"

Representativt vellykket svar

{
  "ok": true,
  "invoice": {"invoice_guid": "…", "inv_id": "INV-2026-0042"},
  "pagination": {"page": 1, "total": 2},
  "data": [{"line_id": "1", "quantity": "2", "price_amount": "49.50"}]
}

Implementasjonsnotater

  • The API verifies that the invoice belongs to the supplied supplier_id before returning lines.
GET/doc-received/header/list/ List received document headers
Autentisering: supplier_id is the account API key / Company supplier identifier.Godkjente forespørselsformater: GET, POST or JSON body

Påkrevd

ParameterFormatDescription
supplier_idstringAccount API key / supplier identifier.

Valgfritt

ParameterFormatDescription
page, per_pageintegerspage 1 and per_page 300 by default; maximum 300.
qstringKeyword search.
date, date_from, date_toYYYY-MM-DDExact day or range.
date_fieldfield nameapi_created_at by default; issue_date, due_date, tax_point_date, created_at and updated_at are supported.
import_status / statusstring or CSVOne or more import statuses.
document_type_code / type_codestring or CSVFilter by document type, for example 380 or 381.
include_raw, search_raw1 / trueInclude or search raw XML/parser fields.
sort_by, sort_dirfield / ASC|DESCapi_created_at and DESC by default.

Eksempelforespørsel

curl "https://api.peppox.com/doc-received/header/list/?supplier_id=YOUR_API_KEY&document_type_code=380&date_from=2026-09-01&per_page=50"

Representativt vellykket svar

{
  "ok": true,
  "endpoint": "doc-received/header/list",
  "pagination": {"page": 1, "per_page": 50, "total": 1},
  "data": [{"document_id": "…", "document_number": "SUP-1048", "supplier_name": "Supplier Ltd", "payable_amount": "1250.00"}]
}

Implementasjonsnotater

  • Use document_id from this result to retrieve the received document lines.
  • Keep raw XML and parser output disabled unless required.
GET/doc-received/lines/list/ List lines of one received document
Autentisering: supplier_id is the account API key / Company supplier identifier.Godkjente forespørselsformater: GET, POST or JSON body

Påkrevd

ParameterFormatDescription
supplier_idstringAccount API key / supplier identifier.
document_idstringflowin_document_id returned by /doc-received/header/list/.

Valgfritt

ParameterFormatDescription
qstringSearch line fields.
page, per_pageintegerspage 1 and per_page 300 by default; maximum 300.
include_raw, search_raw1 / trueInclude or search raw_line_xml and parser_json.
sort_by, sort_dirfield / ASC|DESCline_no and ASC by default.

Eksempelforespørsel

curl "https://api.peppox.com/doc-received/lines/list/?supplier_id=YOUR_API_KEY&document_id=DOCUMENT_ID&per_page=100"

Representativt vellykket svar

{
  "ok": true,
  "invoice": {"document_id": "…", "document_number": "SUP-1048"},
  "data": [{"line_id": "1", "item_name": "Service", "quantity": "1", "unit_price": "1250.00", "vat_rate": "21"}]
}

Implementasjonsnotater

  • The API verifies that the document belongs to supplier_id before returning lines.
05

Peppol network discovery

GET/ap/get/ Check a Peppol participant and discover endpoint information
Autentisering: No Peppox account key is required for this public lookup helper.Godkjente forespørselsformater: GET or POST; JSON or form data

Påkrevd

ParameterFormatDescription
schemestringParticipant identifier scheme, for example 0208.
valuestringParticipant identifier value.

Valgfritt

ParameterFormatDescription
smldigitprod or digittestdigitprod by default for the SMP query.
withEndpointsbooleantrue by default; set false to skip endpoint lookup.
prettyyes / true / 1Returns a simplified result.
onlynameWith pretty enabled, returns only the entity name.

Eksempelforespørsel

curl "https://api.peppox.com/ap/get/?scheme=0208&value=0123456789&sml=digitprod&pretty=1"

Representativt vellykket svar

{
  "name_entity": "Example Company",
  "serviceDescription": "…",
  "technicalContactUrl": "…"
}

Implementasjonsnotater

  • The full response contains both test and production existence results plus the EN16931 invoice endpoint lookup.
  • This endpoint checks discoverability; it does not create or send a document.
06 · Testing uten kode

Forstå hver forespørsel i dashboardet før du programmerer

Veiledede skjemaer i Peppox-dashboardet kaller API-ene for deg. Test ekte dokumenter, finn obligatoriske parametere og forstå JSON-svaret før ERP-et kobles til.

  1. 01Velg endepunkt og fyll ut feltene
  2. 02Kjør uten å skrive en testklient
  3. 03Se GUID-er, JSON og feil
  4. 04Valider flyten i integrasjonsmiljøet
  5. 05Gjenbruk fungerende kall i backend
  6. 06Overvåk sendte og mottatte dokumenter
Lagre disse identifikatorene

Integrasjonsstatusen er enkel

invoice_guid

Kobler hode, linjer, PDF og generert XML.

queue_guid

Kobler de fire PDF2Peppol-kallene under uttrekk.

dokument-GUID

Kobler sluttdokumentet til levering og avstemming.

Hvis en forespørsel feiler

400Kontroller manglende eller ugyldige felt.401Kontroller API-nøkkel og miljø.404Kontroller GUID fra forrige kall.429Senk hastigheten og prøv igjen med økende ventetid.500Logg forespørselen, prøv trygt igjen og kontakt Peppox hvis feilen fortsetter.
Peppox

Én tilkobling til Peppol-nettverket.

Send, motta og overvåk Peppol-dokumenter via én sikker API og ett tydelig dashbord.