Skip to content
Last updated

Seqino PDP API - Introduction

image

Welcome to the Seqino PDP API documentation. This API provides a modern and simplified interface to France's e-Invoicing services, giving you the power of a Platform de Dématérialisation Partenaire (PDP) without the burden of managing one.

For any question, ask on the Support page.

Core Concepts

Understanding the relationship between Sponsors, Clients, and Mandates is essential to working with the Seqino PDP API.

PPF
𝗠𝗮𝗻𝗱𝗮𝘁𝗲𝘀
𝗖𝗹𝗶𝗲𝗻𝘁𝘀
𝗦𝗽𝗼𝗻𝘀𝗼𝗿𝘀
offers grey-label API to
offers white-label API to
manages customers
grants permission via
authorizes access to
Directory
eInvoicing
eReporting
Mandate A
Mandate B
Mandate C
Mandate D
Client A
Company 1
Client B
Company 2 - Service X
Client C
Company 2 - Service Y
Seqino

Key Entities

🏢 The Sponsor

  • Who: A Client of Seqino that signed up for the grey-label or white-label API. Examples include ERPs, Banks, Accounting Platforms, ODs.
  • Role: Provides PDP services to their customers using Seqino APIs.
  • Responsibility: Gather mandates, integrate Seqino's API. Manage invoicing operations on behalf of the Clients.
  • Creation process: Contract between Sponsor and Seqino.

👥 The Clients

  • Who: A company or a department that uses the Sponsor's software/service (external to Seqino) for electronic invoicing and other services.
  • Role: Create, send, receive, pay invoices.
  • Responsibility:
    • The client will need to sign a mandate or delegate its consent to the PDP Sponsor.
    • 🤍 White label: the client designates the Sponsor as its PDP.
    • 🖤 Grey label: the client designates Seqino as its PDP.
  • Identifier: X-PDP-Client-Id header (required for most operations). Unique identifier.
  • Creation process: Through the Sponsor dashboard or Onboarding API.

📋 Mandate

  • What:
    • A Mandate allows the Client to grant the Sponsor the right to manage PDP operation on their behalf, specifically receiving invoices and managing their lifecycle.
    • The scope of a mandate reflects the scope of a PPF directory entry (Ligne d'annuaire). The following types of scopes are allowed:
      • SIREN
      • SIREN + suffix (Simple flat way of separating multiple departments without using SIRET)
      • SIREN + SIRET
      • SIREN + SIRET + routing_code (code routage)
  • Purpose: Materializes the relationship between a PDP (reception PDP) and a business entity.
  • Creation process: Through the Sponsor dashboard or Onboarding API.

API Architecture

Headers & Authentication

X-PDP-Client-Id: client-acme-corp        # Required for client operations

Endpoint Categories

CategoryPurposeRequires Client ID
ClientsManage clients and onboarding
SettingsConfigure client preferences
UsageGather API usage per client and invoice accordingly
MandatesManage legal entities and PPF directory entries
DraftsCreate and validate invoice drafts
InvoicingSend and receive electronic invoices
ReportingSend e-reporting information
LifecyclePolls or subscribes to lifecycle events

Typical Workflow

  1. 🔗 Onboarding: Create onboarding link for new client
  2. 📋 Mandate Creation: Client grants permissions via signed mandate
  3. 📘 Directory Setup: Register company routing information
  4. 📄 Invoice Processing: Send/receive electronic invoices
  5. 📊 Monitoring: Track usage and generate reports or invoices for the sponsor's clients

Getting Started

  1. Obtain Credentials: Get your X-PDP-Sponsor-Id from Seqino
  2. Client Onboarding: Use onboarding endpoints to register new clients
  3. Directory Management: Set up company routing information
  4. Start Invoicing: Begin sending and receiving electronic invoices
 
Next page