API

Sales APIs

GET system/reports/116283/result-set

Sales order items with dimensions

Report name Sales order items with dimensions
Report identifier 116283
HTTP method GET
URI https://api.rambase.net/system/reports/116283/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6669, 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
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.

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

AssetId Integer Asset identifier.
CustomDimension10Value String Description of dimension.
CustomDimension4Value String Description of dimension.
CustomDimension5Value String Description of dimension.
CustomDimension6Value String Description of dimension.
CustomDimension7Value String Description of dimension.
CustomDimension8Value String Description of dimension.
CustomDimension9Value String Description of dimension.
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.

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

AssetId Integer Asset identifier
CustomDimension10Value String Description of dimension
CustomDimension4Value String Description of dimension
CustomDimension5Value String Description of dimension
CustomDimension6Value String Description of dimension
CustomDimension7Value String Description of dimension
CustomDimension8Value String Description of dimension
CustomDimension9Value String Description of dimension
DepartmentId Integer Department identifier
FinanceProjectId Integer Finance project identifier
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier

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
<Report>
2
     <Rows>
3
          <Row>
4
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
5
               <SalesOrder
SalesOrder

Sales order reference

>
6
                    <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
8
               </SalesOrder>
9
               <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

>
10
                    <Department
Department

The department related to the item. One of the system/fixed account dimensions.

>
11
                         <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
12
                         <Name
Name

Name of department

>{String}</Name>
13
                         <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
14
                    </Department>
15
                    <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
16
                         <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
17
                         <Name
Name

Name of finance project

>{String}</Name>
18
                         <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
19
                    </FinanceProject>
20
                    <Asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

>
21
                         <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
22
                         <Name
Name

Name of asset

>{String}</Name>
23
                         <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
24
                    </Asset>
25
                    <CustomDimension4
CustomDimension4

{CUS4DESCR}

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

>
26
                         <Value
Value

Description of dimension

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

>{String}</Value>
27
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
28
                    </CustomDimension4>
29
                    <CustomDimension5
CustomDimension5

{CUS5DESCR}

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

>
30
                         <Value
Value

Description of dimension

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

>{String}</Value>
31
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
32
                    </CustomDimension5>
33
                    <CustomDimension6
CustomDimension6

{CUS6DESCR}

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

>
34
                         <Value
Value

Description of dimension

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

>{String}</Value>
35
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
36
                    </CustomDimension6>
37
                    <CustomDimension7
CustomDimension7

{CUS7DESCR}

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

>
38
                         <Value
Value

Description of dimension

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

>{String}</Value>
39
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
40
                    </CustomDimension7>
41
                    <CustomDimension8
CustomDimension8

{CUS8DESCR}

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

>
42
                         <Value
Value

Description of dimension

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

>{String}</Value>
43
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
44
                    </CustomDimension8>
45
                    <CustomDimension9
CustomDimension9

{CUS9DESCR}

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

>
46
                         <Value
Value

Description of dimension

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

>{String}</Value>
47
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
48
                    </CustomDimension9>
49
                    <CustomDimension10
CustomDimension10

{CUS10DESCR}

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

>
50
                         <Value
Value

Description of dimension

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

>{String}</Value>
51
                         <Description
Description

Description of a dimension value

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

>{String}</Description>
52
                    </CustomDimension10>
53
               </Accounting>
54
               <Inspect>
55
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
56
               </Inspect>
57
          </Row>
58
     </Rows>
59
     <ColumnParameters
ColumnParameters

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

>
60
          <ColumnParameter
ColumnParameter

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

>
61
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>
62
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>
63
          </ColumnParameter>
64
     </ColumnParameters>
65
     <Paging
Paging

Detailed paging information for this list.

>
66
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
69
          <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>
70
          <FirstPage
FirstPage

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

>{String}</FirstPage>
71
          <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>
72
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
73
          <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>
74
          <NextPage
NextPage

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

>{String}</NextPage>
75
          <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>
76
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
78
     </Paging>
79
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
6
                    "salesOrder
SalesOrder

Sales order reference

": {
7
                         "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
9
                    },
10
                    "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

": {
11
                         "department
Department

The department related to the item. One of the system/fixed account dimensions.

": {
12
                              "departmentId
DepartmentId

Department identifier

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

Name of department

": "{String}",
14
                              "departmentLink
DepartmentLink

Finance department reference

": "{String}"
15
                         },
16
                         "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
17
                              "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

": "{String}",
19
                              "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
20
                         },
21
                         "asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

": {
22
                              "assetId
AssetId

Asset identifier

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

Name of asset

": "{String}",
24
                              "assetLink
AssetLink

Asset reference

": "{String}"
25
                         },
26
                         "customDimension4
CustomDimension4

{CUS4DESCR}

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

": {
27
                              "value
Value

Description of dimension

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

": "{String}",
28
                              "description
Description

Description of a dimension value

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

": "{String}"
29
                         },
30
                         "customDimension5
CustomDimension5

{CUS5DESCR}

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

": {
31
                              "value
Value

Description of dimension

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

": "{String}",
32
                              "description
Description

Description of a dimension value

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

": "{String}"
33
                         },
34
                         "customDimension6
CustomDimension6

{CUS6DESCR}

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

": {
35
                              "value
Value

Description of dimension

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

": "{String}",
36
                              "description
Description

Description of a dimension value

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

": "{String}"
37
                         },
38
                         "customDimension7
CustomDimension7

{CUS7DESCR}

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

": {
39
                              "value
Value

Description of dimension

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

": "{String}",
40
                              "description
Description

Description of a dimension value

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

": "{String}"
41
                         },
42
                         "customDimension8
CustomDimension8

{CUS8DESCR}

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

": {
43
                              "value
Value

Description of dimension

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

": "{String}",
44
                              "description
Description

Description of a dimension value

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

": "{String}"
45
                         },
46
                         "customDimension9
CustomDimension9

{CUS9DESCR}

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

": {
47
                              "value
Value

Description of dimension

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

": "{String}",
48
                              "description
Description

Description of a dimension value

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

": "{String}"
49
                         },
50
                         "customDimension10
CustomDimension10

{CUS10DESCR}

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

": {
51
                              "value
Value

Description of dimension

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

": "{String}",
52
                              "description
Description

Description of a dimension value

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

": "{String}"
53
                         }
54
                    },
55
                    "inspect": {
56
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
57
                    }
58
               }
59
          ],
60
          "columnParameters
ColumnParameters

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

": [
61
               {
62
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",
63
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

": "{String}"
64
               }
65
          ]
66
     }
67
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type