API: Timesheets – Workamajig

Example

The source code which is just HTML, CSS, and js pages can be downloaded here: Download Source )

Methods

* For the API to act on behalf of another person you will need the right "View anyone's timesheet" or be an administrator.

Retrieve a list of timesheets

Definition

GET /timesheets?timesheetKey=abc123&status=rejected&userKey=
DF113K34K323&startdate=mmddyyyy&includeTime=1&includeService=1

Parameters

timesheetKey: optional

providing the id will only return one record

status: optional

valid values are unsubmitted, submitted, rejected, approved <NB: defaults to unsubmitted >

userKey: optional

used to limit the result set to only one user

start date: optional (mm/dd/yyyy)

the start date of the first timesheet returned. Make sure single-digit days are prefixed with a zero.

include time: optional

boolean - set this to 1 if you want to get all of the time entries associated with this timesheet

include service: optional

boolean - set this to 1 if you want to get all of the service entries associated with this timesheet.

Example Request

https://workamajig.com/api/beta1/timesheet?timesheetKey=abc123&status=rejected&userKey=
DF113K34K323&startdate=mmddyyyy&includeTime=1&includeService=1

Example Response

{
"logid": "b1e56f1c-e364-4c95-a5eb-ab1a0e7252c7",
"data": {
"service": [
{
"ServiceCode": "ACCTMGMT",
"Description": "Account Management",
"ServiceKey": "/5Ehx/cTCGTI/1lKCD24PA=="
},
{
"ServiceCode": "ARTDES",
"Description": "Art & Creative Design",
"ServiceKey": "4RF9FwXqrs2Y7u51U30azA=="
}
],
"timesheet": [
{
"Status": 1,
"StartDate": "2014-10-28T00:00:00",
"UserEmail": "test@test.com",
"UserName": "Test Test",
"RateLevel": 1,
"DateCreated": "2014-11-10T18:12:00",
"TimeEntries": [],
"EndDate": "2014-10-28T00:00:00"
},
{
"Status": 1,
"StartDate": "2014-11-24T00:00:00",
"UserEmail": "test@test.com",
"UserName": "Test Test",
"RateLevel": 1,
"DateCreated": "2014-11-25T00:00:00",
"TimeEntries": [
{
"TimeSheetKey": "cxMxZAkwpsGTh9/pQGHUwA==",
"ActualHours": 5.0,
"ServiceKey": "9C8plfUnwrJ1zT5iDH0rEQ==",
"TimeKey": "8b0c3f5e-5618-4278-bdac-d489c712dbe8",
"TaskID": "1",
"TaskName": "Concept Development/Script/Storyboard",
"ServiceCode": "BrandConsul",
"ProjectName": "COPY - Some Tasks Assigned",
"ProjectNumber": "14-TD-0035",
"TaskKey": "Ja1aFCCpaRMHzDzXgKYF6Q==",
"ServiceDescription": "Brand Consulting",
"ProjectKey": "KAkqhnWa09nB2R3odEqYAw==",
"WorkDate": "2014-11-25T00:00:00"
},
{
"TimeSheetKey": "cxMxZAkwpsGTh9/pQGHUwA==",
"ActualHours": 3.0,
"ServiceKey": "y3bH2WwrGH/CKGN2D0HZ7g==",
"TimeKey": "f33221ce-e76e-4365-8d82-70f00c7546ba",
"TaskID": "1",
"TaskName": "Concept Development/Script/Storyboard",
"ServiceCode": "ADMIN",
"ProjectName": "COPY - Some Tasks Assigned",
"ProjectNumber": "14-TD-0035",
"TaskKey": "Ja1aFCCpaRMHzDzXgKYF6Q==",
"ServiceDescription": "General/Admin",
"ProjectKey": "KAkqhnWa09nB2R3odEqYAw==",
"WorkDate": "2014-11-25T00:00:00"
}
],
"EndDate": "2014-11-30T00:00:00"
}
]
}
}

Retrieve a list of projects

Definition

GET /projects?searchFor=xxxx&searchField=yyyy

Parameters

searchFor: required

a string value to search for to query projects

searchField: required

A field the search will be conducted on.

Valid search fields: ProjectNumber; ProjectName; ClientName; CampaignName; Description

Example Request

https://workamajig.com/api/beta1/projects?searchFor=create&searchField=Description

Example Response

{
"logid": "fadd6af0-6390-4b98-bcfd-37250153befe",
"data": {
"project": [
{
"ProjectKey": "t/oOSSvxub2s0Qh2/mUvxw==",
"Description": "Project Created thru API",
"ProjectNumber": "13-0019",
"ProjectName": "Project API"
},
{
"ProjectKey": "BV6ZmLL+n8iOZ6FfdTg0/Q==",
"Description": "Project Created thru API",
"ProjectNumber": "13-0020",
"ProjectName": "Project API"
},
{
"ProjectKey": "Krzrx71hlCldws549YljGQ==",
"Description": "The first phase of this project will be to create a brand and to market that brand.",
"ProjectNumber": "Q0001",
"ProjectName": "The making of a company"
}
]
}
}

Retrieve a list of users

Definition

GET /users

Parameters

id: optional

providing the user's id will only return one record

key: optional

providing the user's key will only return one record

Example Request

https://workamajig.com/api/beta1/users

Example Response

{
"logid": "fbe8ebca-72ba-48aa-aac3-8c488250dcdd",
"data": {
"user": [
{
"UserID": "abc",
"UserKey": "J04F0Rt3pxsZf4PDloiCKQ==",
"UserName": "Adam Sea",
},
{
"UserID": "mw",
"UserKey": "QnUIBWl/dM9+w9n4spnIAg==",
"UserName": "Mike Wang",
}
]
}
}

Retrieve a list of services

Definition

GET /services

Parameters

NONE

Example Request

https://workamajig.com/api/beta1/services

Example Response

{
"logid": "1720ee28-ded9-4f66-aa54-2db8d19f6b99",
"data": {
"service": [
{
"ServiceCode": "ACCTMGMT",
"Description": "Account Management",
"ServiceKey": "/5Ehx/cTCGTI/1lKCD24PA=="
},
{
"ServiceCode": "ARTDES",
"Description": "Art & Creative Design",
"ServiceKey": "4RF9FwXqrs2Y7u51U30azA=="
}
]
}
}

Retrieve a list of tasks

Definition

GET /tasks?projectKey=abc123

Parameters

You need at least of the following

projectKey: optional

projectNumber: optional

Example Request

https://workamajig.com/api/beta1/tasks?projectKey=2d+sB/sDZjudsFZvJndn4g==

Example Response

{
"logid": "790adf28-ab58-4880-8d9f-292c6ed0969a",
"data": {
"task": [
{
"TaskType": "Summary",
"PercComp": 80,
"UserAssigned": 0,
"TaskID": 111,
"TaskLevel": 0,
"AnyoneChargeTime": 0,
"AllowAnyone": 0,
"TaskName": "Design",
"TaskKey": "sP6bPGEWmGmcYpAy7ovLGg==",
"MoneyTask": 1,
"SummaryTaskKey": "OMyISTufDHvYPiFon6RWAQ==",
"TrackBudget": 0,
"ScheduleTask": 1
},
{
"TaskType": "Tracking",
"PercComp": 0,
"UserAssigned": 0,
"TaskID": 500,
"TaskLevel": 0,
"AnyoneChargeTime": 0,
"AllowAnyone": 0,
"TaskName": 500,
"TaskKey": "2OYE9mEBMkwDD0YKzkE+Yg==",
"MoneyTask": 1,
"SummaryTaskKey": "OMyISTufDHvYPiFon6RWAQ==",
"TrackBudget": 1,
"ScheduleTask": 1
}
]
}
}

Create a new timesheet

Definition

POST /timesheets

Parameters

start date: required (mm/dd/yyyy)

This is the start date for the timesheet. Make sure single-digit days are prefixed with a zero.

end date: optional (mm/dd/yyyy)

This is the end date for the timesheet. Make sure single-digit days are prefixed with a zero.

userKey: optional

If you're adding a timesheet for a specific user, you can use the user key.

time: optional

If you're adding time to the new timesheet, pass in an array of time objects, just like the PUT /timesheet/time but without the timesheetKey.

Example Request

https://workamajig.com/api/beta1/timesheets

[
{
"startdate": "12012014",
"enddate": "12072014",
"userKey": "WWvUq3+oMkYQn3GgZlkbjA==",
"time": [
{
"projectNumber": "14-TD-019",
"taskId": "1",
"serviceCode": "ARTDES",
"hours": "15",
"date": "12022014",
"comments": ""
},
{
"projectNumber": "14-TD-0019",
"taskId": "1.1",
"serviceCode": "Photography",
"hours": "5",
"date": "1202014",
"comments": ""
},
{
"projectNumber": "14-TD-0019",
"taskId": "2",
"serviceCode": "Copy",
"hours": "8",
"date": "12042014",
"comments": ""
}
]
}
]

Example Response

{
"success": [
{
"enddate": "12072014",
"timesheetkey": "gx2+rkU5x0ZxKmGORq9PwA==",
"success": [
{
"comments": "",
"hours": "5",
"serviceCode": "Photography",
"timeKey": "D3D7DEE0-279F-44EB-9741-E18CBC9BB219",
"taskId": "1.1",
"timesheetUserKey": null,
"date": "1202014",
"projectNumber": "14-TD-0019",
"timesheetKey": "gx2+rkU5x0ZxKmGORq9PwA=="
},
{
"comments": "",
"hours": "8",
"serviceCode": "Copy",
"timeKey": "1988B816-5D5B-4B20-AD50-05E553375CB7",
"taskId": "2",
"timesheetUserKey": null,
"date": "12042014",
"projectNumber": "14-TD-0019",
"timesheetKey": "gx2+rkU5x0ZxKmGORq9PwA=="
}
],
"errors": [
{
"comments": "",
"date": "12022014",
"errors": [
{
"entity": "time",
"code": 0,
"status": 400,
"message": "The project number is invalid."
}
],
"serviceCode": "ARTDES",
"taskId": "1",
"timesheetUserKey": null,
"hours": "15",
"projectNumber": "14-TD-019",
"timesheetKey": "gx2+rkU5x0ZxKmGORq9PwA=="
}
],
"startdate": "12012014"
}
],
"logid": "c0a67239-69b8-4782-abc5-f1ef17620285"
}

Submit / Approve a timesheet

Definition

PUT /timesheets/complete

Parameters

One of the following is required. The date will be ignored if the timesheet keys are passed in.

timesheetKey: optional

This is the identifier for the timesheet

date: optional (mm/dd/yyyy)

Approves all timesheets for the given date. Make sure single-digit days are prefixed with a zero.

comments: optional

Add any comments that go along with the approval

approverKey: optional

Add the userKey of the person doing the approval. If left off the approver is the person assigned to the user token will be used as the approver.

Example Request

https://workamajig.com/api/beta1/timesheets/complete

[ {

timesheetKey: "D1157CFB701C612662D4E16EBE58EB22" OR

date:12032014

} ]

Example Response

{
"success" : [
{
"timesheetKey" : "55BVFCHYnonepvnS2rIihQ=="
}
],
"logid" : "a7514e88-9c81-4589-a8f3-3fb5aa6fd3cd",
"errors" : [
{
"timesheetKey" : "FcgaCxxYTon0cqIaust0Aw==",
"errors" : [
{
"entity" : "time",
"code" : 0,
"status" : 400,
"message" : "The timesheet key supplied is not valid."
}
]
}
]
}

Add time to a timesheet

Definition

PUT /timesheets/time

Parameters

timesheetKey: required

This is the identifier for the timesheet

workDate: required (ISO Date ie. 2014-01-26T05:00:00.000Z )

This is the date the work was done

projectKey: optional

If a projectKey is not included in the request, the project number is required and vice versa.

projectNumber: optional

If a project number is not included in the request, the project key is required and vice versa.

taskKey: optional

If the task key is not included in the request, the task ID is required and vice versa. This is the identifier of the task the time will be assigned to.

task ID: optional

If task ID is not included in the request, the task key field is required and vice versa. This is an identifier of the task the time will be assigned to.

serviceKey: optional

If serviceKey is not included in the request, the service code field is required and vice versa.

service code: optional

If service code is not included in the request, the serviceKey field is required and vice versa.

hours: required

The number of hours being worked.

timesheetUserKey: optional

If you're adding time and don't have the timesheetKey, you can use the timesheetUser and date.

date: optional (mm/dd/yyyy)

The date of the timesheet you wish to add time to. Only required if passing in a timesheetUserKey

comments: optional

Text field to add comments to the time entry.

Example Request

https://workamajig.com/api/beta1/timesheets/time

[
{
"timesheetKey":"O0SblZRkoN+ONWQMuVBy2A==",
"projectNumber":"B0012",
"taskId":"CON-1",
"serviceCode":"ARTDES",
"hours": "15"
},
{
"timesheetKey":"O0SblZRkoN+ONWQMuVBy2A==",
"projectNumber":"B0012",
"taskId":"CON-1",
"serviceCode":"PHOTO",
"hours": "5"
},
{
"timesheetKey":"O0SblZRkoN+ONWQMuVBy2A==",
"projectNumber":"B0012",
"taskId":"CON-1",
"serviceCode":"COPY",
"hours": "8"
}
]

Example Response

{
"success" : [
{
"timeKey" : "C38BAE95-B813-4292-8451-64E5CBE8BF7B"
},
{
"timeKey" : "2F519354-0271-44A4-9BCE-D5DF58F5D971"
},
{
"timeKey" : "2966ACBC-B7A9-42F3-A6DF-13EDBC89B312"
}
],
"logid" : "826cd249-0280-4344-b892-fbe8205ca22f"
}

Delete a time entry on a timesheet

Definition

DELETE /timesheets/time

Parameters

timesheetKey: required

This is the identifier for the timesheet

time keys: required

An array of timesheet entry keys to be deleted

Example Request

https://workamajig.com/api/beta1/timesheets/time

[
{
"timesheetKey":"O0SblZRkoN+ONWQMuVBy2A==",
"timeKeys":["3E319354-0271-44A4-9BCE-D5DF58F5D974", "D28BAE95-B813-4292-8451-64E5CBE8BF7D"]
},
{
"timesheetKey":"B0SblZRkoN+ONWQMuVBy2A==",
"timeKeys":[ "2F519354-0271-44A4-9BCE-D5DF58F5D971", "C38BAE95-B813-4292-8451-64E5CBE8BF7B"]

}
]

Example Response

Delete a timesheet. (Please note this cannot be undone)

Definition

DELETE /timesheets?timesheetKey=abc123

Parameters

timesheetKey: required

This is the identifier for the timesheet

Example Request

https://workamajig.com/api/beta1/timesheets?timesheetKey=abc123

Example Response

{
"success": [
{
"timesheetkey": "bNsIQ2S7wCyM0b0Wpk53WQ=="
}
],
"logid": "895e6cd4-ed96-40b4-8683-483fcc5eef5a"
}

Articles in this section

Example

Methods

Related articles