Product APIs

GET system/reports/107845/result-set

Bank Balances and Movements - By Date & Bank

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

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.

AvailableStockQuantity Decimal	Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs.
CustomField1 String	Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String	Custom field for grouping, sorting, categorizing and other purposes.
CustomField3 String	Custom field for grouping, sorting, categorizing and other purposes.
Description String	Description of the product.
ManufacturerId Integer	Manufacturer identifier.
ManufacturersProductId Integer	Manufacturer product identifier.
ManufacturersProductName String	Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
ManufacturersShortName String	Shortname/code of the manufacturer.
Name String	Name of the product.
ProductId Integer	Product identifier.
Status Integer	Status of the product.
StockQuantity Decimal	Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.
Type String	Type of product.

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

AvailableStockQuantity Decimal	Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs
CustomField1 String	Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String	Custom field for grouping, sorting, categorizing and other purposes.
CustomField3 String	Custom field for grouping, sorting, categorizing and other purposes
Description String	Description of the product
ManufacturerId Integer	Manufacturer identifier
ManufacturersProductId Integer	Manufacturer product identifier
ManufacturersProductName String	Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
ManufacturersShortName String	Shortname/code of the manufacturer
Name String	Name of the product
ProductId Integer	Product identifier
Status Integer	Status of the product
StockQuantity Decimal	Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.
Type String	Type of product

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:

                                        <Report>
                                    

                                             <Rows>
                                    

                                                  <Row>
                                    

<Status

Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>

<ManufacturersProductReference

ManufacturersProductReference

Manufacturers product reference

<ManufacturersProductId

ManufacturersProductId

Manufacturer product identifier

>{Integer}</ManufacturersProductId>

<Name

Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

>{String}</Name>

                                                       </ManufacturersProductReference>
                                    

<Manufacturer

Manufacturer

Manufacturer reference

<ManufacturerId

ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>

<ShortName

ShortName

Shortname/code of the manufacturer

>{String}</ShortName>

<ManufacturerLink

ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>

                                                       </Manufacturer>
                                    

<Product

Product

Product reference

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

>{String}</Name>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<Type

Type

Type of product

Possible domain values can be found here

>{String}</Type>

<Description

Description

Description of the product

>{String}</Description>

<CustomField1

CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>

<CustomField2

CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>

<CustomField3

CustomField3

Custom field for grouping, sorting, categorizing and other purposes

>{String}</CustomField3>

<AvailableStockQuantity

AvailableStockQuantity

Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs

>{Decimal}</AvailableStockQuantity>

<StockQuantity

StockQuantity

Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.

>{Decimal}</StockQuantity>

                                                       <Inspect>
                                    

<TargetApplication

TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>

                                                       </Inspect>
                                    

                                                  </Row>
                                    

                                             </Rows>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

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

<FirstPage

FirstPage

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

>{String}</FirstPage>

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

<PreviousPage

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

>{String}</PreviousPage>

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

<NextPage

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

>{String}</NextPage>

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

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Report>
                                    

{

                                             "report": {
                                    

                                                  "rows": [
                                    

{

"status

Status

Status of the product

Possible domain values can be found here

": "{Integer}",

"manufacturersProductReference

ManufacturersProductReference

Manufacturers product reference

": {

"manufacturersProductId

ManufacturersProductId

Manufacturer product identifier

": "{Integer}",

"name

Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

": "{String}"

},

"manufacturer

Manufacturer

Manufacturer reference

": {

"manufacturerId

ManufacturerId

Manufacturer identifier

": "{Integer}",

"shortName

ShortName

Shortname/code of the manufacturer

": "{String}",

"manufacturerLink

ManufacturerLink

Manufacturer reference

": "{String}"

},

"product

Product

Product reference

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"type

Type

Type of product

Possible domain values can be found here

": "{String}",

"description

Description

Description of the product

": "{String}",

"customField1

CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",

"customField2

CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",

"customField3

CustomField3

Custom field for grouping, sorting, categorizing and other purposes

": "{String}",

"availableStockQuantity

AvailableStockQuantity

": "{Decimal}",

"stockQuantity

StockQuantity

": "{Decimal}",

                                                            "inspect": {
                                    

"targetApplication

TargetApplication

Application reference when inspecting a line in a report.

": "{String}"

}

}

]

}

}

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