post https://api.banking.netevia.dev/Report/employers
This API endpoint generates a report detailing information about employers within the banking system. It provides insights into the payroll status and employee counts for specified periods.
Body Parameters:
- period (date-time | null):
The specific date and time for which the employer report is generated. Example: 2024-10-09T14:53:38.154Z. If set to null, the report may cover a default period. - take (int32 | null):
Specifies the maximum number of employer records to retrieve. Setting this to null retrieves all results at once. - skip (int32 | null):
Indicates the number of records to skip before starting to retrieve employer data. This is useful for pagination. Default is 0, meaning no records are skipped. - agentIds (array of int32s | null):
An array of agent IDs to filter the employer records. If provided, only employers associated with these agents will be included in the report.
Response:
- Returns an array of employer objects, each containing the following fields:
- profileId (int32):
The unique identifier for the employer's profile. - name (string):
The name of the employer. - isPayroll (boolean):
Indicates whether the employer has a payroll setup (true or false). - employeesAtPeriod (int32):
The number of employees registered with the employer during the specified period. - employeesTotal (int32):
The total number of employees registered with the employer, regardless of the period.
- profileId (int32):
Summary:
The POST /Report/employers API provides a comprehensive overview of employers within the banking system, focusing on payroll status and employee counts. It supports flexible querying through pagination and filtering by agent IDs, making it an essential tool for managing employer relationships and payroll analytics.