Client Management

The Client Management API is specifically designed for EPR agencies to efficiently manage their clients and their associated credentials across multiple countries and compliance schemes. This module provides comprehensive tools for client lifecycle management, credential handling, and bulk operations.

Overview

EPR agencies handle multiple clients who need to comply with various regulations across different countries. Each client may require different login credentials for different Producer Responsibility Organizations (PROs), waste streams, and countries. This API enables agencies to centralize and manage all this information in one place.

Key Capabilities

Client Management

The API allows you to manage your client portfolio with full CRUD operations:

• List Clients: Retrieve a paginated list of all clients with advanced filtering capabilities. You can filter by country, report type, PRO, status, and search by name or company name.
• Get Client Details: Fetch detailed information about a specific client, including their status, aliases, notes, and organizational information.
• Create Clients: Add new clients to your portfolio.
• Update Clients: Modify client information as their details change over time.
• Delete Clients: Remove clients from your system when they are no longer active.

Example Use Cases:

• Search for all clients in Germany that need WEEE reporting
• Filter clients by specific PROs like "Stichting Open"
• Find clients with missing credentials for a particular country

Credential Management

Each client requires specific login credentials for different compliance portals. The API provides comprehensive credential management:

• Search Credentials: Find credentials for a client with optional filtering to show missing credentials.
• Get Credentials by Country: Retrieve all credentials for a client in a specific country.
• Create Credentials: Add new login credentials for a client in a specific country and compliance scheme.
• Update Credentials: Modify existing credentials when passwords change or details need updating.
• Delete Credentials: Remove credentials that are no longer needed.

Example Use Cases:

• Store login credentials for a client's WEEE portal in France
• Update credentials when a client changes their password
• Identify which clients are missing credentials for a specific country
• Manage credentials for multiple report types (WEEE, Batteries, Packaging) per client

Client Aliases

Clients may be known by different names in different countries or contexts. The alias system allows you to:

• Add Aliases: Associate alternative names with a client, optionally scoped to specific countries.
• Remove Aliases: Delete aliases that are no longer relevant.
• Local Company Names: Set and retrieve country-specific company names for clients.

Example Use Cases:

• A client "ABC Corp" might be known as "ABC Corporation" in the UK and "ABC GmbH" in Germany
• Handle legal entity name variations across different jurisdictions

Collective Accounts

EPR agencies can create collective accounts for specific PROs that can be used by multiple clients. This centralized approach simplifies credential management:

• List Collective Accounts: Retrieve all collective accounts created by your organization with filtering by country and PRO.
• Centralized Credential Management: When credentials for a collective account change, update them once and all clients using that account automatically have the correct credentials.

How It Works:

1. Create a collective account for a specific PRO (e.g., "Stiftung EAR" for WEEE in Germany)
2. Associate multiple clients with this collective account
3. Store credentials once in the collective account
4. When credentials change, update the collective account once and all associated clients inherit the updated credentials

Example Use Cases:

• An EPR agency creates a collective account for "Stichting Open" in the Netherlands
• 50 clients are associated with this collective account
• When the password changes, update it once in the collective account
• All 50 clients automatically use the new credentials for their reporting
• Efficiently manage credentials for many clients using the same PRO

Statistics and Reporting

Get insights into your client portfolio:

• Client Statistics: Retrieve aggregated statistics about your clients, including counts by country, report type, and status.
• Report Types: Fetch a list of report types and PRO for which we currently support the automatic submission

Example Use Cases:

• Dashboard showing total number of clients per country
• Identify which report types are most common in your portfolio
• Track client status distribution

Bulk Operations

For agencies managing large numbers of clients, bulk operations provide efficiency:

• Bulk Upload Preview: Upload a CSV file with client data and preview the changes before applying them.
• Bulk Upload Execute: Apply the bulk upload after reviewing the preview.

Example Use Cases:

• Import hundreds of clients from a spreadsheet
• Migrate client data from another system
• Update multiple clients at once

Data Model

Client

A client represents a company or organization that requires EPR compliance management. Each client has:

• Basic information (name, status, notes)
• Organizational associations, if they are a user of our software
• Aliases for different countries/contexts
• A collection of credentials

Client Credentials

Credentials represent login information for specific compliance portals. Each credential is associated with:

• A client
• A country
• A report type (wastestream) - e.g., WEEE, Batteries, Packaging
• A PRO (scheme) - the Producer Responsibility Organization
• Login credentials (username, password) - either stored directly or linked via a collective account
• Additional metadata (registration number, interval, notes)

Credentials can be created in two ways:

1. Individual credentials: Credentials are stored directly for the client
2. Collective account credentials: The credential references a collective account. The client uses the credentials from the collective account, and any updates to the collective account automatically apply to all linked clients.

Conclusion

The Client Management API empowers EPR agencies to efficiently manage their client portfolios and associated compliance credentials. These credentials are essential for us to automatically submit reports on behalf of the EPR agency to various PRO portals across different countries. By centralizing this information, agencies can streamline their operations, reduce errors, and ensure timely compliance reporting for all their clients across multiple countries and compliance schemes.