API

Sales APIs

GET system/reports/108679/result-set?fromDate={fromDate}&toDate={toDate}&excludeNonBillable={excludeNonBillable}&view={view}

Sub report to REP/108669, REP/108689, REP/108697, REP/108699 and REP/10870. By default it shows all work logs. Set filter to identify work log by date, project order etc

Report name Project order work log (WOL) details
Report identifier 108679
HTTP method GET
URI https://api.rambase.net/system/reports/108679/result-set?fromDate={fromDate}&toDate={toDate}&excludeNonBillable={excludeNonBillable}&view={view}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5162, version 18

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.

Format:
1
1

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
view String, optional Selection of WorkLog elements to include

Default: ALL
$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.

ApprovedAt 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.
CostPrice Decimal Cost pr hour in local currency.
CustomerFirstName String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
EmployeeId Integer Employee identifier. Available macros: currentUser()
EndCustomerFirstName String Secondary name of a company or firstname of a person.
EndCustomerId Integer Customer identifier.
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
EndedAt 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.
InternalNote String Internal note.
ProjectOrderId Integer Project order identifier.
ProjectOrderItemId Integer Project order item identifier.
StartedAt 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()
TotalCost Decimal Total cost in local currency.
TotalHours Decimal Total hours of work log entry.

Read more about filters and sorting on how to use sortable parameters

ApprovedAt 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
CostPrice Decimal Cost pr hour in local currency
CustomerFirstName String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
EmployeeId Integer Employee identifier
EndCustomerFirstName String Secondary name of a company or firstname of a person
EndCustomerId Integer Customer identifier
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
EndedAt Datetime End date and time of work log entry
ExternalNote String External note
InternalNote String Internal note
ProjectOrderId Integer Project order identifier
ProjectOrderItemId Integer Project order item identifier
StartedAt Datetime Start date and time of work log entry
TotalCost Decimal Total cost in local currency
TotalHours Decimal Total hours of work log entry

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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <ProjectOrderItem
ProjectOrderItem

Project order item reference

>
5
                    <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

>{Integer}</ProjectOrderItemId>
6
                    <ProjectOrder
ProjectOrder

Project order reference

>
7
                         <ProjectOrderId
ProjectOrderId

Project order identifier

>{Integer}</ProjectOrderId>
8
                         <Name
Name

Name of the project order

>{String}</Name>
9
                         <ProjectOrderLink
ProjectOrderLink

Project order reference

>{String}</ProjectOrderLink>
10
                    </ProjectOrder>
11
                    <Product
Product

Product reference

>
12
                         <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
13
                         <Name
Name

Name of the product

>{String}</Name>
14
                         <Description
Description

Description of the item. If not specified, the description is by default copied from the product.

>{String}</Description>
15
                         <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
16
                    </Product>
17
                    <ProjectOrderItemLink
ProjectOrderItemLink

Project order item reference

>{String}</ProjectOrderItemLink>
18
               </ProjectOrderItem>
19
               <LaborCost
LaborCost

Labor cost identifier

>
20
                    <Product
Product

Product reference

>
21
                         <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
22
                         <Name
Name

Name of the product

>{String}</Name>
23
                         <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
24
                    </Product>
25
               </LaborCost>
26
               <Employee
Employee

Employee reference

>
27
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
28
                    <LastName
LastName

Last name of employee

>{String}</LastName>
29
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
30
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
31
               </Employee>
32
               <StartedAt
StartedAt

Start date and time of work log entry

>{Datetime}</StartedAt>
33
               <EndedAt
EndedAt

End date and time of work log entry

>{Datetime}</EndedAt>
34
               <TotalHours
TotalHours

Total hours of work log entry

>{Decimal}</TotalHours>
35
               <ApprovedBy
ApprovedBy

ApprovedBy reference

>
36
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
37
                    <LastName
LastName

Last name of employee

>{String}</LastName>
38
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
39
                    <ApprovedByLink
ApprovedByLink

Employee reference

>{String}</ApprovedByLink>
40
               </ApprovedBy>
41
               <ApprovedAt
ApprovedAt

The date and time the work log entry was approved to status 4 by manager

>{Datetime}</ApprovedAt>
42
               <CostPrice
CostPrice

Cost pr hour in local currency

>{Decimal}</CostPrice>
43
               <TotalCost
TotalCost

Total cost in local currency

>{Decimal}</TotalCost>
44
               <BillableHours
BillableHours

Billable hours of work log entry

>{Decimal}</BillableHours>
45
               <ExternalNote
ExternalNote

External note

>{String}</ExternalNote>
46
               <InternalNote
InternalNote

Internal note

>{String}</InternalNote>
47
               <Customer
Customer

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

>
48
                    <CustomerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

>{Integer}</CustomerId>
49
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

>{String}</Name>
50
                    <FirstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

>{String}</FirstName>
51
                    <CustomerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

>{String}</CustomerLink>
52
               </Customer>
53
               <EndCustomer
EndCustomer

End customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

>
54
                    <CustomerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

>{Integer}</CustomerId>
55
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

>{String}</Name>
56
                    <FirstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

>{String}</FirstName>
57
                    <CustomerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

>{String}</CustomerLink>
58
               </EndCustomer>
59
               <Inspect>
60
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
61
                    <Filter
Filter

Filter used when inspecting a line in a report.

>{String}</Filter>
62
               </Inspect>
63
          </Row>
64
     </Rows>
65
     <Paging
Paging

Detailed paging information for this list.

>
66
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
67
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
68
          <Page
Page

Page index

>{Integer}</Page>
69
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
70
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
71
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
72
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
73
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
74
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
75
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
76
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
77
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
78
     </Paging>
79
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "projectOrderItem
ProjectOrderItem

Project order item reference

": {
6
                         "projectOrderItemId
ProjectOrderItemId

Project order item identifier

": "{Integer}",
7
                         "projectOrder
ProjectOrder

Project order reference

": {
8
                              "projectOrderId
ProjectOrderId

Project order identifier

": "{Integer}",
9
                              "name
Name

Name of the project order

": "{String}",
10
                              "projectOrderLink
ProjectOrderLink

Project order reference

": "{String}"
11
                         },
12
                         "product
Product

Product reference

": {
13
                              "productId
ProductId

Product identifier

": "{Integer}",
14
                              "name
Name

Name of the product

": "{String}",
15
                              "description
Description

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
16
                              "productLink
ProductLink

Product reference

": "{String}"
17
                         },
18
                         "projectOrderItemLink
ProjectOrderItemLink

Project order item reference

": "{String}"
19
                    },
20
                    "laborCost
LaborCost

Labor cost identifier

": {
21
                         "product
Product

Product reference

": {
22
                              "productId
ProductId

Product identifier

": "{Integer}",
23
                              "name
Name

Name of the product

": "{String}",
24
                              "productLink
ProductLink

Product reference

": "{String}"
25
                         }
26
                    },
27
                    "employee
Employee

Employee reference

": {
28
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
29
                         "lastName
LastName

Last name of employee

": "{String}",
30
                         "firstName
FirstName

First name of employee

": "{String}",
31
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
32
                    },
33
                    "startedAt
StartedAt

Start date and time of work log entry

": "{Datetime}",
34
                    "endedAt
EndedAt

End date and time of work log entry

": "{Datetime}",
35
                    "totalHours
TotalHours

Total hours of work log entry

": "{Decimal}",
36
                    "approvedBy
ApprovedBy

ApprovedBy reference

": {
37
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
38
                         "lastName
LastName

Last name of employee

": "{String}",
39
                         "firstName
FirstName

First name of employee

": "{String}",
40
                         "approvedByLink
ApprovedByLink

Employee reference

": "{String}"
41
                    },
42
                    "approvedAt
ApprovedAt

The date and time the work log entry was approved to status 4 by manager

": "{Datetime}",
43
                    "costPrice
CostPrice

Cost pr hour in local currency

": "{Decimal}",
44
                    "totalCost
TotalCost

Total cost in local currency

": "{Decimal}",
45
                    "billableHours
BillableHours

Billable hours of work log entry

": "{Decimal}",
46
                    "externalNote
ExternalNote

External note

": "{String}",
47
                    "internalNote
InternalNote

Internal note

": "{String}",
48
                    "customer
Customer

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

": {
49
                         "customerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

": "{Integer}",
50
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

": "{String}",
51
                         "firstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

": "{String}",
52
                         "customerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Customer in your request URI to get this field

": "{String}"
53
                    },
54
                    "endCustomer
EndCustomer

End customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

": {
55
                         "customerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

": "{Integer}",
56
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

": "{String}",
57
                         "firstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

": "{String}",
58
                         "customerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.EndCustomer in your request URI to get this field

": "{String}"
59
                    },
60
                    "inspect": {
61
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}",
62
                         "filter
Filter

Filter used when inspecting a line in a report.

": "{String}"
63
                    }
64
               }
65
          ]
66
     }
67
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type