Product APIs
API resource to append a new product structure added cost
| HTTP method | POST |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/additional-costs |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 7042, version 5 |
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.
CostBase
Required/mandatory field
Specifies which added cost value this additional cost is calculated from
Applicable domain values can be found here
>{Integer}</CostBase>Note
A note for product structure version's additional cost
This field is optional.
>{String}</Note>AdditionalProductionCostId
Required/mandatory field
Additional production cost identifier
Minimum value: 100000
>{Integer}</AdditionalProductionCostId>ProductStructureOperation
This field is optional.
>ProductStructureOperationId
Product structure operation identifier
Minimum value: 1
This field is optional.
>{Integer}</ProductStructureOperationId>CostBase
Required/mandatory field
Specifies which added cost value this additional cost is calculated from
Applicable domain values can be found here
": "{Integer}",Note
A note for product structure version's additional cost
This field is optional.
": "{String}",AdditionalProductionCostId
Required/mandatory field
Additional production cost identifier
Minimum value: 100000
": "{Integer}"ProductStructureOperation
This field is optional.
": {ProductStructureOperationId
Product structure operation identifier
Minimum value: 1
This field is optional.
": "{Integer}"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.
ProductStructureAdditionalCostId
Product structure added cost identifier
>{Integer}</ProductStructureAdditionalCostId>Note
A note for product structure version's additional cost
>{String}</Note>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>CostBase
Specifies which added cost value this additional cost is calculated from
Possible domain values can be found here
>{Integer}</CostBase>AddedCostValue
Additional production cost value
>{Decimal}</AddedCostValue>AdditionalProductionCostId
Additional production cost identifier
>{Integer}</AdditionalProductionCostId>Type
Additional production cost type
>{String}</Type>Name
Additional production cost name
>{String}</Name>CostTarget
Target of additional production cost
Possible domain values can be found here
>{String}</CostTarget>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>AdditionalProductionCostLink
Additional production cost identifier
>{String}</AdditionalProductionCostLink>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>ProductStructureOperationLink
Product structure operation reference
>{String}</ProductStructureOperationLink>ProductStructureAdditionalCostId
Product structure added cost identifier
": "{Integer}",Note
A note for product structure version's additional cost
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",CostBase
Specifies which added cost value this additional cost is calculated from
Possible domain values can be found here
": "{Integer}",AddedCostValue
Additional production cost value
": "{Decimal}",AdditionalProductionCostId
Additional production cost identifier
": "{Integer}",Type
Additional production cost type
": "{String}",Name
Additional production cost name
": "{String}",CostTarget
Target of additional production cost
Possible domain values can be found here
": "{String}",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}"AdditionalProductionCostLink
Additional production cost identifier
": "{String}"ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"ProductStructureOperationLink
Product structure operation 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 101529 HTTP 400 | Pick {0} quantity needs to be greater than 0 |
| Error 103016 HTTP 400 | Maximum number of decimals allowed for quantity is {0} |
| Error 101492 HTTP 400 | Illegal VAT code: VAT value > 0 is not allowed on this document |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |