⚙️Services

Docs-Dispatcher provides 7 core services for document generation and multi-channel dispatch. This guide explains what each service does, which providers are supported, and common use cases.

All Services at a Glance

Service	Endpoint	Providers	Purpose
Invoicing	/api/invoicing	4	Generate and send invoices via accounting platforms
eSign	/api/esign	3	Electronic signature workflows
Postal	/api/postal	1	Physical mail dispatch (print and post)
SMS	/api/sms	4	SMS notifications
Email	/api/email	SMTP	Email dispatch
File	/api/file	Internal	Document generation only (no dispatch)
Upload	/api/upload	Internal	File upload and storage

Invoicing

Generate invoices, quotes, credit notes, and e-invoices through external accounting platforms.

What It Does

• Generates invoice documents from templates

• Creates invoice records in accounting systems

• Supports multiple document types (invoice, quote, credit note)

• Handles e-invoicing compliance (France)

Supported Providers (4)

Provider	providerName	Document Types	Webhooks
iPaidThat	ipaidthat	INVOICE, E_INVOICE, QUOTE, CREDIT	No
PennyLane	pennylane	INVOICE, E_INVOICE, QUOTE, CREDIT	No
Qonto	qonto	INVOICE, E_INVOICE, QUOTE, CREDIT	No
SuperPDP	superpdp	INVOICE, E_INVOICE, QUOTE, CREDIT	No

Document Types

• INVOICE - Standard invoice

• E_INVOICE - Electronic invoice (France, compliant with Chorus Pro)

• QUOTE - Quote/Devis/Estimate

• CREDIT - Credit note/Avoir

Common Use Cases

1. Automated Billing - Generate and send invoices after order completion

2. Quote Generation - Create quotes from CRM data

3. Credit Notes - Issue refunds and adjustments

4. E-Invoicing Compliance - Government-compliant electronic invoicing

Example Request

curl -X POST https://api.docs-dispatcher.io/api/invoicing \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "providerName": "qonto",
    "documentType": "INVOICE",
    "template": {
      "id": 123,
      "data": {
        "invoiceNumber": "INV-2026-001",
        "date": "2026-02-13",
        "customer": {
          "name": "Acme Corp",
          "email": "[email protected]"
        },
        "items": [...],
        "total": 1800.00
      }
    }
  }'

Response

{
  "success": true,
  "dispatchId": "disp_inv_abc123",
  "providerResponse": {
    "invoiceId": "qonto_inv_789",
    "status": "sent",
    "url": "https://qonto.com/invoices/789"
  },
  "generatedDocument": {
    "url": "https://storage.docs-dispatcher.io/invoices/INV-2026-001.pdf",
    "size": 245678
  }
}

eSign

Send documents for electronic signature through certified providers.

What It Does

• Uploads documents for signature

• Creates signature workflows with multiple signers

• Tracks signature status

• Provides legal compliance (eIDAS, etc.)

Supported Providers (3)

Provider	providerName	Webhooks	Compliance
Signaturit	signaturit	Yes	eIDAS, EU qualified
Universign	universign	Yes	eIDAS, EU qualified
Yousign	yousign	No	eIDAS, EU qualified

Signature Modes

• Simple - Email-based signature (no authentication)

• Advanced - SMS verification

• Qualified - Certified identity verification (eIDAS compliant)

Common Use Cases

1. Contract Signing - Employment contracts, NDAs, agreements

2. Order Confirmations - Customer order acceptance

3. Legal Documents - Deeds, powers of attorney

4. Multi-Party Agreements - Multiple signers with sequential or parallel workflows

Example Request

curl -X POST https://api.docs-dispatcher.io/api/esign \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "providerName": "universign",
    "template": {
      "id": 456,
      "data": {
        "contractTitle": "Employment Agreement",
        "employeeName": "John Doe"
      }
    },
    "signers": [
      {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "order": 1
      },
      {
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Smith",
        "order": 2
      }
    ],
  }'

Response

{
  "success": true,
  "dispatchId": "disp_esign_def456",
  "providerResponse": {
    "transactionId": "univ_trans_xyz789",
    "status": "pending",
    "signatureUrls": [
      {
        "signer": "[email protected]",
        "url": "https://universign.com/sign/abc123"
      }
    ]
  }
}

Webhook Events

When signature status changes:

{
  "event": "signature_completed",
  "transactionId": "univ_trans_xyz789",
  "status": "signed",
  "signedBy": [
    {"email": "[email protected]", "signedAt": "2026-02-13T10:30:00Z"},
    {"email": "[email protected]", "signedAt": "2026-02-13T14:15:00Z"}
  ],
  "signedDocumentUrl": "https://universign.com/download/signed_abc123.pdf"
}

Postal

Send physical mail (letters, invoices, contracts) via print-and-post providers.

What It Does

• Generates print-ready documents

• Prints and mails physical letters

• Handles envelopes, postage, tracking

• International shipping support

Supported Providers (1)

Provider	providerName	Webhooks	Coverage
MySendingBox	mysendingbox	Yes	France, Europe, International

Mail Types

• Simple Letter - Standard mail

• Registered - Tracked delivery with signature

• International - Cross-border shipping

Common Use Cases

1. Invoice Mailing - Physical invoices for non-digital customers

2. Legal Notices - Registered mail for legal compliance

3. Marketing - Promotional letters and brochures

4. Government Correspondence - Official documents requiring physical delivery

Example Request

curl -X POST https://api.docs-dispatcher.io/api/postal \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "providerName": "mysendingbox",
    "mailType": "REGISTERED",
    "template": {
      "id": 789,
      "data": {
        "recipientName": "John Doe",
        "documentTitle": "Contract Amendment"
      }
    },
    "recipient": {
      "name": "John Doe",
      "company": "Acme Corp",
      "address": "123 Main St",
      "city": "Paris",
      "postalCode": "75001",
      "country": "FR"
    },
  }'

Response

{
  "success": true,
  "dispatchId": "disp_postal_ghi789",
  "providerResponse": {
    "mailId": "msb_mail_456xyz",
    "status": "queued",
    "trackingNumber": "FR123456789",
    "estimatedDelivery": "2026-02-20"
  }
}

Webhook Events

Tracking updates:

{
  "event": "mail_delivered",
  "mailId": "msb_mail_456xyz",
  "trackingNumber": "FR123456789",
  "status": "delivered",
  "deliveredAt": "2026-02-20T14:30:00Z",
  "signedBy": "J. Doe"
}

SMS

Send SMS notifications via multiple providers.

What It Does

• Sends text messages to mobile phones

• Supports international numbers

• Delivery tracking

• Sender ID customization

Supported Providers (4)

Provider	providerName	Webhooks	Coverage
Brevo	brevo	No	International
OVH	ovh	No	International
SMS Factor	sms_factor	No	International
SMS Magic	sms_magic	No	International

Message Types

• Transactional - Order confirmations, OTPs, alerts

• Marketing - Promotional messages (opt-in required)

Common Use Cases

1. Order Notifications - Shipping updates, delivery alerts

2. Appointment Reminders - Healthcare, services

3. 2FA/OTP - Two-factor authentication codes

4. Payment Alerts - Payment confirmations, invoices due

5. Emergency Alerts - Critical system notifications

Example Request

curl -X POST https://api.docs-dispatcher.io/api/sms \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "providerName": "brevo",
    "phoneNumber": "[phone]",
    "message": "Your order #1234 has been shipped. Track: https://track.example.com/1234",
    "sender": "Acme"
  }'

Response

{
  "success": true,
  "dispatchId": "disp_sms_jkl012",
  "providerResponse": {
    "messageId": "brevo_msg_abc123",
    "status": "sent",
    "creditsUsed": 1
  }
}

Limits

• Message length: 160 characters (standard), 1530 characters (concatenated)

• Rate limits: Vary by provider (typically 100-1000/minute)

• International: Check provider for country support

Email

Send emails via SMTP with attachment support.

What It Does

• Sends HTML/plain text emails

• Supports attachments (generated documents)

• CC/BCC recipients

• Custom headers

Configuration

Email uses SMTP configuration (no external provider):

{
  "service": "email",
  "config": {
    "smtpHost": "smtp.example.com",
    "smtpPort": 587,
    "smtpUser": "[email protected]",
    "smtpPassword": "secure-password",
    "smtpSecure": true,
    "fromEmail": "[email protected]",
    "fromName": "Acme Corp"
  }
}

Common Use Cases

1. Invoice Delivery - Send generated invoices via email

2. Contract Distribution - Email signed documents

3. Reports - Automated report distribution

4. Notifications - System alerts, confirmations

Example Request

curl -X POST https://api.docs-dispatcher.io/api/email \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "[email protected]",
    "subject": "Your Invoice INV-2026-001",
    "body": "<h1>Thank you for your purchase</h1><p>Please find attached your invoice.</p>",
    "template": {
      "id": 123,
      "data": {...}
    },
    "attachGenerated": true
  }'

Response

{
  "success": true,
  "dispatchId": "disp_email_mno345",
  "emailSent": {
    "messageId": "smtp_msg_xyz789",
    "to": ["[email protected]"],
    "attachments": ["INV-2026-001.pdf"]
  }
}

File

Generate documents without external dispatch (pure document generation).

What It Does

• Renders templates to PDF, DOCX, XLSX

• No external provider calls

• Returns document URL for download

• Supports all printer engines

Printer Engines

Engine	Purpose	Output
Mustache	HTML templates → PDF	PDF
Twig2	HTML templates → PDF	PDF
Gotenberg	HTML/Office → PDF conversion	PDF
Docx	DOCX templating	DOCX
Xlsx	Excel templating	XLSX
Poppler	PDF → Images	PNG, JPG

Common Use Cases

1. Document Preview - Generate without sending

2. Download Links - Create documents for user download

3. Archive - Generate for storage only

4. Multi-Step Workflows - Generate first, dispatch later

Example Request

curl -X POST https://api.docs-dispatcher.io/api/file \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "template": {
      "id": 123,
      "data": {
        "title": "Annual Report 2025",
        "content": "..."
      }
    },
    "outputFormat": "PDF"
  }'

Response

{
  "success": true,
  "dispatchId": "disp_file_pqr678",
  "generatedDocument": {
    "url": "https://storage.docs-dispatcher.io/files/annual-report-2025.pdf",
    "size": 1234567,
    "contentType": "application/pdf",
    "expiresAt": "2026-02-20T12:00:00Z"
  }
}

Upload

Upload and store files (images, PDFs, documents).

What It Does

• Accepts file uploads via multipart/form-data

• Stores files in cloud storage

• Returns permanent URLs

• Supports file validation (size, type)

Supported File Types

• Documents: PDF, DOCX, XLSX, TXT

• Images: JPG, PNG, GIF, SVG

• Archives: ZIP, TAR

Common Use Cases

1. Attachment Storage - Store files referenced in other services

2. User Uploads - Accept customer documents

3. Media Library - Manage company assets

4. Backup - Archive generated documents

Example Request

curl -X POST https://api.docs-dispatcher.io/api/upload \
  -H "Authorization: Bearer $JWT" \
  -F "file=@/path/to/document.pdf" \
  -F "metadata={\"category\":\"invoices\",\"year\":2026}"

Response

{
  "success": true,
  "dispatchId": "disp_upload_stu901",
  "uploadedFile": {
    "url": "https://storage.docs-dispatcher.io/uploads/document-abc123.pdf",
    "size": 245678,
    "contentType": "application/pdf",
    "filename": "document.pdf",
    "metadata": {
      "category": "invoices",
      "year": 2026
    }
  }
}

Service Composition

Services can be chained together in a single request using composable endpoints.

Composition Pattern

/api/{service1}/{service2}/{service3}

Common Compositions

1. Invoice + Email

Generate invoice and email it:

POST /api/invoicing/email

{
  "providerName": "qonto",
  "documentType": "INVOICE",
  "template": {...},
  "email": {
    "to": "[email protected]",
    "subject": "Your Invoice"
  }
}

2. Invoice + Email + Upload

Generate, email, and archive:

POST /api/invoicing/email/upload

3. eSign + Email

Generate document, send for signature, email when signed:

POST /api/esign/email

Execution Order

Services execute sequentially:

1. First service generates document

2. Second service uses generated document

3. Third service uses result from second

If any service fails, the chain stops and returns error.

Provider Capabilities Matrix

Quick reference for which providers support which features:

Invoicing

Provider	E-Invoice	Webhooks	Sandbox
iPaidThat	✅	❌	✅
PennyLane	✅	❌	✅
Qonto	✅	❌	✅
SuperPDP	✅	❌	✅

eSign

Provider	Qualified Signature	Webhooks	Multi-Signer
Signaturit	✅	✅	✅
Universign	✅	✅	✅
Yousign	✅	❌	✅

SMS

Provider	International	Sender ID	Delivery Receipt
Brevo	✅	✅	✅
OVH	✅	✅	✅
SMS Factor	✅	✅	✅
SMS Magic	✅	✅	✅

Choosing the Right Service

Decision Tree

Need to generate a document?
├─ Yes
│  ├─ Send to accounting system? → Invoicing
│  ├─ Need signature? → eSign
│  ├─ Physical mail? → Postal
│  ├─ Email it? → Email
│  ├─ SMS notification? → SMS
│  └─ Just generate? → File
└─ No
   └─ Upload existing file? → Upload

Multi-Service Scenarios

Scenario	Services	Endpoint
Invoice customer by email	Invoicing + Email	/api/invoicing/email
Contract for signature	File + eSign	/api/file/esign
Invoice by postal mail	Invoicing + Postal	/api/invoicing/postal
Report via email with archive	File + Email + Upload	/api/file/email/upload

Code Examples

Example 1: Invoice with Qonto

// Node.js
const response = await fetch('https://api.docs-dispatcher.io/api/invoicing', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${jwtToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    providerName: 'qonto',
    documentType: 'INVOICE',
    template: {
      id: 123,
      data: {
        invoiceNumber: 'INV-2026-001',
        customer: {...},
        items: [...],
        total: 1800.00
      }
    }
  })
});

// PHP
$client = new \GuzzleHttp\Client();
$response = $client->post('https://api.docs-dispatcher.io/api/invoicing', [
    'headers' => [
        'Authorization' => 'Bearer ' . $jwtToken,
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'providerName' => 'qonto',
        'documentType' => 'INVOICE',
        'template' => [
            'id' => 123,
            'data' => [...]
        ]
    ]
]);

Example 2: eSign with Universign

// Java
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.docs-dispatcher.io/api/esign"))
    .header("Authorization", "Bearer " + jwtToken)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(
        "{\"providerName\":\"universign\"," +
        "\"template\":{\"id\":456,\"data\":{...}}," +
        "\"signers\":[...]}"
    ))
    .build();

HttpResponse<String> response = client.send(
    request,
    HttpResponse.BodyHandlers.ofString()
);

Example 3: SMS with Brevo

# curl
curl -X POST https://api.docs-dispatcher.io/api/sms \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "providerName": "brevo",
    "phoneNumber": "[phone]",
    "message": "Your order has shipped!",
    "sender": "Acme"
  }'

Related Documentation

• Provider Configurations - How to configure providers

• Request Model - Understanding request structure

• Sync vs Async - Choose execution mode

• Validation - Test before dispatch

Summary

Docs-Dispatcher provides 7 services with 12+ external providers:

1. Invoicing - Accounting platform integration (4 providers)

2. eSign - Electronic signatures (3 providers)

3. Postal - Physical mail (1 provider)

4. SMS - Text messaging (4 providers)

5. Email - SMTP dispatch (built-in)

6. File - Document generation (internal)

7. Upload - File storage (internal)

Each service can be used standalone or composed with others for powerful workflows. Choose providers based on your region, compliance needs, and feature requirements.