API

Procurement APIs

GET procurement/change-requests/{purchaseOrderChangeRequestId}/changes

List of all changes of provided purchase order change request

HTTP method GET
URI https://api.rambase.net/procurement/change-requests/{purchaseOrderChangeRequestId}/changes
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderChangeRequestId} Purchase order change request identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3094, version 12

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
1

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.

$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ChangeId Integer Change identifier.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
Status Integer Status of the change.

Read more about filters and sorting on how to use sortable parameters

ChangeId Integer Change identifier
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
Status Integer Status of the change

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Changes>
2
     <Change>
3
          <ChangeId
ChangeId

Change identifier

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

Status of the change

Possible domain values can be found here

>{Integer}</Status>
5
          <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
6
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
          <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
8
          <HasItems
HasItems

True if this change has one or more items. The items describes the requested changes to current item, and if no items has been added, the change will not be sent to supplier.

This field is greyed out because it is an expandable field. You have to add $expand=Change.HasItems in your request URI to get this field

>{Boolean}</HasItems>
9
          <CurrentQuantity
CurrentQuantity

The remaining quantity of the purchase order or purchase order response item at the time this change request was created.

This field is greyed out because it is an expandable field. You have to add $expand=Change.CurrentQuantity in your request URI to get this field

>{Decimal}</CurrentQuantity>
10
          <CancelledQuantity
CancelledQuantity

The total cancelled quantity in this purchase order change request. Cannot be higher than the current quantity.

This field is greyed out because it is an expandable field. You have to add $expand=Change.CancelledQuantity in your request URI to get this field

>{Decimal}</CancelledQuantity>
11
          <CurrentItem>
12
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
13
               <ItemType
ItemType

Type of item

>{String}</ItemType>
14
               <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
15
               <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

>{Date}</RequestedDeliveryDate>
16
               <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

>{Date}</ConfirmedDeliveryDate>
17
               <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
18
               <SuppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

>{String}</SuppliersProductName>
19
               <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>{String}</EquivalentProductName>
20
               <ProductStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</ProductStructureRevision>
21
               <Price>
22
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
23
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
24
               </Price>
25
               <Product>
26
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Product reference

>{String}</ProductLink>
30
               </Product>
31
               <Object>
32
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
33
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
34
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
35
               </Object>
36
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
37
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
38
          </CurrentItem>
39
          <InitialPurchaseOrderItem>
40
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
41
               <SalesOrder>
42
                    <SalesOrderId
SalesOrderId

Purchase order identifier

>{Integer}</SalesOrderId>
43
                    <SalesOrderLink
SalesOrderLink

Purchase order reference

>{String}</SalesOrderLink>
44
               </SalesOrder>
45
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
46
               <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
47
          </InitialPurchaseOrderItem>
48
          <ForwardedTo>
49
               <PurchaseOrderResponseId
PurchaseOrderResponseId

Purchase order response identifier

>{Integer}</PurchaseOrderResponseId>
50
               <PurchaseOrderResponseLink
PurchaseOrderResponseLink

Purchase order response reference

>{String}</PurchaseOrderResponseLink>
51
          </ForwardedTo>
52
          <ChangeLink
ChangeLink

Purchase order change reference

>{String}</ChangeLink>
53
     </Change>
54
     <Paging
Paging

Detailed paging information for this list.

>
55
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
56
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
57
          <Page
Page

Page index

>{Integer}</Page>
58
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
59
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
60
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
61
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
62
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
63
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
64
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
65
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
66
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
67
     </Paging>
68
</Changes>
1
{
2
     "changes": [
3
          {
4
               "changeId
ChangeId

Change identifier

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

Status of the change

Possible domain values can be found here

": "{Integer}",
6
               "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

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

Date and time of creation

": "{Datetime}",
8
               "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

": "{String}",
9
               "hasItems
HasItems

True if this change has one or more items. The items describes the requested changes to current item, and if no items has been added, the change will not be sent to supplier.

This field is greyed out because it is an expandable field. You have to add $expand=Change.HasItems in your request URI to get this field

": "{Boolean}",
10
               "currentQuantity
CurrentQuantity

The remaining quantity of the purchase order or purchase order response item at the time this change request was created.

This field is greyed out because it is an expandable field. You have to add $expand=Change.CurrentQuantity in your request URI to get this field

": "{Decimal}",
11
               "cancelledQuantity
CancelledQuantity

The total cancelled quantity in this purchase order change request. Cannot be higher than the current quantity.

This field is greyed out because it is an expandable field. You have to add $expand=Change.CancelledQuantity in your request URI to get this field

": "{Decimal}",
12
               "currentItem": {
13
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
14
                    "itemType
ItemType

Type of item

": "{String}",
15
                    "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
16
                    "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

": "{Date}",
17
                    "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

": "{Date}",
18
                    "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

": "{String}",
19
                    "suppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

": "{String}",
20
                    "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

": "{String}",
21
                    "productStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}",
22
                    "price": {
23
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
24
                         "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
25
                    },
26
                    "product": {
27
                         "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Product reference

": "{String}"
31
                    },
32
                    "object": {
33
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
34
                         "objectType
ObjectType

Type of object

": "{String}",
35
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
36
                    },
37
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
38
                    "itemLink
ItemLink

API reference to the item

": "{String}"
39
               },
40
               "initialPurchaseOrderItem": {
41
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
42
                    "salesOrder": {
43
                         "salesOrderId
SalesOrderId

Purchase order identifier

": "{Integer}",
44
                         "salesOrderLink
SalesOrderLink

Purchase order reference

": "{String}"
45
                    },
46
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
47
                    "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
48
               },
49
               "forwardedTo": {
50
                    "purchaseOrderResponseId
PurchaseOrderResponseId

Purchase order response identifier

": "{Integer}",
51
                    "purchaseOrderResponseLink
PurchaseOrderResponseLink

Purchase order response reference

": "{String}"
52
               },
53
               "changeLink
ChangeLink

Purchase order change reference

": "{String}"
54
          }
55
     ],
56
     "paging
Paging

Detailed paging information for this list.

": {
57
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
58
          "position
Position

Position of the first element in the list

": "{Integer}",
59
          "page
Page

Page index

": "{Integer}",
60
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
61
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
62
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
63
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
64
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
65
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
66
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
67
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
68
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
69
     }
70
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101233 HTTP 404 Purchase order response item not found.