API

Human resource APIs

POST human-resources/labor-groups/{laborGroupId}/costs

Creates a new labor cost in provided labor group

HTTP method POST
URI https://api.rambase.net/human-resources/labor-groups/{laborGroupId}/costs
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {laborGroupId} Labor group identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4232, version 2

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
<LaborCost>
2
     <IsDefault
IsDefault

Determines whether or not a cost type is the default cost for a labor group

Default value: False

This field is optional.

>{Boolean}</IsDefault>
3
     <Product>
4
          <ProductId
ProductId

Required/mandatory field

Product identifier

>{Integer}</ProductId>
5
     </Product>
6
</LaborCost>
1
{
2
     "laborCost": {
3
          "isDefault
IsDefault

Determines whether or not a cost type is the default cost for a labor group

Default value: False

This field is optional.

": "{Boolean}",
4
          "product": {
5
               "productId
ProductId

Required/mandatory field

Product identifier

": "{Integer}"
6
          }
7
     }
8
}

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.

Format:
1
<LaborCost>
2
     <LaborCostId
LaborCostId

Labor cost identifier

>{Integer}</LaborCostId>
3
     <Status
Status

Status of the labor group cost types

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <IsDefault
IsDefault

Determines whether or not a cost type is the default cost for a labor group

>{Boolean}</IsDefault>
6
     <Product>
7
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
10
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
11
     </Product>
12
     <Cost>
13
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
14
          <Price
Price

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

>{Decimal}</Price>
15
     </Cost>
16
</LaborCost>
1
{
2
     "laborCost": {
3
          "laborCostId
LaborCostId

Labor cost identifier

": "{Integer}",
4
          "status
Status

Status of the labor group cost types

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "isDefault
IsDefault

Determines whether or not a cost type is the default cost for a labor group

": "{Boolean}",
7
          "product": {
8
               "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
10
               "type
Type

Type of product

Possible domain values can be found here

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

Product reference

": "{String}"
12
          },
13
          "cost": {
14
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
15
               "price
Price

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

": "{Decimal}"
16
          }
17
     }
18
}

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 105522 HTTP 400 Product for work hours (type WH) is mandatory for labor group cost
Error 105524 HTTP 400 Only products of type work hours ('WH') can be added