Sales APIs
List of all work log entries
| HTTP method | GET |
| URI | https://api.rambase.net/sales/project-orders/work-log |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4255, version 34 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Approved() Named filter | Approved work log entries (status 4) |
| MyEntries() Named filter | My work log entries |
| PendingEmployeeAppr() Named filter | Work log entries pending employee approval (status 2) |
| PendingManagerAppr() Named filter | Work log entries pending manager approval (status 3) |
| Processed() Named filter | Processed work log entries (status 9) |
| StartedPreviousWeek() Named filter | Work log entries that has a Start at entry during the previous week |
| ApproveAt Datetime | The date and time the work log entry was approved to status 4 by manager. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ApprovedBy Integer | Employee identifier. |
| BillableHours Decimal | Billable hours of work log entry. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| EmployeeId Integer | Employee identifier. |
| EndAt Datetime | End date and time of work log entry. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ExternalNote String | External note. |
| InitialWorkLogId Integer | Reference to the initial worklog entry if there are several versions. |
| InternalNote String | Internal note. |
| IsCurrent Boolean | Current work log entry version. |
| ProductId Integer | Product identifier. |
| ProjectOrderId Integer | Project order identifier. |
| ProjectOrderItemId Integer | Project order item identifier. |
| StartAt Datetime | Start date and time of work log entry. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Status Integer | Status of work log. |
| TotalHours Decimal | Total hours of work log entry. |
| UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| WorkLogId Integer | Work log identifier. |
Read more about filters and sorting on how to use sortable parameters
| ApproveAt Datetime | The date and time the work log entry was approved to status 4 by manager |
| ApprovedBy Integer | Employee identifier |
| BillableHours Decimal | Billable hours of work log entry |
| CreatedAt Datetime | Date and time of creation |
| EmployeeId Integer | Employee identifier |
| EndAt Datetime | End date and time of work log entry |
| ExternalNote String | External note |
| InitialWorkLogId Integer | Reference to the initial worklog entry if there are several versions |
| InternalNote String | Internal note |
| IsCurrent Boolean | Current work log entry version |
| ProductId Integer | Product identifier |
| ProjectOrderId Integer | Project order identifier |
| ProjectOrderItemId Integer | Project order item identifier |
| StartAt Datetime | Start date and time of work log entry |
| Status Integer | Status of work log |
| TotalHours Decimal | Total hours of work log entry |
| UpdatedAt Datetime | Date and time of update |
| WorkLogId Integer | Work log identifier |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
WorkLogId
Work log identifier
>{Integer}</WorkLogId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>StartedAt
Start date and time of work log entry
>{Datetime}</StartedAt>EndedAt
End date and time of work log entry
>{Datetime}</EndedAt>TotalHours
Total hours of work log entry
>{Decimal}</TotalHours>BillableHours
Billable hours of work log entry
>{Decimal}</BillableHours>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Price
Cost pr hour in local currency
>{Decimal}</Price>Total
Total cost in local currency
>{Decimal}</Total>ApprovedAt
The date and time the work log entry was approved to status 4 by manager
>{Datetime}</ApprovedAt>ApprovedBy
The id of the manager who approved the work log entry to status 4
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>InternalNote
Internal note
>{String}</InternalNote>ExternalNote
External note
>{String}</ExternalNote>InitialWorkLog
Reference to the initial worklog entry if there are several versions
>WorkLogId
Work log identifier
>{Integer}</WorkLogId>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>Name
Name of the project order
>{String}</Name>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ProjectOrderItemLink
Project order item reference
>{String}</ProjectOrderItemLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>WorkLogId
Work log identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of work log
Possible domain values can be found here
": "{Integer}",StartedAt
Start date and time of work log entry
": "{Datetime}",EndedAt
End date and time of work log entry
": "{Datetime}",TotalHours
Total hours of work log entry
": "{Decimal}",BillableHours
Billable hours of work log entry
": "{Decimal}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"Price
Cost pr hour in local currency
": "{Decimal}",Total
Total cost in local currency
": "{Decimal}"ApprovedAt
The date and time the work log entry was approved to status 4 by manager
": "{Datetime}",ApprovedBy
The id of the manager who approved the work log entry to status 4
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"InternalNote
Internal note
": "{String}",ExternalNote
External note
": "{String}",InitialWorkLog
Reference to the initial worklog entry if there are several versions
": {WorkLogId
Work log identifier
": "{Integer}"ProjectOrderItemId
Project order item identifier
": "{Integer}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",ProjectOrderId
Project order identifier
": "{Integer}",Name
Name of the project order
": "{String}",ProjectOrderLink
Project order reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"ProjectOrderItemLink
Project order item reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102120 HTTP 404 | Delivery project not found |
| Error 100001 HTTP 404 | Address not found |
| Error 101420 HTTP 404 | Setting definition not found |