Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qargo Use case / E-invoicing API

Required api role: not applicablePurpose: This interface allows an external party to send e-invoices in a structured format.A [webhook](/docs/use-case-e-invoicing/e-invoicing-webhook) can be used to send e-invoices to Qargo. The e-invoice can either be a **purchase invoice** or a **purchase credit note**.### Supported formats| Format | Content-Type | Notes ||--------|-------------|-------|| JSON | `application/json` | Qargo's own purchase invoice/credit note schema || XML (UBL) | `application/xml` | Peppol-compliant UBL documents || Multipart | `multipart/form-data` | JSON invoice data + supporting document files (PDF, XML, etc.) |### AttachmentsAttachments (e.g. invoice PDF, CMR, proof of delivery) can be included in two ways:- **In JSON payloads**: Use the `attachments` array, where each item contains a `document` object with `base64`, `content_type`, `document_type`, and `filename` fields.- **In multipart uploads**: Send the JSON invoice data as the first part, followed by file attachments as additional parts.See the [e-invoicing webhook endpoint](/docs/use-case-e-invoicing/e-invoicing-webhook) for detailed examples of all formats and attachment handling.

Qargo Use case / E-invoicing API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Use case / E-invoicing. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 1 operation across 1 path, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against a single base URL, https://api.qargo.com.

1 operations 1 paths 16 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.qargo.com
Authentication
OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 2

Qargo Use case / E-invoicing API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow. It accepts HTTP basic authentication (BasicAuthWebhookCredentials).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Use case / E-invoicing 1

Required api role: not applicable Purpose: This interface allows an external party to send e-invoices in a structured format. A [webhook](/docs/use-case-e-invoicing/e-invoicing-we…

POST
/v1/webhook/e-invoicing
Send E-Invoices
e-invoicing-webhook body → 200400401403422429500503

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Location (15 properties), PurchaseEInvoiceInput (14 properties), PurchaseECreditNoteInput (13 properties), EInvoiceLineItem (6 properties). Each schema is shown below with its type and property counts.

api__accounting__models__invoice__TaxRate
object
5 properties
api__order__models__charge__AccountInput
object
1 property 1 required
ValidationError
object
3 properties 3 required
PurchaseEInvoiceInput
object
14 properties 10 required
HTTPValidationError
object
1 property
EInvoiceAttachment
object
1 property 1 required
ExchangeRate
object
3 properties 2 required
EInvoiceLineItem
object
6 properties 2 required
EInvoiceDocumentAttachment
object
4 properties 4 required
Location
object
15 properties
ValidationErrorResponse
object
2 properties 2 required
TaxRateType
string
EInvoiceDocumentType
string
EInvoiceCompanyInput
object
4 properties 1 required
PurchaseECreditNoteInput
object
13 properties 9 required
ValidationErrorDetail
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-use-case-e-invoicing-api-openapi.yml Raw ↑

Other APIs Qargo publishes across the network.

Qargo Subcontractor API
Qargo Customer API
Qargo API / Accounting API
Qargo API / Authentication API
Qargo API / Company API
Qargo API / Document API
Qargo API / Order API
Qargo API / Resource API
Qargo API / Task API
Qargo API / Trip API
Qargo System API
Qargo Use case / Accounting API