Skip to content
EuroDMS Dev Guide

Commission & Payroll

Commission & Payroll

Section titled “Commission & Payroll”

Quellverzeichnis: modules/commission-payroll/

Provisionsabrechnung für Vertrieb/Service und Übergabe an die Lohnbuchhaltung.

Services

Section titled “Services”

Geschäftslogik des Moduls (src/services/):

  • CommissionRunNotCalculableError
  • CommissionRunNotFoundError
  • CommissionRunPeriodConflictError
  • CommissionRunService
  • ComponentNotFoundError
  • DatevExportNotApprovedError
  • DatevExportNotFoundError
  • DatevExportService
  • DisputeNotFoundError
  • EntryNotFoundError
  • PayPlanActiveConflictError
  • PayPlanNotActiveError
  • PayPlanNotFoundError
  • PayPlanNotModifiableError
  • PayPlanService
  • SpiffNotFoundError
  • SpiffNotModifiableError
  • SpiffService
  • TierNotFoundError

Repositories

Section titled “Repositories”

Datenzugriffs-Ports (src/repositories/):

  • CommissionRunRepository
  • InMemoryCommissionRunRepository
  • InMemoryPayPlanRepository
  • InMemorySpiffRepository
  • PayPlanRepository
  • SpiffRepository

Domain Events

Section titled “Domain Events”

Vom Modul emittierte Ereignisse (src/events.ts):

  • EventHandler
  • commissionAdjusted
  • commissionCalculated
  • commissionChargedback
  • commissionDisputeRaised
  • commissionDisputeResolved
  • commissionRunApproved
  • commissionRunClosed
  • commissionRunExported
  • commissionRunPaid
  • commissionRunStatusChanged
  • spiffAwarded
  • spiffStatusChanged

API-Endpunkte

Section titled “API-Endpunkte”

HTTP-Endpunkte unter api/routes/commission/ — Details in der API-Referenz.

Methode Pfad Datei
POST /v1/commission-exports/datev exports.ts
GET /v1/commission-runs commission-runs.ts
POST /v1/commission-runs commission-runs.ts
GET /v1/commission-runs/:runId commission-runs.ts
DELETE /v1/commission-runs/:runId commission-runs.ts
POST /v1/commission-runs/:runId/adjustments commission-runs.ts
POST /v1/commission-runs/:runId/approve commission-runs.ts
POST /v1/commission-runs/:runId/calculate commission-runs.ts
POST /v1/commission-runs/:runId/chargebacks commission-runs.ts
POST /v1/commission-runs/:runId/close commission-runs.ts
POST /v1/commission-runs/:runId/disputes commission-runs.ts
POST /v1/commission-runs/:runId/disputes/:disputeId/resolve commission-runs.ts
GET /v1/commission-runs/:runId/entries commission-runs.ts
POST /v1/commission-runs/:runId/export commission-runs.ts
POST /v1/commission-runs/:runId/mark-paid commission-runs.ts
POST /v1/commission-runs/:runId/reconfigure commission-runs.ts
POST /v1/commission-runs/:runId/revise commission-runs.ts
GET /v1/commissions/my commission-runs.ts
GET /v1/pay-plans pay-plans.ts
POST /v1/pay-plans pay-plans.ts
GET /v1/pay-plans/:planId pay-plans.ts
DELETE /v1/pay-plans/:planId pay-plans.ts
POST /v1/pay-plans/:planId/activate pay-plans.ts
POST /v1/pay-plans/:planId/archive pay-plans.ts
POST /v1/pay-plans/:planId/components pay-plans.ts
DELETE /v1/pay-plans/:planId/components/:componentId pay-plans.ts
POST /v1/pay-plans/:planId/tiers pay-plans.ts
DELETE /v1/pay-plans/:planId/tiers/:tierId pay-plans.ts
GET /v1/spiffs spiffs.ts
POST /v1/spiffs spiffs.ts
GET /v1/spiffs/:spiffId spiffs.ts
DELETE /v1/spiffs/:spiffId spiffs.ts
POST /v1/spiffs/:spiffId/activate spiffs.ts
POST /v1/spiffs/:spiffId/expire spiffs.ts
POST /v1/spiffs/:spiffId/pay-out spiffs.ts
GET /v1/spiffs/auto-apply spiffs.ts
POST /v1/spiffs/oem-import spiffs.ts

Public API

Section titled “Public API”

Über den Modul-Index (src/index.ts) exportierte Symbole — die einzige erlaubte Zugriffsart von außen:

  • // Adjustment enums AdjustmentType
  • // Aggregate Roots PayPlan
  • // CommissionRun enums CommissionRunStatus
  • // DTOs - CommissionRun CreateCommissionRunInput
  • // DTOs - Export DatevExportResult
  • // DTOs - PayPlan CreatePayPlanInput
  • // DTOs - Spiff CreateSpiffInput
  • // Dispute enums DisputeStatus
  • // IncentivePayout enums IncentivePayoutStatus
  • // PayPlan enums PayPlanStatus
  • // Reports SalespersonSummary
  • // Spiff enums SpiffStatus
  • // Value objects Condition
  • AddAdjustmentInput
  • AddComponentInput
  • AddTierInput
  • Adjustment
  • AdjustmentTypeValidationError
  • CommissionEntry
  • CommissionRun
  • CommissionRunNotCalculableError
  • CommissionRunNotFoundError
  • CommissionRunPeriodConflictError
  • CommissionRunRepository
  • CommissionRunService
  • CommissionRunTransitionError
  • CommissionTier
  • ComponentBreakdown
  • ComponentNotFoundError
  • DateRange
  • DateRangeValidationError
  • DatevExportNotApprovedError
  • DatevExportNotFoundError
  • DatevExportService
  • DealContribution
  • Dispute
  • DisputeNotFoundError
  • DisputeTransitionError
  • DocumentRef
  • DomainEvent
  • … und 89 weitere

Zurück zur Modul-Übersicht oder zur Startseite.