Get earned wage balance

GET/payroll/ewa/balance

Returns the current earned-but-not-yet-paid wage balance for the authenticated employee or for the specified employee_id (admin). Balance is computed from the current pay period's approved timesheets. Use to display the available EWA draw amount in the employee self-service portal.

Request

Query parameters

Name	Type	Required	Description
employee_id	integer	No	Employee ID (admin use only; omit to use the authenticated employee's ID).

Responses

200 Employee's current earned wage balance

Content type application/json, object · EwaBalanceV1.

Field	Type	Required	Description
employee_id	integer	No
period_start	string (date)	No
period_end	string (date)	No
earned_to_date	number (float)	No	Total wages earned so far in the current pay period.
drawn_to_date	number (float)	No	Total amount already drawn via EWA in this pay period.
available_balance	number (float)	No	Maximum amount currently available for an EWA draw (earned_to_date minus drawn_to_date, capped at max_draw_limit).
currency	string	No	Max length: 3
max_draw_limit	number (float)	No	Configured maximum single-draw limit for this employee.
as_of	string (date-time)	No	Timestamp at which this balance was computed.

Example

{
  "employee_id": 42,
  "period_start": "2026-04-01",
  "period_end": "2026-04-30",
  "earned_to_date": 2100.0,
  "drawn_to_date": 500.0,
  "available_balance": 1600.0,
  "currency": "GHS",
  "max_draw_limit": 1200.0,
  "as_of": "2026-04-08T12:00:00Z"
}

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/ewa/balance" \
  -H "Accept: application/json"