Introduction

BitaBIZ API can be used for retrieving employees, registrations and other information from your BitaBIZ account to build your own reports.

In order to use and test the BitaBIZ API you will need to activate your company’s API key on your BitaBIZ account.

πŸ’ It requires Setup admin role to activate the API key

Click: Setup admin > Company > Subscription plan

BitaBIZ REST API vs BitaBIZ Excel & PowerBI API

The BitaBIZ API can return data in both JSON and CSV format depending on the query string URL you use in the API call.

REST API

The REST API returns data in JSON format and have the following main query URL:

https://registrations.api.bitabiz.com/v2/

The REST API can be tested in a desktop tool like Postman.

In Postman you will need to add your company's API Key as x-apikey in the Headers section of your request:

Excel & PowerBI API

The Excel & PowerBI API returns data in CSV format and have the following main query URL:

https://registrations.api.bitabiz.com/pbi/

Use the BitaBIZ Excel & PowerBI API to create your own reports.

Insert the query URLs you are going to use in PowerBI or Excel.

API documentation

Employees

To get all employees including their master data in your company use this URL:

REST API:

HTTP Method GET https://registrations.api.bitabiz.com/v2/employees/nationalholidays

BitaBIZ Excel & PowerBI API:

https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/employees

The employees URL returns the following master data information:

BitaBIZ name/ID

API name/ID

Description

Guid

Unique employee identification, with this id several reports can be joined.

First name

Last name

Name

First name and last name

First name

Middle name

Last name

Full name

First name, middle name, last name

Department

Department

P-Number

pNumber

P number for DST (Denmark Statsistics reporting)

Job Title

JobTitle

Employee number

EmployeeId

Internal company id

Payroll number

EmployeePayrollId

Payroll id used by an external payroll system.(Format can be numbers, letters or a combination of both)

Office location

Country.Name

Office location tag

Country/region/calendar group

Country.Region

Country, region and calendar group tag

Group Company

Group.Company

Group company tag

Email

PersonalInfo.Email

Birthday

PersonalInfo.Birthdate

Mobile number

PersonalInfo.Mobile

Date of employment

Employment.Start

Employment.End

Date of termination for inactive employees

LastLogin

Active

By default, only active users are shown - add this attribute to the URL to get both active and inactive users: ?inactive=true

Link between BitaBIZ employee master data and the API:

Employee master data include policy settings the employee is attached to:

BitaBIZ name/ID

API ID

Description

SalaryAgreement.Id

Policy

SalaryAgreement.Name

Working week

SalaryAgreement.WorkingDays

Monday-Friday (5) or other work week (7)

Work week -> Work hours per week

SalaryAgreement.HoursPerWeek

Sum of standard work hours per week

Vacation days/ year

SalaryAgreement.VacationDays

Does not include any adjustments or vacation taken

Other Vacation days/ year

SalaryAgreement.OtherVacationDays

Does not include any adjustments or other vacation taken

Week day name

SalaryAgreement.WeekDaysCsv.weekDay[x]English

Week day 1 = Monday.

Week day 2 = Tuesday.

etc.

Standard work hours per week day

SalaryAgreement.WeekDaysCsv.weekDay[X]

Week day 1 = Standard hours on a Monday.

Week day 2 = standard hours on a Tuesday.

Etc.

πŸ†• Standard work hours per week day for secondary week.

SalaryAgreement.WeekDaysCsv.weekDay[X]secondaryHours

Week day 1 = Secondary hours on a Monday.

Week day 2 = Secondary hours on a Tuesday.

Etc.

πŸ†• Standard work start time on week day

SalaryAgreement.WeekDaysCsv.weekDay[X]start

Week day 1 start = Standard work start time (eg. 8:00)

πŸ†• Standard work end time on week day

SalaryAgreement.WeekDaysCsv.weekDay[X]end

Week day 1 end = Standard work end time (eg. 16:00)

πŸ†• Standard work start time for secondary week day

SalaryAgreement.WeekDaysCsv.weekDay[X]secondaryStart

Week day 1 secondary start = Standard work start time (eg. 7:00)

Standard work end time for secondary week day

SalaryAgreement.WeekDaysCsv.weekDay[X]secondaryEnd

Week day 1 secondary end = Standard work end time (eg. 15:00)

Vacation factor for payroll system

SalaryAgreement.VacationFactor

Payroll 1:1 (Full time).

Payroll 1:1.25 (Part time 4 working daysFull time).

Etc.

Salary part code for vacation for payroll system

SalaryAgreement.VacationCode

Code for export to external payroll system.

πŸ†• Salary part code for Other vacation for payroll system

SalaryAgreement.otherVacationCode

Code for export to external payroll system.

πŸ†• Salary part code for Sick Leave for payroll system

SalaryAgreement.sickCode

Code for export to external payroll system.

πŸ†• Salary part code for Child sick leave for payroll system

SalaryAgreement.childSickCode

Code for export to external payroll system.

πŸ†• Seconday work week applies to odd or even weeks.

SalaryAgreement.WeekRule

"Even" = Standard work hours for secondary week applies to even weeks, ie. week 20.

"Odd" = Standard work hours for secondary week applies to odd weeks, ie. week 21.

πŸ†• Breaks

salaryAgreement.BreaksCSV

List of active breaks on employee's policy, ie:

"12:00-12:30, 14:00-15:30"

πŸ†• Employee's timezone

Timezone

Timezone : β€œ(GMT+01:00) Amsterdam,…”

πŸ†• Payroll, Employee and HR tags

Tags

"Payroll"="ADSL",
"Employee"="Office 365 Admin",
"HR"="Security representative"

πŸ†• Approver(s)

Approvers

Email of approver(s) for employee. If employee is selfapprover approver is shown as "selfapprover".

Link between BitaBIZ policy settings and the API:

Employees / NationalHolidays

This URL request is for getting bank holidays for all employees in a company in a given period.

REST API:

HTTP Method GET

https://registrations.api.bitabiz.com/v2/employees/nationalholidays

BitaBIZ Excel & PowerBI API:

https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/employees/nationalHolidays

Optional parameters:

from=yyyy-MM-dd, to=yyyy-MM-dd

Examples:

https://registrations.api.bitabiz.com/v2/employees/nationalholidays?from=2021-01-01&to=2021-12-31

https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/employees/nationalholidays?from=2021-01-01&to=2021-12-31

National holidays returns the following information:

BitaBIZ name/ID

API ID

Description

Guid

Unique employee identification, with this id several reports can be joined.

First Name

Last name

Name

First name and last name.

SumOfDays

Sum of national holidays in days in a period.

SumOfHours

Sum of national holidays in hours according to the employee's daily work hours.

HolidaysCount

Count of national holidays in a period.

Add holidays > Holiday name

Holidays.Description

Name of national holiday ie "New Year's Eve".

Holidays.StartDate

Holidays.EndDate

Holidays.DayOfWeek

Name of a day (Monday-Sunday).

Holidays.SumDays

Value in days can be 1 for full-day or 0.5 for half-day.

Holidays.SumHours

Value in hours according to employee hours per day.

Registrations

Getting registrations for the whole company in a period specified.

REST API:

HTTP Method GET

https://registrations.api.bitabiz.com/v2/registrations

BitaBIZ Excel & PowerBI API:

https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/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

Examples:

https://registrations.api.bitabiz.com/v2/registrations?from=2021-01-01&to=2021-12-31&status=app,pen

https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/registrations?from=2021-01-01&to=2021-12-31&status=app,pen

Registrations include the following information and columns:

BitaBIZ name/ID

API ID

Description

Guid

First name

Last name

Name

The name saved to an registration is saved historically. For exampel, if employee last name changes this change will not change the name attached to a saved registration.

If name on registrations should change accourding to changes to an employee name get emplyee name from /employees.

Registration.Spanned

Can be TRUE if spanning over several days

Registration.SpannedDay

When the registration consists of several days - this would be the count of the day. 0 is the first day in spanned registration.

Registration.Date

Registration.TimeStart

Registration.TimeEnd

Registration.Amount.Days

Value in days if relevant for registration type

Registration.Amount.Hours

Value in hours if relevant for registration type

Registration.Amount.Km

Value in km if relevant for registration type

Registration.Amount.Unit

Default unit or a combination (days and hours)

Registration.DateDetails.Week

Week number

Registration.DateDetails.Weekday

Day number of the week (1 - Monday)

Registration.DateDetails.WeekDayEnglish

Name of the day of the week

Registration.DateDetails.Holiday

True if the registration overlaps national holiday

Registration.DateDetails.HolidayDetails.Description

Name of the national holiday that is overlapped

Registration.Type

Vacation, Other vacation, Child sick, Sick, Out of office, Overtime, Time off, Leave, Mileage

Registration.Subtype

Subtype - are 1/a job code for Time and Overtime registrations, or 2/ Subtypes to specify registrations in more detail, like e.g. other absence.

Registration.Reason

BitaBIZ reason codes:

HH = Vacation

HF= Other vacation (Customizable name)

IS= Sick

IC= Child sick

L= Other absence/Leave (Customizable name)

P= Own types

VO: Overtime

(Customizable name)

VT: Time off

(Customizable name)

TT: Time

MI: Milage

FT: Flextime (Customizable name)

DO: Day bank plus day

(Customizable name)

DT: Day bank minus day

(Customizable name)

RHH: Payout Vacation

RHF: Payout Other vacation

RVT: Payout Hour Bank

RDT: Payout Day bank

Registration.Created

Timestamp of when the registration got created

Registration.Note

A note added to a registration - Notes for Sick registrations are never shown to other than employee and Approver

Registration.OfficeStatus

The out of office status associated with the registration: β€œFree”/ ”Busy”/ ”Out of office”

Registration.JobCode.Id

Jobcode id for integration to other payroll systems

Registration.JobCode.IsPayroll

TRUE/FALES - if true registration is to be processed by an external payroll system

Registrations / employee

Getting registrations for a single employee. Same parameters can be applied as in the registration's route above.

REST API:

HTTP Method GET

https://registrations.api.bitabiz.com/v2/registrations/INSERT_EMPLOYEEGUID_HERE

BitaBIZ Excel & PowerBI API: https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/registrations/INSERT_EMPLOYEEGUID_HERE

Attributes in API queries

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

Examples:

https://registrations.api.bitabiz.com/v2/registrations?from=2019-01-01&to=2019-12-31


https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/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.

Examples:

https://registrations.api.bitabiz.com/v2/registrations?from=last24months


https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/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

Examples:

https://registrations.api.bitabiz.com/v2/registrations?from=2019-01-01&to=2019-12-31&status=pen


https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/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 examples:

https://registrations.api.bitabiz.com/v2/registrations?reason=L,HF,HH,IC,IS,VT,VO,DT,DO


https://registrations.api.bitabiz.com/pbi/INSERT_API_KEY_HERE/registrations?reason=L,HF,HH,IC,IS,VT,VO,DT,DO

Registration types

Sick day registrations (Reason=IS)

https://registrations.api.bitabiz.com/v2/registrations?reason=IS


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=IS

Colum in Excel

Amount

Weekend

Holidays

Day off

registrationAmontDays

Days

Count registration 0 if weekend

Count registration 0 if holiday

Count registration 0 if day off

registrationAmontHours

Hours

(look at standard work hours for hour amount)

-

-

-

Child sick (Reason=IC)

https://registrations.api.bitabiz.com/v2/registrations?reason=IC


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=IC

Amount colum in Excel

Weekend

Holidays

Day off

registrationAmontDays

Count registration 0 if weekend

Count registration 0 if holiday

Count registration 0 if day off

registrationAmontHours

-

-

-

Vacation (Reason=HH)

https://registrations.api.bitabiz.com/v2/registrations?reason=HH


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=HH

Other vacation (Reason=HF)

https://registrations.api.bitabiz.com/v2/registrations?reason=HF


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=HF

Leave (Reason=L)

https://registrations.api.bitabiz.com/v2/registrations?reason=L


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=L

Own types (Reason=P)

https://registrations.api.bitabiz.com/v2/registrations?reason=P


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=P

Overtime (Reason=VO)

https://registrations.api.bitabiz.com/v2/registrations?reason=VT


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=VT

Time off (Reason=VT)

https://registrations.api.bitabiz.com/v2/registrations?reason=VO


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=VO

Time (Reason=TT)

https://registrations.api.bitabiz.com/v2/registrations?reason=TT


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=TT

Mileage (Reason=MI)

https://registrations.api.bitabiz.com/v2/registrations?reason=MI


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=MI

Daybank – plusdays (Reason=DO)

https://registrations.api.bitabiz.com/v2/registrations?reason=DO


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=DO

Daybank - minus days (Reason=DT)

https://registrations.api.bitabiz.com/v2/registrations?reason=DT


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=DT

FLEX (Reason=FT)

https://registrations.api.bitabiz.com/v2/registrations?reason=FT


https://registrations.api.bitabiz.com/v2-pbi/INSERT_API_KEY_HERE/registrations?reason=FT


Did this answer your question?