Sales APIs
By default shows accumulated numbers for previous month, grouped by labor cost and employee. Check 'Related reports' for other grouping options.
| Report name | Project order work log (WOL) - grouped by labor cost and employee |
| Report identifier | 108697 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/108697/result-set?fromDate={fromDate}&toDate={toDate}&excludeNonBillable={excludeNonBillable} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5168, version 7 |
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.
| fromDate Date, optional |
Dates from and including date
Minimum: 2000.01.01 |
| toDate Date, optional |
Dates to and including date
Minimum: 2000.01.01 |
| excludeNonBillable Boolean, optional |
Selects whether or not non-billable WorkOrder logs should be excluded
Default: 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.
| EmployeeId Integer | Employee identifier. Available macros: currentUser() |
| ProjectOrderId Integer | Project order identifier. |
Read more about filters and sorting on how to use sortable parameters
| EmployeeId Integer | Employee identifier |
| ProjectOrderId Integer | Project order 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.
LaborCost
Labor cost identifier
>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Employee
Employee reference
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>TotalHours
Total hours of work log entry
>{Decimal}</TotalHours>TotalCost
Total cost of work log entry
>{Decimal}</TotalCost>ApprovedHours
Approved hours
>{Decimal}</ApprovedHours>ApprovedCost
Approved cost
HoursPendingApproval
Sum of all hours that are logged, but not yet approved by manager (status 3)
>{Decimal}</HoursPendingApproval>CostPendingApproval
Pending cost, in local currency. Is to be understood as pending if hours are logged, but yet not approved by leader (status 3)
>{Decimal}</CostPendingApproval>BillableHours
Billable hours of work log entry
>{Decimal}</BillableHours>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Filter
Filter used when inspecting a line in a report.
>{String}</Filter>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>LaborCost
Labor cost identifier
": {Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"Employee
Employee reference
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"TotalHours
Total hours of work log entry
": "{Decimal}",TotalCost
Total cost of work log entry
": "{Decimal}",ApprovedHours
Approved hours
": "{Decimal}",ApprovedCost
Approved cost
HoursPendingApproval
Sum of all hours that are logged, but not yet approved by manager (status 3)
": "{Decimal}",CostPendingApproval
Pending cost, in local currency. Is to be understood as pending if hours are logged, but yet not approved by leader (status 3)
": "{Decimal}",BillableHours
Billable hours of work log entry
": "{Decimal}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}",Filter
Filter used when inspecting a line in a report.
": "{String}"
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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |