API

Production APIs

GET system/reports/117653/result-set

Production work orders (PWO) with planned, expected and accrued cost

Report name Production work orders with planned, expected and accrued cost
Report identifier 117653
HTTP method GET
URI https://api.rambase.net/system/reports/117653/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6973, version 4

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.

Location String Unique abbreviation/short name of the location.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemainingQuantity Decimal Remaining number of units to produce.
Status Integer Status of production work order.

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

Location String Unique abbreviation/short name of the location
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
RegistrationDate Date Date of registration
RemainingQuantity Decimal Remaining number of units to produce
Status Integer Status of production work order

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
               <Status
Status

Status of production work order

Possible domain values can be found here

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

Production work order reference

>
6
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
7
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
8
               </ProductionWorkOrder>
9
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
10
               <RemainingQuantity
RemainingQuantity

Remaining number of units to produce

>{Decimal}</RemainingQuantity>
11
               <Product
Product

Product reference

>
12
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

>{String}</Description>
15
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
16
                    <ProductLocation
ProductLocation

Product reference

>
17
                         <Location
Location

Product reference

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

>
18
                              <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
19
                              <Name
Name

Name of warehouse location

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

>{String}</Name>
20
                              <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
21
                              <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
22
                         </Location>
23
                         <ExpectedCost
ExpectedCost

Product reference

>
24
                              <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
25
                              <Cost
Cost

Expected cost of product for this location

>{Decimal}</Cost>
26
                         </ExpectedCost>
27
                         <ProductLocationLink
ProductLocationLink

Product location reference

>{String}</ProductLocationLink>
28
                    </ProductLocation>
29
               </Product>
30
               <ProductionCost
ProductionCost

Expected cost

>
31
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
32
                    <Planned
Planned

Production Work Order article price

>{Decimal}</Planned>
33
                    <Accrued
Accrued

Production accrued cost

>{Decimal}</Accrued>
34
               </ProductionCost>
35
               <SalesOrderItem
SalesOrderItem

Sales order item reference

>
36
                    <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Sales order reference

>
38
                         <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
39
                         <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
40
                         <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
41
                    </SalesOrder>
42
                    <Price
Price

Represents the price per unit before any discounting is applied.

>{Decimal}</Price>
43
                    <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
44
               </SalesOrderItem>
45
               <Inspect>
46
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
47
               </Inspect>
48
          </Row>
49
     </Rows>
50
     <Paging
Paging

Detailed paging information for this list.

>
51
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
54
          <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>
55
          <FirstPage
FirstPage

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

>{String}</FirstPage>
56
          <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>
57
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
58
          <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>
59
          <NextPage
NextPage

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

>{String}</NextPage>
60
          <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>
61
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
63
     </Paging>
64
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of production work order

Possible domain values can be found here

": "{Integer}",
6
                    "productionWorkOrder
ProductionWorkOrder

Production work order reference

": {
7
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
8
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
9
                    },
10
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
11
                    "remainingQuantity
RemainingQuantity

Remaining number of units to produce

": "{Decimal}",
12
                    "product
Product

Product reference

": {
13
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}",
17
                         "productLocation
ProductLocation

Product reference

": {
18
                              "location
Location

Product reference

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

": {
19
                                   "locationId
LocationId

Location identifier

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

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

Name of warehouse location

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

": "{String}",
21
                                   "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}",
22
                                   "locationLink
LocationLink

Location reference

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

": "{String}"
23
                              },
24
                              "expectedCost
ExpectedCost

Product reference

": {
25
                                   "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
26
                                   "cost
Cost

Expected cost of product for this location

": "{Decimal}"
27
                              },
28
                              "productLocationLink
ProductLocationLink

Product location reference

": "{String}"
29
                         }
30
                    },
31
                    "productionCost
ProductionCost

Expected cost

": {
32
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
33
                         "planned
Planned

Production Work Order article price

": "{Decimal}",
34
                         "accrued
Accrued

Production accrued cost

": "{Decimal}"
35
                    },
36
                    "salesOrderItem
SalesOrderItem

Sales order item reference

": {
37
                         "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Sales order reference

": {
39
                              "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
40
                              "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
41
                              "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
42
                         },
43
                         "price
Price

Represents the price per unit before any discounting is applied.

": "{Decimal}",
44
                         "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
45
                    },
46
                    "inspect": {
47
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
48
                    }
49
               }
50
          ]
51
     }
52
}

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
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