Procurement APIs
Add a new change item to the purhcase order change request
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/change-requests/{purchaseOrderChangeRequestId}/changes/{changeId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderChangeRequestId} |
Purchase order change request identifier
Integer, minimum 100000 |
| - URI parameter {changeId} |
Change identifier
Integer, minimum 1 |
| Successful HTTP status code | 201 |
| API resource identifier | 3093, version 8 |
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.
LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Minimum value: 1
This field is optional.
>{Integer}</LineNumber>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
This field is optional.
>{Date}</RequestedDeliveryDate>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
This field is optional.
>{String}</ProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>Quantity
Required/mandatory field
Quantity of the purchase order change requeste item
>{Decimal}</Quantity>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Minimum value: 1
This field is optional.
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
This field is optional.
": "{Date}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
": "{String}",ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
This field is optional.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
": "{String}",Quantity
Required/mandatory field
Quantity of the purchase order change requeste item
": "{Decimal}",Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{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.
PurchaseOrderChangeRequestItemId
Purchase order change request item identifier
>{Integer}</PurchaseOrderChangeRequestItemId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDeliveryDate>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</ProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Quantity
Quantity of the purchase order change requeste item
>{Decimal}</Quantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductLink
Product reference
>{String}</ProductLink>PurchaseOrderResponseItemId
Item-/linenumber of purchase order response
>{Integer}</PurchaseOrderResponseItemId>PurchaseOrderResponseId
Purchase order response identifier
>{Integer}</PurchaseOrderResponseId>PurchaseOrderResponseLink
Purchase order response reference
>{String}</PurchaseOrderResponseLink>PurchaseOrderResponseItemLink
Purchase order response item reference
>{String}</PurchaseOrderResponseItemLink>PurchaseOrderChangeRequestItemId
Purchase order change request item identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
": "{Date}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
": "{String}",ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Quantity
Quantity of the purchase order change requeste item
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductLink
Product reference
": "{String}"PurchaseOrderResponseItemId
Item-/linenumber of purchase order response
": "{Integer}",PurchaseOrderResponseId
Purchase order response identifier
": "{Integer}",PurchaseOrderResponseLink
Purchase order response reference
": "{String}"PurchaseOrderResponseItemLink
Purchase order response 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 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 103825 HTTP 400 | Requested change line for cancellation has to be for the whole quantity of the current item |