Overview
The Contazen API supports multi-work-point (multi-branch) access, allowing you to manage data across all locations of your business using a single API key. This is particularly useful for businesses with multiple offices, stores, or branches.How It Works
When you authenticate with an API key, you automatically gain access to:- The work point where the API key was created
- All other work points belonging to the same parent company
Work Point = A physical business location or branch
Parent Company = The legal entity that owns multiple work points
Accessing Specific Work Points
By default, API requests operate on the work point where the API key was created. To access data from a different work point, include thework_point_id
parameter in your request.
Getting Work Point IDs
First, retrieve the list of available work points:Working with Multiple Work Points
List Invoices from All Work Points
To retrieve invoices from all work points, omit thework_point_id
parameter:
List Invoices from Specific Work Point
To retrieve invoices from a specific work point:Create Invoice for Specific Work Point
When creating resources, specify the target work point:Common Use Cases
Consolidated Reporting
Generate reports across all business locations:Centralized Client Management
Share client data across all locations:Location-Specific Operations
Process operations for a specific branch:Best Practices
Set Default Work Point
Set Default Work Point
Configure a default work point in your SDK client to avoid specifying it for every request:
Cache Work Point List
Cache Work Point List
Work points don’t change frequently. Cache the list to reduce API calls:
Handle Work Point Permissions
Handle Work Point Permissions
Always handle cases where a work point might not be accessible:
Limitations
- API keys can only access work points within the same parent company
- Some operations may be restricted to specific work points based on permissions
- Work point IDs are immutable and cannot be changed once created
Related Resources
- Authentication - Learn about API key management
- Settings API - Retrieve work point information
- PHP SDK - SDK with built-in multi-work-point support