Get User Timesheets
Allows you to retrieve timesheets for a given user.
Get Timesheets
GET
https://7ax3q0jpx5.execute-api.us-east-1.amazonaws.com/prod
This endpoint allows you to get timesheets for a given user.
Query Parameters
tenant
string
Tenant key requesting this data.
api_key
string
API key of the platform/tenant.
jobseeker_id
number
JobSeeker Id for the one requesting the timesheets. (Not the user id, must be the unique id of the job seeker / freelancer)
time_from
string
Time stamp of the time you need Timesheets from.
time_to
string
Time stamp of the time you neeeed timesheets to. Must be present if you are ending 'time_from' attribute.
[{
"authorizer_code":"175",
"timein":"2019-09-26 11:00:00 UTC",
"charged":true,
"freelancer_id":"0.13e2",
"created_at":"2019-09-26 15:39:55 UTC",
"status":"approved",
"total_pay":"32.0",
"pay_status":"readytopay",
"hours":"2.0",
"shift_id":"0.326e3",
"income_id":"0.6e1",
"billing":"66.0",
"hour_status":"approved",
"timeout":"2019-09-26 13:00:00 UTC",
"updated_at":"2020-03-16 17:41:08 UTC",
"charge_status":"Charged card by admin with income id: 6 || ",
"chargable":"66.0",
"notes":"Admin updated hours from 0 hrs to 2 hrs. admin approved hours - ",
"authorizer":"admin",
"tender_id":"0.402e3",
"id":"0.22e2"
},
{
"company_id":"0.86e2",
"timein":"2020-03-17 14:02:08 UTC",
"freelancer_id":"0.129e3",
"created_at":"2020-03-17 18:02:08 UTC",
"address":"Boston, MA, USA",
"campaign_id":"0.406e3",
"shift_id":"0.1e4",
"updated_at":"2020-03-17 18:02:08 UTC",
"end":"2020-03-17 18:30:00 UTC",
"tender_id":"0.1263e4",
"id":"0.183e3",
"job_type":"Licensed Practical Nurse (LPN)",
"start":"2020-03-17 09:30:00 UTC"
}]
Request notes:
In case if time_from and time_to parameters are not provided the response will include all the timesheets from last 6 months. If the user has been inactive for last 6 months, the result will return no timesheets.
Please provide a way for user to retrive previous timesheets.
Understanding Response
id: Unique Id representing the timesheet. shift_id: The shift for which the timesheet is registered. When sending updates for this timesheets please use this shift_id and freelancer_id data to send updates when allowed. freelancer_id: Job Seeker id who has logged this timesheets. time_in: The time this job seeker checked in for this shift.
Optional Data: Below data may or may not be available for all shifts. time_out: The time this job seeker checked out from this shift. hours: Total hours logged for this shift. hour_status: If the hours/shift is approved or not. The shift that is not approved total_pay: In local currency how much the job seeker will be paid for this shift. pay_status: If the job seeker is paid or not. job_type: What was this job for. Could serve as a title. (Eg: Waiter, Marketing Manager) start: When was the shift scheduled to start. end: When was the shift scheduled to end. address: Where was this shift located. campaign_id: Unique order that this shift was part of. company_id: Client id that requested this shift. tender_id: Is the unque locater of interest of the job seeker for this shift.
Last updated
Was this helpful?