Skip to main content
POST
Add employees

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policyId
integer
required

The id of the paid policy

Response

The addition, waiting to be paid

id
string<uuid>
status
enum<string>
Available options:
pending,
paid
insurance_provider
string

The insurer of the policy, which prices the addition

starts_on
string<date>

The first day the new people are covered: the day the addition was priced

ends_on
string<date>

The last day of the policy

days
integer

Days from starts_on to ends_on, both included

members
object[]

Everyone joining: new employees, their dependents, and new dependents of employees already covered

total_price
number
currency
string
Example:

"SAR"

Where the company pays for the addition. Null once it is paid

created_at
string<date-time>
paid_at
string<date-time> | null