API-referens

List documents

A page of the company's documents. A page may hold fewer documents than asked for and still have a nextCursor; the listing ends when there is none.

Parametrar

Create a draft

Stores the document as a draft. A draft may have errors: they are listed in validation and stop it from being sent, not from being saved. Files given in attachments[].content are taken out of the document and kept beside it.

Innehåll i förfrågan

Get a document

Parametrar

Replace a draft

Replaces what a draft says. Its files stay as they are.

Parametrar

Innehåll i förfrågan

Delete a draft

Parametrar

Attach a file to a draft

The body is the file, at most 4 MB, and Content-Type its type: PDF, PNG, JPEG, CSV, XLSX or ODS. A larger file is uploaded in two steps.

Parametrar

Innehåll i förfrågan

Download an attachment

The file of the attachment with this index in the document's attachments. A file above 4 MB is answered with a redirect (303) to where it can be fetched.

Parametrar

Remove an attachment from a draft

Parametrar

Start uploading a large file

Answers with a URL to PUT the file to, with exactly the headers given and the size stated. Once it is there, finish the upload.

Parametrar

Innehåll i förfrågan

Finish uploading a large file

Attaches the uploaded file to the draft. What was uploaded is checked like any other file, and thrown away if refused.

Parametrar

Innehåll i förfrågan

Create a credit note for a sent invoice

Creates a draft credit note with the invoice's parties and lines, referring to the invoice. Its number is left to give.

Parametrar

Get a document in another format

The document written as cii (UN/CEFACT CII D16B in the EN 16931 profile, which Factur-X and ZUGFeRD take), xrechnung (the same with XRechnung 3.0's guideline, for German public buyers) or factur-x (a PDF/A-3 with the pages drawn and the CII inside, Factur-X 1.0 / ZUGFeRD 2 at the EN 16931 level). The amounts are the ones the UBL carries.

Parametrar

Mail a received document on

Mails a received document, now, to the addresses given or else to the company's forwarding addresses: the pages drawn as PDF, the XML, the files inside it, and what looked wrong. For sending it on again, or to someone else, after the fact; the forwarding the company has set up happens by itself when a document arrives. The timeline records it.

Parametrar

Innehåll i förfrågan

Get a document as PDF

The document drawn as pages to read. The pages are a view of the e-invoice; the XML is the original.

Parametrar

Make a failed document a draft again

Turns a document that is failed or invalid back into a draft, to be changed and sent again. What the failed send carried stays in the archive, and the timeline records it.

Parametrar

Answer a received document

Sends a Peppol Invoice Response to whoever sent the document: AB acknowledged, IP in process, UQ under query, CA conditionally accepted, RE rejected, AP accepted or PD paid. A query, a condition or a rejection must give a reasonCode (OPStatusReason: REF, LEG, REC, QUA, DEL, PRI, QTY, ITM, PAY, UNR, FIN, PPD, OTH). The document records what was said in response. A response about a document the company sent arrives the other way, as the document.response event.

Parametrar

Innehåll i förfrågan

Send a failed document again

Sends a document that is failed or invalid again, as it is, as a new message: the checks of a send are made again, and the answer is as for sending a draft. A document that is still not right to send is left a draft (the error says why), to be changed and sent. What the failed send carried stays in the archive.

Parametrar

Send a draft

Checks the draft against the Peppol rules and queues it for sending. The answer comes at once; the document then goes from queued to delivered, unconfirmed, invalid or failed, which a webhook tells of.

Parametrar

Get a document as UBL

The XML that was sent or received, or that a draft would be sent as. A document above 4 MB is answered with a redirect (303) to where it can be fetched.

Parametrar

Validate a stored document

Asks the Peppol rules about a stored document, without sending it. What they say is in findings.

Parametrar

Preview a document

Answers with what saving the document would show, its totals and its errors, without saving it or asking the Peppol rules.

Innehåll i förfrågan

Create a draft from a file

Stores a finished invoice or credit note, such as an export from a business system, as a draft. UBL (Peppol BIS Billing, XRechnung UBL and other EN 16931 UBL) is sent exactly as given. CII (XRechnung CII, ZUGFeRD and Factur-X XML), a Factur-X or ZUGFeRD PDF, and FatturaPA are read into the document model, become drafts like any written here, and are sent as Peppol BIS Billing; the answer's validation says what they lack, such as the receiver's Peppol ID.

Innehåll i förfrågan

List exports

The company's exports of the last seven days, newest first.

Export the archive

Writes the company's documents out as zip files, for it to keep: a folder per document with its XML as sent or received, what earlier failed sends of it carried, its pages as PDF when pdf is asked for, and its files, with index.csv and index.json listing every document and its timeline. Every document but drafts, unless narrowed by direction and issue date. The answer comes at once; the export is ready when its parts are written. A large archive comes in several parts. Exports are kept for seven days.

Innehåll i förfrågan

Get an export

Parametrar

Download a part of an export

The n'th zip file of a ready export, counting from 1; most often by a redirect to where it is kept.

Parametrar

List imports

Make drafts from a file

Makes drafts from a file sent as the body, of its own Content-Type: a spreadsheet of invoices (CSV or Excel; see the template at /tools/import-template/{format}), an invoice as pages (a PDF without an e-invoice inside, or a photo or scan, read by a model, each draft saying it is to be checked and what was unclear), or an e-invoice in any format the portal reads. The answer comes at once; the import is done when its drafts are made, with their ids in documents and what could not be read in problems, by row. A file over 5 MB is put to a link from /imports/uploads first and named here by upload.

Parametrar

Innehåll i förfrågan

Get an import

Parametrar

Get a link to put a large file to

For a file over 5 MB, up to 20 MB: put it to uploadUrl with the headers given, then make the drafts with POST /imports?upload={uploadId}.

Innehåll i förfrågan

Receive a test document

For a sandbox company: delivers the UBL in the body, or a sample invoice when the body is empty, as if it had arrived over Peppol.

Innehåll i förfrågan

Validate a document given as JSON

Answers with the document's field errors and totals and, if it has no field errors, what the Peppol rules say about it and the document as UBL. Nothing is stored or sent.

Innehåll i förfrågan

Validate a document given as a file

Answers with what the Peppol rules say about a UBL invoice or credit note, whoever it is from. A CII, Factur-X, ZUGFeRD or FatturaPA document is read into the document model first and judged as the Peppol BIS Billing it would be sent as. Nothing is stored or sent.

Innehåll i förfrågan

Search the Peppol directory

Parametrar

Look up a Peppol ID

Whether anything is registered under the ID, and what it receives.

Parametrar

Find a participant by VAT number

The Peppol IDs the VAT number may go by (the country's VAT scheme, and its register where the register number can be read off the VAT number) are tried in turn; participant is the first that is registered, or null, and tried lists them all.

Parametrar

List the parties waited for

The parties the company waits for on the Peppol network, found or not.

Wait for a party to join Peppol

Puts a watch on a Peppol ID. The network is asked daily; when the party is registered, the webhooks get a participant.registered event and email, if given, a mail. A party registered already is answered with 409 ALREADY_REGISTERED and the participant: there is nothing to wait for. Watching an ID watched already answers with the watch there is.

Innehåll i förfrågan

Get a watch

Parametrar

Stop waiting for a party

Parametrar

Ask the network about a watched party now

Asks the Peppol directory now instead of waiting for the daily sweep, and tells the company the same way if the party has appeared.

Parametrar

List webhooks

Create a webhook

Innehåll i förfrågan

Get a webhook

Parametrar

Replace a webhook

Parametrar

Innehåll i förfrågan

Delete a webhook

Parametrar

List a webhook's latest deliveries

Parametrar

Deliver a test event

Delivers a webhook.test event now and answers with how it went.

Parametrar

What was done to the company

Every change made to the company and its documents, keys, webhooks and settings, through the API or the web app, newest first: what was done, to what, by whom (a person, by their user id, or an API key, by its id), and from where. Reading is not recorded. nextCursor continues the list.

Parametrar

Add a company

Registers the company on the Peppol network, to send and to receive. Not for API keys.

Innehåll i förfrågan

List API keys

Not for API keys.

Parametrar

Create an API key

The key itself is in the answer, and nowhere after it. Not for API keys.

Parametrar

Innehåll i förfrågan

Revoke an API key

Parametrar

Get a company

Parametrar

Receive through the portal, or only send

With receive true the company is published on the Peppol network as a receiver of invoices, credit notes and Invoice Responses, and what is sent to it arrives here. With false it only sends, and is not found as a receiver: for a company that receives through another access point, or not at all. A company being set up at the access point answers 409 NOT_PROVISIONED.

Parametrar

Innehåll i förfrågan

Replace a company's settings

Parametrar

Innehåll i förfrågan

Where the company is in being verified

A company is on the Peppol network once the access point has verified that it controls the legal entity its identifier names: a register extract and an agreement signed by those who may bind it. Until then its Peppol ID waits (status PENDING_APPROVAL), and needed is true. A company in test mode is never verified, and needs not be.

Parametrar

Get a link to verify the company

A link to the access point's page where the company's own people upload its register extract and choose who signs the agreement. It works for 30 days, any number of times, and is ended by the next. 409 NOTHING_TO_VERIFY for a company in test mode or verified already.

Parametrar

Get the caller and its companies

Get usage

How many documents the company sent and received per day, week or month, over the last thirty days unless from and to say otherwise. Only periods with any are listed; day is the day, the Monday the week begins on, or the month as YYYY-MM.

Parametrar

List the account's keys

Not for API keys.

Create an account key

An account key acts as the person: it reaches every company of theirs under /v1/companies/{companyId}, may add companies, and may not make keys. The key itself is in the answer, and nowhere after it. Not for API keys.

Innehåll i förfrågan

Revoke an account key

Parametrar

What was done to the account

Changes to the account itself that are about no one company, such as its account keys, newest first. Each company's own are under its /audit.

Parametrar

Get the month against the plan

How many documents the account has sent this month, how many its plan includes, and, beyond them, the price of each or, on a plan with a cap, what is left. Plans and payment are the account's in the SaaS kit. For a company's key, the account that added the company.

Get usage for every company

How many documents each of the caller's companies sent and received, over the last thirty days unless from and to say otherwise.

Parametrar

Convert any e-invoice to another format

Reads a document in any of the formats and answers with it as Peppol BIS Billing 3.0 UBL, or as what to asks for: cii (EN 16931 profile), xrechnung (XRechnung 3.0 CII) or factur-x (PDF/A-3 with the CII inside). UBL asked for as UBL is answered as it is.

Parametrar

Innehåll i förfrågan

Check an IBAN

Whether the IBAN's length and check digits are right. Spaces are allowed.

Parametrar

Check an identifier

Whether the value is a valid identifier under the scheme: a GLN under 0088, a Swedish organisation number under 0007, a Norwegian under 0192, and so on. Schemes without a known form are answered valid.

Parametrar

The spreadsheet template for invoices

The spreadsheet /imports reads, as csv or xlsx: one row a line, the invoice's own columns on its first row, with two example invoices. The workbook's second sheet says what each column is for. Column names in Swedish are read too.

Parametrar

Draw any e-invoice as PDF

Reads a document in any of the formats and draws it as pages to read.

Parametrar

Innehåll i förfrågan

Total up an invoice being filled in

Takes a document as JSON, as the portal's model has it, and answers with its totals and what is wrong with it as an e-invoice. For a form to show while it is filled in; nothing is stored.

Innehåll i förfrågan

Read any e-invoice for showing

Reads a document in any of the formats and answers with its content as the portal's document model, its totals and its attachments by name, as a document in the portal is answered. For drawing it; nothing is stored.

Innehåll i förfrågan

Validate any e-invoice

Reads an invoice or credit note as UBL, CII (XRechnung, ZUGFeRD, Factur-X), a Factur-X or ZUGFeRD PDF, or FatturaPA, and answers with what is wrong with it: its fields, and the Peppol rules where it has no field errors and is at most 512 kB.

Innehåll i förfrågan

Check an EU VAT number with VIES

Asks the European Commission's VIES whether the number is registered, and for whom where the country says.

Parametrar

Write an invoice without an account

Takes a document as JSON and answers with it as to says: ubl (Peppol BIS Billing 3.0, the default), cii, xrechnung or factur-x, which it must be valid to be (else 422 with the errors), or pdf, pages to read alone, which it may be whatever it says. Nothing is stored or sent.

Parametrar

Innehåll i förfrågan

Get the code lists

The code lists and reference data a client needs to offer the choices a document has: the same data documents are validated against.