Employees

Get all employees in your company

https://registrations.api.bitabiz.com/pbi/{API token}/employees

Optional parameter: ?inactive=true
Retrieves inactive employees in a company

Employees include the following information and columns:

Employees / NationalHolidays

This route is for getting bank holidays for all employees in a company in a given period

https://registrations.api.bitabiz.com/pbi/{API token}/employees/nationalHolidays

Optional parameter: from=YYYY-MM-dd, to=YYYY-MM-dd

National holidays include the following information and columns:

Employees / History

Get the last two years of vacation and other vacation history, plus information on employee’s hour bank.

https://registrations.api.bitabiz.com/pbi/{API token}/employees/history

Optional paramater: years=XXXX,XXXX,XXXX
Comma separated list of years: ?years=2018,2019,2020

History includes the following information and columns:

Registrations

Getting registrations for the whole company in a period specified.

https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations

Optional parameters:
from=YYYY-MM-dd, to=YYYY-MM-dd
reason = comma separated reason codes, please see our table of possible reason codes
status = comma separated status codes, please see our table of possible status codes

Registrations include the following information and columns:

Registrations / employee

Getting registrations for a single employee. Same columns and parameters can be applied as in the registrations route above

https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations/{EMPLOYEEGUID}

Attributes in API queries

Attributes are URL parameters. Standard attribute is for example from and to. Parameters can be combined while the first parameter starts with ? other additional parameters are added with &

Example
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?from=2019-01-01&to=2019-12-31

FROM and TO parameter

From and to need to have a value in this format YYYY-MM-dd. It is also possible to use literal like

?from=2019-01-01&to=2019-12-31
?from=lastXXmonths.

Example
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?from=last24months
loads results between today and the same date 2 years ago.

STATUS Parameter

In BitaBIZ, registration can have 4 different status types.
APP = approved,
PEN = pending,
REJ = rejected
DEL = deleted.

By default only registrations with status=app (approved) are shown. If you need to add other registration status, separate values with comma. Status=app,pen,rej

Example
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?from=2019-01-01&to=2019-12-31&status=pen

Returns all pending registrations in a period.

REASON Parameter

BitaBIZ has over 10 different registration types. It is possible to filter out only certain registration types or combine two or more types. These parameters are not case sensitive, so both variations like ‘hh’ and ‘HH’ will work. Without the reason parameter being present, all registration types are returned.

Combination example
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=L,HF,HH,IC,IS,VT,VO,DT,DO

All reason examples

Sick registrations (Reason=IS)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=IS

Child sick (Reason=IC)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=IC

Vacation (Reason=HH)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=HH

Other vacation (Reason=HF)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=HF

Leave (Reason=L)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=L

Own types (Reason=P)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=P

Overtime (Reason=VO)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=VT

Time off (Reason=VT)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=VO

Time (Reason=TT)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=TT

Mileage (Reason=MI)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=MI

Daybank – plusdays (Reason=DO)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=DO

Daybank - minus days (Reason=DT)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=DT

FLEX (Reason=FT)
https://registrations.api.bitabiz.com/v2-pbi/{API token}/registrations?reason=FT

Did this answer your question?