Procurement APIs

GET system/reports/114300/result-set

Status: - 'Red' if there is 0 days or less between Conf(Req) and ZeroStockDate - 'Yellow' if there is less than 30 days between Conf(Req) and ZerostockDate - 'Blue' if there is 30 days or more between Conf(Req) and ZeroStockDate ZeroStockDate is date when inventory goes below ReOrderPoint.

Report name	Purchase backlog with Zero Stock Days
Report identifier	114300
HTTP method	GET
URI	https://api.rambase.net/system/reports/114300/result-set
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	6174, version 12

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.

ConfirmedDeliveryDate Date	Confirmed delivery date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ConvertedTotalAmount Decimal	Total gross amount in company currency.
Description String	Description of the product.
LocationShortName String	Unique abbreviation/short name of the location.
ProductId Integer	Product identifier.
ProductName String	Name of the product.
PurchaseGroupId Integer	Purchase group identifier.
PurchaseOrderId Integer	Purchase order identifier.
PurchaseOrderItemId Integer	Item-/line-number of the purchase order.
RequestedDeliveryDate Date	Confirmed delivery date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SupplierFirstname String	Firstname/givenname if the supplier is a person.
SupplierId Integer	RamBase supplier identifier.
SupplierItemStatus Integer	Status of the item/object.
SupplierName String	Name of supplier (name of company or surname/familyname/lastname of a person).
SupplierObjectId Integer	Identifier of the object.
SupplierObjectItemId Integer	Item-number of the object.
Type String	Type of product.

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

ConfirmedDeliveryDate Date	Confirmed delivery date
ConvertedTotalAmount Decimal	Total gross amount in company currency.
Description String	Description of the product
LocationShortName String	Unique abbreviation/short name of the location
ProductId Integer	Product identifier
ProductName String	Name of the product
PurchaseGroupId Integer	Purchase group identifier
PurchaseOrderId Integer	Purchase order identifier
PurchaseOrderItemId Integer	Item-/line-number of the purchase order
RequestedDeliveryDate Date	Confirmed delivery date
SupplierFirstname String	Firstname/givenname if the supplier is a person
SupplierId Integer	RamBase supplier identifier
SupplierItemStatus Integer	Status of the item/object.
SupplierName String	Name of supplier (name of company or surname/familyname/lastname of a person)
SupplierObjectId Integer	Identifier of the object
SupplierObjectItemId Integer	Item-number of the object
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>
                                    

<SupplierItem

SupplierItem

Identifier of the SupplierItem

<ItemId

ItemId

Item-number of the object

>{Integer}</ItemId>

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<Status

Status

Status of the item/object.

>{Integer}</Status>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

<ItemLink

ItemLink

API reference to the item

>{String}</ItemLink>

                                                       </SupplierItem>
                                    

<PurchaseOrderItem

PurchaseOrderItem

Purchase order item reference

<PurchaseOrderItemId

PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>

<PurchaseOrder

PurchaseOrder

Purchase order reference

<PurchaseOrderId

PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>

<RegistrationDate

RegistrationDate

Date of registration

>{Date}</RegistrationDate>

<PurchaseOrderLink

PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>

                                                            </PurchaseOrder>
                                    

<PurchaseOrderItemLink

PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>

                                                       </PurchaseOrderItem>
                                    

<Supplier

Supplier

Supplier reference

<SupplierId

SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>

<Name

Name

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

>{String}</Name>

<Firstname

Firstname

Firstname/givenname if the supplier is a person

>{String}</Firstname>

<SupplierLink

SupplierLink

Supplier reference

>{String}</SupplierLink>

                                                       </Supplier>
                                    

<Location

Location

Location reference

<LocationId

LocationId

Location identifier

>{Integer}</LocationId>

<Name

Name

Name of location

>{String}</Name>

<ShortName

ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                       </Location>
                                    

<Product

Product

Product reference

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<Type

Type

Type of product

Possible domain values can be found here

>{String}</Type>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<PurchaseGroup

PurchaseGroup

PurchaseGroup reference

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

<PurchaseGroupId

PurchaseGroupId

Purchase group identifier

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

>{Integer}</PurchaseGroupId>

<Name

Name

Name of purchase group

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

>{String}</Name>

<PurchaseGroupLink

PurchaseGroupLink

Purchase group reference

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

>{String}</PurchaseGroupLink>

                                                       </PurchaseGroup>
                                    

<RequestedDeliveryDate

RequestedDeliveryDate

Confirmed delivery date

>{Date}</RequestedDeliveryDate>

<ConfirmedDeliveryDate

ConfirmedDeliveryDate

Confirmed delivery date

>{Date}</ConfirmedDeliveryDate>

<TotalsConverted

TotalsConverted

Totals converted to local currency

<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.TotalsConverted.Currency in your request URI to get this field

>{String}</Currency>

<TotalAmount

TotalAmount

Total gross amount in company currency.

>{Decimal}</TotalAmount>

                                                       </TotalsConverted>
                                    

<ReorderPoint

ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

>{Decimal}</ReorderPoint>

<ReorderDate

ReorderDate

Date when inventory will reach, or go below, Reorder point.

>{Date}</ReorderDate>

<ReorderDays

ReorderDays

Number of days between ReOrder date and Confirmed delivery date (or Requested delivery date if Confirmed delivery date is not given)

>{Integer}</ReorderDays>

<ZeroStockDate

ZeroStockDate

Date when inventory will reach, or go below, zero.

>{Date}</ZeroStockDate>

<ZeroStockDays

ZeroStockDays

Number of days between Zero stock date and Confirmed delivery date (or Requested delivery date if Confirmed delivery date is not given)

>{Integer}</ZeroStockDays>

<Action

Action

Action code

>{String}</Action>

                                                       <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": [
                                    

{

"supplierItem

SupplierItem

Identifier of the SupplierItem

": {

"itemId

ItemId

Item-number of the object

": "{Integer}",

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"status

Status

Status of the item/object.

": "{Integer}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}",

"itemLink

ItemLink

API reference to the item

": "{String}"

},

"purchaseOrderItem

PurchaseOrderItem

Purchase order item reference

": {

"purchaseOrderItemId

PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",

"purchaseOrder

PurchaseOrder

Purchase order reference

": {

"purchaseOrderId

PurchaseOrderId

Purchase order identifier

": "{Integer}",

"registrationDate

RegistrationDate

Date of registration

": "{Date}",

"purchaseOrderLink

PurchaseOrderLink

Purchase order reference

": "{String}"

},

"purchaseOrderItemLink

PurchaseOrderItemLink

Purchase order item reference

": "{String}"

},

"supplier

Supplier

Supplier reference

": {

"supplierId

SupplierId

RamBase supplier identifier

": "{Integer}",

"name

Name

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

": "{String}",

"firstname

Firstname

Firstname/givenname if the supplier is a person

": "{String}",

"supplierLink

SupplierLink

Supplier reference

": "{String}"

},

"location

Location

Location reference

": {

"locationId

LocationId

Location identifier

": "{Integer}",

"name

Name

Name of location

": "{String}",

"shortName

ShortName

Unique abbreviation/short name of the location

": "{String}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"product

Product

Product reference

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"type

Type

Type of product

Possible domain values can be found here

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"purchaseGroup

PurchaseGroup

PurchaseGroup reference

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

": {

"purchaseGroupId

PurchaseGroupId

Purchase group identifier

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

": "{Integer}",

"name

Name

Name of purchase group

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

": "{String}",

"purchaseGroupLink

PurchaseGroupLink

Purchase group reference

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

": "{String}"

},

"requestedDeliveryDate

RequestedDeliveryDate

Confirmed delivery date

": "{Date}",

"confirmedDeliveryDate

ConfirmedDeliveryDate

Confirmed delivery date

": "{Date}",

"totalsConverted

TotalsConverted

Totals converted to local currency

": {

"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.TotalsConverted.Currency in your request URI to get this field

": "{String}",

"totalAmount

TotalAmount

Total gross amount in company currency.

": "{Decimal}"

},

"reorderPoint

ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

": "{Decimal}",

"reorderDate

ReorderDate

Date when inventory will reach, or go below, Reorder point.

": "{Date}",

"reorderDays

ReorderDays

Number of days between ReOrder date and Confirmed delivery date (or Requested delivery date if Confirmed delivery date is not given)

": "{Integer}",

"zeroStockDate

ZeroStockDate

Date when inventory will reach, or go below, zero.

": "{Date}",

"zeroStockDays

ZeroStockDays

Number of days between Zero stock date and Confirmed delivery date (or Requested delivery date if Confirmed delivery date is not given)

": "{Integer}",

"action

Action

Action code

": "{String}",

                                                            "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 101013 HTTP 404	Sub-module not found
Error 102018 HTTP 403	You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404	Setting definition not found
Error 100175 HTTP 400	To date must be equal to, or later than from date.
Error 105710 HTTP 400	Invalid output type