Sales APIs
Creates a new item in work log
| HTTP method | POST |
| URI | https://api.rambase.net/sales/project-orders/{projectOrderId}/items/{itemId}/work-log |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {projectOrderId} |
Project order identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Project order item identifier
Integer, minimum 1 |
| Successful HTTP status code | 201 |
| API resource identifier | 4246, version 14 |
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.
StartedAt
Required/mandatory field
Start date and time of work log entry
>{Datetime}</StartedAt>TotalHours
Required/mandatory field
Total hours of work log entry
Minimum value: 0
>{Decimal}</TotalHours>BillableHours
Billable hours of work log entry
Minimum value: 0
This field is optional.
>{Decimal}</BillableHours>Employee
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>ProductId
Required/mandatory field
Product identifier
>{Integer}</ProductId>InternalNote
Internal note
This field is optional.
>{String}</InternalNote>ExternalNote
External note
This field is optional.
>{String}</ExternalNote>StartedAt
Required/mandatory field
Start date and time of work log entry
": "{Datetime}",TotalHours
Required/mandatory field
Total hours of work log entry
Minimum value: 0
": "{Decimal}",BillableHours
Billable hours of work log entry
Minimum value: 0
This field is optional.
": "{Decimal}"Employee
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"ProductId
Required/mandatory field
Product identifier
": "{Integer}"InternalNote
Internal note
This field is optional.
": "{String}",ExternalNote
External note
This field is optional.
": "{String}"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.
| $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 |
| $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. |
| $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] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the 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>InternalNote
Internal note
>{String}</InternalNote>ExternalNote
External note
>{String}</ExternalNote>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>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>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>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>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}",InternalNote
Internal note
": "{String}",ExternalNote
External note
": "{String}",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}"InitialWorkLog
Reference to the initial worklog entry if there are several versions
": {WorkLogId
Work log identifier
": "{Integer}"ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrderId
Project order identifier
": "{Integer}",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}"
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 101551 HTTP 404 | Object {0} not found |
| Error 104869 HTTP 404 | Default account not found |
| Error 105186 HTTP 400 | Postings are not allowed on control accounts. |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
| Error 102482 HTTP 400 | Department is required for general ledger account {0} |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 100276 HTTP 400 | Invalid email format |
| Error 106993 HTTP 400 | It is not allowed to add fee to the internal sales order for material for project order. |
| Error 106994 HTTP 400 | It is not allowed to add freight to a sales order for material for project order. |