API

Procurement APIs

GET procurement/change-requests/{purchaseOrderChangeRequestId}

Purchase order change request details for provided identifier

HTTP method GET
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 593, version 15

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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
<PurchaseOrderChangeRequest>
2
     <PurchaseOrderChangeRequestId
PurchaseOrderChangeRequestId

Purchase order change request identifier

>{Integer}</PurchaseOrderChangeRequestId>
3
     <Status
Status

Status of purchase order change request

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

>{String}</SuppliersReferenceNumber>
7
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
8
     <Type
Type

Type of purchase order change request

Possible domain values can be found here

>{String}</Type>
9
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
10
     <Note
Note

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

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

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

>
12
          <UserId
UserId

User identifier

>{Integer}</UserId>
13
          <Name
Name

Name of the user

>{String}</Name>
14
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
15
          <UserLink
UserLink

User reference

>{String}</UserLink>
16
     </Assignee>
17
     <CreatedFor>
18
          <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
20
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
21
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
22
     </CreatedFor>
23
     <Supplier>
24
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
25
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
26
          <Purchase
Purchase

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

>
27
               <ConfirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

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

>{Integer}</ConfirmedDeliveryDateBuffer>
28
          </Purchase>
29
          <Invoicing
Invoicing

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

>
30
               <DefaultInvoiceAddress
DefaultInvoiceAddress

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

>
31
                    <Attention
Attention

Attention note.

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

>{String}</Attention>
32
                    <AddressLine1
AddressLine1

First address line

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

>{String}</AddressLine1>
33
                    <AddressLine2
AddressLine2

Second address line

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

>{String}</AddressLine2>
34
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

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

>{String}</PostalCode>
35
                    <City
City

City/town/village

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

>{String}</City>
36
                    <Region
Region

Region/province/state

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

>{String}</Region>
37
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

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

>{String}</CountryCode>
38
                    <Country
Country

English name of country.

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

>{String}</Country>
39
               </DefaultInvoiceAddress>
40
          </Invoicing>
41
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
42
     </Supplier>
43
</PurchaseOrderChangeRequest>
1
{
2
     "purchaseOrderChangeRequest": {
3
          "purchaseOrderChangeRequestId
PurchaseOrderChangeRequestId

Purchase order change request identifier

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

Status of purchase order change request

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

": "{String}",
8
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "type
Type

Type of purchase order change request

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

": {
13
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
15
               "firstName
FirstName

First name of the user

": "{String}",
16
               "userLink
UserLink

User reference

": "{String}"
17
          },
18
          "createdFor": {
19
               "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
21
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
23
          },
24
          "supplier": {
25
               "supplierId
SupplierId

RamBase supplier identifier

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

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
27
               "purchase
Purchase

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

": {
28
                    "confirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

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

": "{Integer}"
29
               },
30
               "invoicing
Invoicing

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

": {
31
                    "defaultInvoiceAddress
DefaultInvoiceAddress

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

": {
32
                         "attention
Attention

Attention note.

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

": "{String}",
33
                         "addressLine1
AddressLine1

First address line

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

": "{String}",
34
                         "addressLine2
AddressLine2

Second address line

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

": "{String}",
35
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

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

": "{String}",
36
                         "city
City

City/town/village

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

": "{String}",
37
                         "region
Region

Region/province/state

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

": "{String}",
38
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

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

": "{String}",
39
                         "country
Country

English name of country.

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

": "{String}"
40
                    }
41
               },
42
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
43
          }
44
     }
45
}

Possible error codes the response might return:

Error 101304 HTTP 404 Carrier not found
Error 100053 HTTP 403 You have only admittance to your own suppliers