API Reference
Home

v1/hour_accounts/{employment_id}/export

get
https://shyftplan.com/api/v1/hour_accounts//export

Retrieve the hour account of an employment for a specific month. The response payload will be a csv-formatted representation of the hour-account for the selected month, with a title row, one row per calendar day, and an aggregation-row at the end.

Path Params
int32
required
≥ 1

ID of the employment.

Query Params
string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

int32
enum
required

Year in format YYYY.

int32
enum
required
1 to 12

Number of the month, 1-based (1 - January, ..., 12 - December).

boolean
required

Include contracted hours in the report?

boolean
required

Include planned hours in the report?

boolean
required

Include presence hours in the report?

boolean
required

Include break minutes in the report?

boolean
required

Include absence hours in the report?

boolean
required

Include special-day hours in the report?

boolean
required

Include correction hours in the report?

boolean
required

Include future values in the report?

boolean
required

Include the staff number in the report?

boolean
required

Include the balance at the end of the previous month in the report?

boolean
required

Include the date of the export in the report?

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/csv
application/json
Updated 6 months ago