API

Procurement APIs

PUT procurement/change-requests/{purchaseOrderChangeRequestId}

Update details for provided purchase order change request

HTTP method PUT
URI https://api.rambase.net/procurement/change-requests/{purchaseOrderChangeRequestId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderChangeRequestId} Purchase order change request identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3085, 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
<PurchaseOrderChangeRequest
PurchaseOrderChangeRequest

This field is optional.

>
2
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

>
{String}</SuppliersReference>
3
     <SuppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

>
{String}</SuppliersReferenceNumber>
4
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>
{String}</Note>
5
     <Assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

>
6
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>
{Integer}</UserId>
7
     </Assignee>
8
</PurchaseOrderChangeRequest>
1
{
2
     "purchaseOrderChangeRequest
PurchaseOrderChangeRequest

This field is optional.

":
{
3
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

":
"{String}",
4
          "suppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

":
"{String}",
5
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

":
"{String}",
6
          "assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

":
{
7
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
8
          }
9
     }
10
}

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.

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. 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
1

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 100147 HTTP 404 Notification type not found
Error 101420 HTTP 404 Setting definition not found
Error 101376 HTTP 400 ShippingService is not active (status 4)
Error 101380 HTTP 400 Direction is required
Error 101375 HTTP 400 Direction of the Shipping Service mismatch with type of transaction document
Error 101399 HTTP 400 Customer account in shipping service mismatch with this customer account
Error 101377 HTTP 400 CountryCode of the document mismatch with CountryCode in Shipping Service
Error 101378 HTTP 400 Location in document mismatch with location in ShippingService
Error 101385 HTTP 400 The carrier that offers this shipping service is not activ (status 4)