Qvalia

Qvalia Messaging Formats

JSON/XML or JSON to XML

Attachments to messages

SFTP-Integration

Invoice APIs

The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there's no "array" function for XML).

Use `limit` parameter to change the number of returned messages and combine it with `offset` to traverse down the list, e.g:
https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming?limit=10&offset=10

To get new messages only, use the `"Get incoming read invoices"` endpoint instead.


Get incoming invoices

Post incoming invoice

Get incoming read invoices

Post outgoing invoice

The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there's no "array" function for XML).

Use `limit` parameter to change the number of returned messages and combine it with `offset` to traverse down the list, e.g:
https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing?limit=10&offset=10


Get outgoing invoices

Post outgoing invoices as batch

Credit Note APIs

The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there's no "array" function for XML).

Use `limit` parameter to change the number of returned messages and combine it with `offset` to traverse down the list, e.g:
https://api-qa.qvalia.com/transaction/{accountRegNo}/creditNotes/incoming?limit=10&offset=10

To get new messages only, use the `"Get incoming read creditnotes"` endpoint instead.

Get incoming credit notes

Post incoming credit note

Get incoming read credit notes

Post outgoing credit note

Post outgoing credit notes as batch

Order APIs

The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there's no "array" function for XML).

Use `limit` parameter to change the number of returned messages and combine it with `offset` to traverse down the list, e.g:
https://api-qa.qvalia.com/transaction/{accountRegNo}/orders/incoming?limit=10&offset=10

To get new messages only, use the `"readOrders"` endpoint instead.


Get incoming orders

Post incoming order

Get incoming read orders

Post outgoing order

Post outgoing orders as batch

Order Response APIs

The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there's no "array" function for XML).

Use `limit` parameter to change the number of returned messages and combine it with `offset` to traverse down the list, e.g:
https://api-qa.qvalia.com/transaction/{accountRegNo}/orderResponses/incoming?limit=10&offset=10

To get new messages only, use the `"Get incoming read orderresponses"` endpoint instead.

Get incoming order responses

Post incoming order response

Get incoming read order responses

Post outgoing order response

Post outgoing order response as batch

Catalogue APIs

Get incoming catalogue

Post incoming catalogue

Get incoming read catalogues

Get outgoing catalogue

Post outgoing catalogue

Account functions

Invoice Functions

Sample Data

Qvalia Transactions API

Qvalia API

Access APIs and technical requirements and get connected in no time!

Our APIs and onboarding team ensures a swift integration into your systems and processes. Qvalia integrates with major ERPs and accounting software.

 request and response payloads. All message formats are based upon 

 and our JSON format is a representation of the XML called 

 Open group. We strive to use the REST standards for response codes and “verbs” (e.g. GET and POST).

The Qvalia API has two separate endpoints for our Production and a Test (Quality Assurance) environment.

 account prior to using (or testing) the API!

We use API keys for the Authentication of requests. You can get your API key from our Support team and you’ll get a separate key and URL for Production and Test environments. All requests are using HTTPS with a minimum of TLS 1.2

Some of our API's has the possibility to provide parameters for e.g. filtering. These parameters are sent as a 

 and the options are listed per endpoint under the technical API documentation.

We offer various error codes based upon the type of error, along with a descriptive error message (in JSON or XML). Like any other API codes in the range of 

 is a successful request while a status of 

 indicates an error that occurred because of the data sent or a parameter missing/in error. In the 

 range indicate an error with our server/service and you should contact the Qvalia Support if you ever would end up getting any 

You can always contact Qvalia Support through your Qvalia Sales representative or by using our Support e-mail (see your Qvalia Account for details).

We use Node.js inhouse, and JSON is our format of choice, however, as many ERP and Financial systems are using XML we have opted to add support for both formats in our API. You can freely swap between XML and JSON, just by using different headers:

Node.js sample code for calling the API for sending a JSON request could look like:

Qvalia Developer tools

Sample Invoice

<p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets">We follow a standard API REST-ish interface on our endpoints and try to adhere to the standard/common return codes and behaviors of any standard API.</p><p class="slate-p" placeholder="Type / for widgets">We are using the UBL standard messaging formats for our integrations through the API, <span style="color:rgb(166, 27, 0)" class="slate-color"><strong style="color:rgb(166, 27, 0)" class="slate-bold">but</strong></span> you should note that we only use a subset of UBL as specified by Peppol (<a href="https://peppol.eu" target="_blank">peppol.eu</a>)</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor">As many of Qvalia&apos;s services are compatible with </span></span><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor"><strong style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-bold">Peppol</strong></span></span><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor"> the data validation is also done using the Peppol standards. For example the Invoice endpoint strictly follows BIS Billing 3.0, </span></span><a href="https://docs.peppol.eu/poacc/billing/3.0/" target="_blank">https://docs.peppol.eu/poacc/billing/3.0/</a></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor">This means that, although the JSON format is based upon UBL JSON we only allow the subset stated from </span></span><a href="https://docs.peppol.eu/poacc/billing/3.0/" target="_blank">https://docs.peppol.eu/poacc/billing/3.0/</a><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor"> for the Invoice and CreditNote message types, see the “</span></span><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor"><em style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-italic">Syntax</em></span></span><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor">” section!</span></span></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-color"><span style="background-color:rgb(255, 248, 225);color:rgb(255, 195, 0)" class="slate-backgroundColor">For Order and OrderResponse you&apos;ll find the documentation at: </span></span><a href="https://docs.peppol.eu/poacc/upgrade-3/" target="_blank">https://docs.peppol.eu/poacc/upgrade-3/</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Authentication</h2><p class="slate-p" placeholder="Type / for widgets">We use API keys for the Authentication of requests. You can get your 
API key from our Support team and you’ll get a separate key and URL for 
Production and Test environments. All requests are using HTTPS with a 
minimum of TLS 1.2</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Each request made to the API will contain your <code class="slate-code">registration number</code>
 which is your account identifier for your Qvalia account. Your account 
identifier will be provided to you from the Support team during the 
onboarding process.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Your requests must use the registration number as e.g. <code class="slate-code">POST /{registration_number}/invoices/outgoing</code></p><h2 class="slate-h2">UBL JSON Representation standard</h2><p class="slate-p" placeholder="Type / for widgets">For the JSON representation of the format please refer to <a href="http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/UBL-2.1-JSON-v2.0.html" target="_blank">http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/UBL-2.1-JSON-v2.0.html</a></p><p class="slate-p" placeholder="Type / for widgets">UBL JSON samples and schemas can be found here: <a href="http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/cnd01/" target="_blank">http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/cnd01/</a></p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">UBL XML Representation standard</h2><p class="slate-p" placeholder="Type / for widgets">For the XML representation, <a href="https://docs.oasis-open.org/ubl/UBL-2.1.html" target="_blank">https://docs.oasis-open.org/ubl/UBL-2.1.html</a></p><p class="slate-p" placeholder="Type / for widgets">The UBL version 2.1 has been selected due to the many compliant standars with UBL 2.1, mainly the Peppol standard (<a href="https://peppol.eu" target="_blank">peppol.eu</a>).</p><p class="slate-p" placeholder="Type / for widgets">XML samples and XML schemas can be found here: <a href="http://docs.oasis-open.org/ubl/os-UBL-2.1/" target="_blank">http://docs.oasis-open.org/ubl/os-UBL-2.1/</a></p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Required</h2><p class="slate-p" placeholder="Type / for widgets">As the UBL JSON schema is fairly big, we only list the <code style="font-size:0.8125em" class="slate-code">required</code> attributes in the sample request and response data. You can browse the complete <code style="font-size:0.8125em" class="slate-code">JSON schema</code> viewing the <code style="font-size:0.8125em" class="slate-code">UBL-Invoice-2.1</code>.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Note the difference in objects below, only <code style="font-size:0.8125em" class="slate-code">IssueDate</code> is required, and thus <code style="font-size:0.8125em" class="slate-code">IssueTime</code> won&apos;t be listed in the sample request/responses:
</p><div style="text-align:center"><img src="blob:https://api.qvalia.io/afe3cc9a-aa22-4562-a4fd-edb5d3b76da1" alt=""/></div><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Attachments</h2><p class="slate-p" placeholder="Type / for widgets">Often our customers wants to add, or request, attached documents to their messages, e.g. their invoices.</p><p class="slate-p" placeholder="Type / for widgets">We support all the same attachments as Peppol does: <a href="https://docs.peppol.eu/poacc/billing/3.0/bis/#media-type" target="_blank">Peppol media types</a></p><p class="slate-p" placeholder="Type / for widgets">See more under  <a href="https://api.qvalia.io/docs/public-api/ZG9jOjI4NzIyMjYx-attachments-to-messages" target="_blank">Attachments to messages</a></p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">SFTP Integration</h2><p class="slate-p" placeholder="Type / for widgets">Qvalia is also offering integration through SFTP. If you have opted for the SFTP integration please read more here: <a href="https://api.qvalia.io/docs/public-api/ZG9jOjUwNDQ0NTQ2-sftp-integration" target="_blank">SFTP Integration</a></p><p class="slate-p" placeholder="Type / for widgets"></p></p><p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets"></p></p>

200 - OK

401 - Unauthorized

The requested resource does not exist. This can be either the URI, or query parameters.

404 - Not Found

The request cause some conflict, normally a duplicate

409 - Conflict

The posted data is invalid, in the wrong format or missing

422 - Unprocessable Entity

The API key doesnt have permissions to perform the request.

403 - Forbidden

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Often our customers wants to add, or request, attached documents to their messages, e.g. their invoices.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">We support all the same attachments as Peppol does: <a href="https://docs.peppol.eu/poacc/billing/3.0/bis/#media-type" target="_blank">Peppol media types</a></p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><th class="slate-th"><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">SUPPORTED FILE TYPES</p></th><th class="slate-th"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"></span></span></p></th></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><strong style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-bold">Documents</strong></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><em style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-italic">application/pdf</em></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><strong style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-bold">Images</strong></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><em style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-italic">image/png
image/jpeg</em></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><strong style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-bold">Text</strong></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><em style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-italic">text/csv</em></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><strong style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-bold">Spreadsheet</strong></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-backgroundColor"><em style="background-color:rgb(255, 255, 255);color:rgb(38, 38, 38);font-size:16px" class="slate-italic">application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.oasis.opendocument.spreadsheet</em></span></span></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2"><a href="https://api.qvalia.io/docs/public-api/ZG9jOjI4NzIyMjYx-attachments-to-messages#technical-details" target="_blank">Technical details</a></h2><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Any attachment has to be <code class="slate-code">base64</code> encoded and added under the <code class="slate-code">AdditionalDocumentReference</code> element; <a href="https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AdditionalDocumentReference/cac-Attachment/" target="_blank">https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AdditionalDocumentReference/cac-Attachment/</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">JSON</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-17-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">&quot;AdditionalDocumentReference&quot;:[{</div><div class="slate-code_line">  &quot;ID&quot;:[{&quot;_&quot;:&quot;InvocieSpecification01&quot;}],</div><div class="slate-code_line">  &quot;DocumentType&quot;:[{&quot;_&quot;:&quot;Specification&quot;}],</div><div class="slate-code_line">  &quot;Attachment&quot;:[{</div><div class="slate-code_line">    &quot;EmbeddedDocumentBinaryObject&quot;:[</div><div class="slate-code_line">      {</div><div class="slate-code_line">        &quot;_&quot;:&quot;UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi&quot;,</div><div class="slate-code_line">        &quot;mimeCode&quot;:&quot;application/pdf&quot;,</div><div class="slate-code_line">        &quot;filename&quot;:&quot;InvocieSpecification01.pdf&quot;</div><div class="slate-code_line">      }</div><div class="slate-code_line">    ]</div><div class="slate-code_line">  }]</div><div class="slate-code_line">}]</div></code></pre><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">xml</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-18-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-xml keep-markup drop-tokens"><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">&lt;cac:AdditionalDocumentReference&gt;</p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets">&lt;cbc:ID&gt;InvocieSpecification01&lt;/cbc:ID&gt;</p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"> &lt;cac:Attachment&gt;</p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets">    &lt;cbc:EmbeddedDocumentBinaryObject mimeCode=&quot;application/pdf&quot; filename=&quot;InvocieSpecification01.pdf&quot;&gt;UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi&lt;/cbc:EmbeddedDocumentBinaryObject&gt;</p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"> &lt;/cac:Attachment&gt;</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">&lt;/cac:AdditionalDocumentReference&gt;</p></code></pre><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The Qvalia SFTP integration handles all Peppol XML <a href="https://docs.peppol.eu/edelivery/codelists/" target="_blank">Document types</a> by default but we also support &quot;custom&quot; formats.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">&quot;Custom format&quot; means we can add a transformation for your required format both for outbound (sending) and inbound (receiving) documents. For example, if you use SAP IDoc we can transform incoming Peppol XML to SAP IDoc for you and you&apos;d pick up the ready-made SAP format from our SFTP. Likewise, if you are using outbound, you can upload your SAP IDoc and we will transform it for you.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The SFTP setup is done by our helpdesk, and you will require a Qvalia account prior to being able to test the SFTP integration.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Qvalia hosts an SFTP Server, and both sending and receiving is done through an SFTP client from your environment.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><h3 class="slate-h3"><a href="https://api.qvalia.io/docs/public-api/ZG9jOjUwNDQ0NTQ2-sftp-integration#sending-and-receiving" target="_blank">Sending and receiving</a></h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Any inbound (receiving) documents will be uniquely named according to a predefined format including, e.g., the document date and document number, and place in the root directory of your SFTP account.</p><p class="slate-p" placeholder="Type / for widgets">We recommend that you follow the common SFTP renaming standards for downloading received files to avoid downloading duplicates in case connection would be interrupted:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Connect to the SFTP server</div></li><li class="slate-li"><div style="position:relative">List files</div></li><li class="slate-li"><div style="position:relative">Start processing file list by:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Rename the first file in the list to <code class="slate-code">{original-filename}.downloading</code></div></li><li class="slate-li"><div style="position:relative">Start download of <code class="slate-code">{original-filename}.downloading</code></div></li><li class="slate-li"><div style="position:relative">Once download is completed, delete <code class="slate-code">{original-filename}.downloading</code> from SFTP Server</div></li><li class="slate-li"><div style="position:relative">Rename <code class="slate-code">{original-filename}.downloading</code> locally back to <code class="slate-code">{original-filename}</code></div></li></ul></li></ul><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Outbound (sending) documents will be uploaded by you to the sub-directory named <code class="slate-code">/send</code>. The <code class="slate-code">send</code> directory is created automatically for you when you opt for the outbound functionality from Qvalia.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><h3 class="slate-h3"><a href="https://api.qvalia.io/docs/public-api/ZG9jOjUwNDQ0NTQ2-sftp-integration#error-handling-and-processing" target="_blank">Error handling and processing</a></h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">When you upload your outbound documents and they should happen to be faulty in some way (e.g. invalid Peppol XML) the file uploaded will be renamed to <code class="slate-code">{original-filename}.error</code> and while the file is being inspected and processed by us it will be renamed as <code class="slate-code">{original-filename}.processing</code>.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Once the processing is completed the file will be moved, and again renamed, in a sub-directory called <code class="slate-code">processed</code>, meaning you will find your already processed files in <code class="slate-code">/send/processed/{original-filename}.processed</code>.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">When, and if, you remove (delete) the files form <code class="slate-code">/processed</code> is up to you but please note that some SFTP clients can&apos;t read too large file lists why we recommend emptying the <code class="slate-code">/processed</code> sub-directory at a set interval, depending on the number of files you send.</p><p class="slate-p" placeholder="Type / for widgets">

</p>

Invoice

Invoice Request Sample (POST)

<p class="slate-p" placeholder="Type / for widgets">APIs related to invoice handling</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

_declaration

Authorization

Content-Type

status

data

type

metadata

The request was unacceptable, often due to missing a required parameter.

400 - Bad request

The parameters were valid but the request failed.

402 - Request Failed

<p class="slate-p" placeholder="Type / for widgets">The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there&apos;s no &quot;array&quot; function for XML).</p><p class="slate-p" placeholder="Type / for widgets">Use <code class="slate-code">limit</code> parameter to change the number of returned messages and combine it with <code class="slate-code">offset</code> to traverse down the list, e.g:
<a href="https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming?limit=10&amp;offset=10" target="_blank">https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming?limit=10&amp;offset=10</a></p><p class="slate-p" placeholder="Type / for widgets">To get new messages only, use the <code class="slate-code">&quot;Get incoming read invoices&quot;</code> endpoint instead.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p" placeholder="Type / for widgets">The response, in JSON, will always include the three latest messages, per default.
Using XML you always only get one (as there&apos;s no &quot;array&quot; function for XML).</p><p class="slate-p" placeholder="Type / for widgets">Use <code class="slate-code">limit</code> parameter to change the number of returned messages and combine it with <code class="slate-code">offset</code> to traverse down the list, e.g:
<a href="https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing?limit=10&amp;offset=10" target="_blank">https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing?limit=10&amp;offset=10</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p>APIs related to credit note handing</p>

<p>APIs related to order response handing</p>

<p>Information about Catalogue Endpoints will soon be published in full</p>

<p></p><p>A collection of endpoints where Qvalia account information is gathered, such as Invoice status, and automation tasks, e.g. creating an outgoing Invoice from an incoming Order.</p><p></p><p></p><p></p>

As the request and response sample data are quite big, and scrolling through each sample on every endpoint would get quite tedious, we've opted to add sample data for the various messages here instead of in the actual Endpoint data.

Regardless if you are POST'in or GET'ing data the message structure of the messages will be the same. 

 section of the documentation, and under 

 all our transaction messages are bidirectional and can be transformed to/from JSON/XML.f