Sales APIs

GET system/reports/118824/result-set

Customer backlog by item

Report name	Customer backlog by item
Report identifier	118824
HTTP method	GET
URI	https://api.rambase.net/system/reports/118824/result-set
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	7270, version 10

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.

ConvertedGrossPrice Decimal	Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal	Total net amount in company currency.
Currency String	Three character code following the ISO 4217 standard.
CustomerFirstName String	Secondary name of a company or firstname of a person.
CustomerId Integer	Customer identifier.
CustomerName String	Name of customer (name of company or surname/familyname/lastname of a person).
Date Date	Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
GrossPrice Decimal	Represents the price per unit before any discounting is applied.
ItemId Integer	Sales order item identifier.
Manufacturer String	Manufacturer of the product.
ManufacturerId Integer	Manufacturer identifier.
NetAmount Decimal	Final item amount after deducting all discounts etc.
ObjectId Integer	Identifier of the object.
ObjectType String	Type of object.
ProductDescription String	Description of the product.
ProductId Integer	Product identifier.
ProductName String	Name of the product.
ProductType String	Type of 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 be forwarded.
ShippingDate Date	The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer	Status of backlog item.

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

ConvertedGrossPrice Decimal	Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal	Total net amount in company currency.
Currency String	Three character code following the ISO 4217 standard
CustomerFirstName String	Secondary name of a company or firstname of a person
CustomerId Integer	Customer identifier
CustomerName String	Name of customer (name of company or surname/familyname/lastname of a person)
Date Date	Date when the document was issued.
GrossPrice Decimal	Represents the price per unit before any discounting is applied.
ItemId Integer	Sales order item identifier
Manufacturer String	Manufacturer of the product
ManufacturerId Integer	Manufacturer identifier
NetAmount Decimal	Final item amount after deducting all discounts etc.
ObjectId Integer	Identifier of the object
ObjectType String	Type of object
ProductDescription String	Description of the product
ProductId Integer	Product identifier
ProductName String	Name of the product
ProductType String	Type of product
RegistrationDate Date	Date of registration
RemainingQuantity Decimal	Remaining number of units to be forwarded.
ShippingDate Date	The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)
Status Integer	Status of backlog item

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

Possible domain values can be found here

>{Integer}</Status>

<ItemId

ItemId

Sales order item identifier

>{Integer}</ItemId>

<ItemType

ItemType

Type of item

>{String}</ItemType>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<Object

Object

Object reference

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<RegistrationDate

RegistrationDate

Date of registration

>{Date}</RegistrationDate>

<ShippingDate

ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

>{Date}</ShippingDate>

<Customer

Customer

Customer reference

<CustomerId

CustomerId

Customer identifier

>{Integer}</CustomerId>

<Name

Name

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

>{String}</Name>

<FirstName

FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>

<CustomerLink

CustomerLink

Customer reference

>{String}</CustomerLink>

                                                            </Customer>
                                    

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                                       </Object>
                                    

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

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

<Type

Type

Type of product

Possible domain values can be found here

>{String}</Type>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<RemainingQuantity

RemainingQuantity

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>

<Price

Price

Price per unit

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<Discount

Discount

Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.

>{Decimal}</Discount>

<GrossPrice

GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>

<NetPrice

NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>

                                                       </Price>
                                    

<PriceConverted

PriceConverted

Price converted to local currency

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

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

>{String}</Currency>

<GrossPrice

GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>

<NetPrice

NetPrice

Final price per unit after deducting all discounts.

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

>{Decimal}</NetPrice>

                                                       </PriceConverted>
                                    

<Totals

Totals

Total amounts

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<RemainingAmount

RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>

<GrossAmount

GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>

<NetAmount

NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>

                                                       </Totals>
                                    

<TotalsConverted

TotalsConverted

Totals converted to local currency

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

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

>{String}</Currency>

<RemainingAmount

RemainingAmount

Total remaining amount in company currency.

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

>{Decimal}</RemainingAmount>

<GrossAmount

GrossAmount

Total gross amount in company currency.

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

>{Decimal}</GrossAmount>

<NetAmount

NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>

                                                       </TotalsConverted>
                                    

                                                       <Inspect>
                                    

<TargetApplication

TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>

<Filter

Filter

Filter used when inspecting a line in a report.

>{String}</Filter>

                                                       </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 backlog item

Possible domain values can be found here

": "{Integer}",

"itemId

ItemId

Sales order item identifier

": "{Integer}",

"itemType

ItemType

Type of item

": "{String}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"object

Object

Object reference

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"registrationDate

RegistrationDate

Date of registration

": "{Date}",

"shippingDate

ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

": "{Date}",

"customer

Customer

Customer reference

": {

"customerId

CustomerId

Customer identifier

": "{Integer}",

"name

Name

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

": "{String}",

"firstName

FirstName

Secondary name of a company or firstname of a person

": "{String}",

"customerLink

CustomerLink

Customer reference

": "{String}"

},

"objectLink

ObjectLink

API reference to the object

": "{String}"

},

"product

Product

Product reference

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"manufacturer

Manufacturer

Manufacturer reference

": {

"manufacturerId

ManufacturerId

Manufacturer identifier

": "{Integer}",

"shortName

ShortName

Shortname/code of the manufacturer

": "{String}",

"manufacturerLink

ManufacturerLink

Manufacturer reference

": "{String}"

},

"type

Type

Type of product

Possible domain values can be found here

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"remainingQuantity

RemainingQuantity

Remaining number of units to be forwarded.

": "{Decimal}",

"price

Price

Price per unit

": {

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"discount

Discount

Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.

": "{Decimal}",

"grossPrice

GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",

"netPrice

NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"

},

"priceConverted

PriceConverted

Price converted to local currency

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

": {

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

": "{String}",

"grossPrice

GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",

"netPrice

NetPrice

Final price per unit after deducting all discounts.

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

": "{Decimal}"

},

"totals

Totals

Total amounts

": {

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"remainingAmount

RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}",

"grossAmount

GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",

"netAmount

NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"

},

"totalsConverted

TotalsConverted

Totals converted to local currency

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

": {

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

": "{String}",

"remainingAmount

RemainingAmount

Total remaining amount in company currency.

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

": "{Decimal}",

"grossAmount

GrossAmount

Total gross amount in company currency.

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

": "{Decimal}",

"netAmount

NetAmount

Total net amount in company currency.

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

": "{Decimal}"

},

                                                            "inspect": {
                                    

"targetApplication

TargetApplication

Application reference when inspecting a line in a report.

": "{String}",

"filter

Filter

Filter used 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 100027 HTTP 400	Missing mandatory parameter {0}
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