API

Production APIs

POST production/additional-production-costs

Create additional production cost API

HTTP method POST
URI https://api.rambase.net/production/additional-production-costs
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3312, 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
<AdditionalProductionCost>
2
     <Name
Name

Required/mandatory field

Additional production cost name

>
{String}</Name>
3
     <Classification
Classification

Additional production cost classification

Applicable domain values can be found here

This field is optional.

>
{String}</Classification>
4
     <CostTarget
CostTarget

Target of additional production cost

Applicable domain values can be found here

This field is optional.

>
{String}</CostTarget>
5
     <Cost
Cost

This field is optional.

>
6
          <ValueType
ValueType

Type of additional production cost value. Select AMOUNT for the fixed value or PERCENT for the percentage based value.

Applicable domain values can be found here

This field is optional.

>
{String}</ValueType>
7
          <Value
Value

Additional production cost value

This field is optional.

>
{String}</Value>
8
     </Cost>
9
</AdditionalProductionCost>
1
{
2
     "additionalProductionCost": {
3
          "name
Name

Required/mandatory field

Additional production cost name

":
"{String}",
4
          "classification
Classification

Additional production cost classification

Applicable domain values can be found here

This field is optional.

":
"{String}",
5
          "costTarget
CostTarget

Target of additional production cost

Applicable domain values can be found here

This field is optional.

":
"{String}",
6
          "cost
Cost

This field is optional.

":
{
7
               "valueType
ValueType

Type of additional production cost value. Select AMOUNT for the fixed value or PERCENT for the percentage based value.

Applicable domain values can be found here

This field is optional.

":
"{String}",
8
               "value
Value

Additional production cost value

This field is optional.

":
"{String}"
9
          }
10
     }
11
}

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
<AdditionalProductionCost>
2
     <AdditionalProductionCostId
AdditionalProductionCostId

Additional production cost identifier

>
{Integer}</AdditionalProductionCostId>
3
     <Type
Type

Additional production cost type

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

Additional production cost name

>
{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
6
     <Status
Status

Status of additonal production cost

Possible domain values can be found here

>
{Integer}</Status>
7
     <Classification
Classification

Additional production cost classification

Possible domain values can be found here

>
{String}</Classification>
8
     <CostTarget
CostTarget

Target of additional production cost

Possible domain values can be found here

>
{String}</CostTarget>
9
     <Cost>
10
          <Currency
Currency

Additional production cost currency

>
{String}</Currency>
11
          <ValueType
ValueType

Type of additional production cost value. Select AMOUNT for the fixed value or PERCENT for the percentage based value.

Possible domain values can be found here

>
{String}</ValueType>
12
          <Value
Value

Additional production cost value

>
{String}</Value>
13
     </Cost>
14
     <UsageCount>{}</UsageCount>
15
</AdditionalProductionCost>
1
{
2
     "additionalProductionCost": {
3
          "additionalProductionCostId
AdditionalProductionCostId

Additional production cost identifier

":
"{Integer}",
4
          "type
Type

Additional production cost type

":
"{String}",
5
          "name
Name

Additional production cost name

":
"{String}",
6
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
          "status
Status

Status of additonal production cost

Possible domain values can be found here

":
"{Integer}",
8
          "classification
Classification

Additional production cost classification

Possible domain values can be found here

":
"{String}",
9
          "costTarget
CostTarget

Target of additional production cost

Possible domain values can be found here

":
"{String}",
10
          "cost": {
11
               "currency
Currency

Additional production cost currency

":
"{String}",
12
               "valueType
ValueType

Type of additional production cost value. Select AMOUNT for the fixed value or PERCENT for the percentage based value.

Possible domain values can be found here

":
"{String}",
13
               "value
Value

Additional production cost value

":
"{String}"
14
          },
15
          "usageCount": "{}"
16
     }
17
}

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 104079 HTTP 400 Name is mandatory for production added cost.
Error 104268 HTTP 400 Type of cost has to be amount or percent, not both.
Error 105705 HTTP 400 You can't udate additional production cost when it is in use