API

Sales APIs

GET sales/order-change-requests

List of sales order change requests

HTTP method GET
URI https://api.rambase.net/sales/order-change-requests
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 612, version 17

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.

Active() Named filter Active sales order change requests. Sales order change request registered, but not processed.
MyChangeRequests() Named filter Sales order change requests the current user is either assigned to, sales assistant for or account manager for.
MyOpenChangeRequests() Named filter Sales order change requests not processed where current user is either assigned to, sales assistant for og account manager for.
OpenChangeRequests() Named filter Sales order change requests not processed
PendingRegistration() Named filter Sales order change requests that are not yet registered
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser()
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ChangedSalesOrderId Docref-noitm Sales order identifier.
ChangedSalesOrderItemId Integer Sales order item identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
FirstName String Secondary name of a company or firstname of a person.
Name String Name of customer (name of company or surname/familyname/lastname of a person).
SalesAssistant Integer Reference to the employee who is sales assistant for the customer. Available macros: currentUser()
SalesOrderChangeRequestId Integer Sales order change request identifier.
Status Integer Status of sales order change request.

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

AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer.
Assignee Integer The user who has been assigned to work with this object.
ChangedSalesOrderId Docref-noitm Sales order identifier
ChangedSalesOrderItemId Integer Sales order item identifier
CreatedAt Datetime Date and time of creation
CustomerId Integer Customer identifier
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
FirstName String Secondary name of a company or firstname of a person
Name String Name of customer (name of company or surname/familyname/lastname of a person)
SalesAssistant Integer Reference to the employee who is sales assistant for the customer.
SalesOrderChangeRequestId Integer Sales order change request identifier
Status Integer Status of sales order change request

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
<SalesOrderChangeRequests>
2
     <SalesOrderChangeRequest>
3
          <SalesOrderChangeRequestId
SalesOrderChangeRequestId

Sales order change request identifier

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

Status of sales order change request

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
6
          <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
7
          <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
8
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
9
          <ChangedSalesOrderItem
ChangedSalesOrderItem

The sales order item beeing requested for change

>
10
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
11
               <SalesOrder>
12
                    <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
14
               </SalesOrder>
15
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
16
          </ChangedSalesOrderItem>
17
          <ForwardedToSalesOrder>
18
               <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
20
          </ForwardedToSalesOrder>
21
          <Assignee
Assignee

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

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

>
22
               <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
26
          </Assignee>
27
          <Customer>
28
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
29
               <Name
Name

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

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
31
               <Sales>
32
                    <AccountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

>
33
                         <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
34
                         <LastName
LastName

Last name of employee

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

>{String}</LastName>
35
                         <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
36
                         <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
37
                    </AccountManager>
38
               </Sales>
39
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
40
          </Customer>
41
          <SalesOrderChangeRequestLink
SalesOrderChangeRequestLink

Sales order change request reference

>{String}</SalesOrderChangeRequestLink>
42
     </SalesOrderChangeRequest>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
47
          <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>
48
          <FirstPage
FirstPage

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

>{String}</FirstPage>
49
          <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>
50
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
51
          <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>
52
          <NextPage
NextPage

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

>{String}</NextPage>
53
          <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>
54
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
56
     </Paging>
57
</SalesOrderChangeRequests>
1
{
2
     "salesOrderChangeRequests": [
3
          {
4
               "salesOrderChangeRequestId
SalesOrderChangeRequestId

Sales order change request identifier

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

Status of sales order change request

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
7
               "registrationDate
RegistrationDate

Date of registration

": "{Date}",
8
               "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
9
               "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
10
               "changedSalesOrderItem
ChangedSalesOrderItem

The sales order item beeing requested for change

": {
11
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
12
                    "salesOrder": {
13
                         "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
15
                    },
16
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
17
               },
18
               "forwardedToSalesOrder": {
19
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
21
               },
22
               "assignee
Assignee

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

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

": {
23
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
27
               },
28
               "customer": {
29
                    "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
32
                    "sales": {
33
                         "accountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

": {
34
                              "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
35
                              "lastName
LastName

Last name of employee

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

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

First name of employee

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

": "{String}",
37
                              "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
38
                         }
39
                    },
40
                    "customerLink
CustomerLink

Customer reference

": "{String}"
41
               },
42
               "salesOrderChangeRequestLink
SalesOrderChangeRequestLink

Sales order change request reference

": "{String}"
43
          }
44
     ],
45
     "paging
Paging

Detailed paging information for this list.

": {
46
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
49
          "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}",
50
          "firstPage
FirstPage

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

": "{String}",
51
          "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}",
52
          "previousPage
PreviousPage

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

": "{String}",
53
          "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}",
54
          "nextPage
NextPage

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

": "{String}",
55
          "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}",
56
          "lastPage
LastPage

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

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

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

": "{Integer}"
58
     }
59
}

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 101814 HTTP 404 Employee not found