Employers Report

This endpoint generates a comprehensive report of employers registered in the Netevia Banking system. It returns payroll status and employee count data for each employer, optionally filtered by agent associations and scoped to a specific time period. The endpoint supports pagination via take and skip parameters, making it suitable for both summary views and large-scale data exports.

Endpoint

POST /Report/employers

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when you need to audit or analyze employer relationships managed through the platform, particularly to monitor payroll enrollment status and workforce headcount trends. It is useful for partners managing Earned Wage Access (EWA) programs who need to track employer eligibility and employee participation across reporting periods. Filtering by agentIds allows partner agents to retrieve data scoped to their own employer portfolios.

Request Body

{
  "period": "2024-10-09T14:53:38.154Z",
  "take": 50,
  "skip": 0,
  "agentIds": [101, 102, 103]
}

Response

200 OK

Returns an array of employer report objects.

[
  {
    "profileId": 4821,
    "name": "Acme Logistics Inc.",
    "isPayroll": true,
    "employeesAtPeriod": 312,
    "employeesTotal": 340,
    "employeesAtEndOfPeriod": 318
  },
  {
    "profileId": 4830,
    "name": "Summit Retail Group",
    "isPayroll": false,
    "employeesAtPeriod": 87,
    "employeesTotal": 95,
    "employeesAtEndOfPeriod": 90
  }
]

Error Codes

Common Mistakes

• Providing period in a non-ISO 8601 format (e.g., "10/09/2024" instead of "2024-10-09T14:53:38.154Z") will result in a 400 error.
• Omitting both take and skip when querying large datasets may return an unexpectedly large payload; use pagination parameters for production workloads.
• Passing an empty array [] for agentIds may return no results; pass null instead if you intend to retrieve all employers regardless of agent association.
• Assuming employeesAtPeriod and employeesAtEndOfPeriod will always be equal — they differ when employee registrations changed during the period.

Related Endpoints

• POST /Report/employees — Generates a report of individual employees within the system
• POST /Report/transactions — Retrieves transaction-level reporting data
• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/auth/refresh — Refresh an existing Bearer token

Example

curl -X POST https://api.banking.netevia.dev/Report/employers \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "2024-10-09T14:53:38.154Z",
    "take": 50,
    "skip": 0,
    "agentIds": [101, 102, 103]
  }'