Logistics APIs

GET system/reports/114346/result-set?ShippingAdviceId={ShippingAdviceId}&GoodsReceptionId={GoodsReceptionId}

Will show Material cost by origin calculated for CSA-items - for CSA-item to show up in report, 'Recalculate' must have been run from the 'Third country cost'-option on the CSA-item.

Report name	Third country cost - material cost by origin
Report identifier	114346
HTTP method	GET
URI	https://api.rambase.net/system/reports/114346/result-set?ShippingAdviceId={ShippingAdviceId}&GoodsReceptionId={GoodsReceptionId}
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	6181, version 7

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.

ShippingAdviceId Integer, optional	Shipping advice reference Minimum: 1, Maximum: 99999999
GoodsReceptionId Integer, optional	Goods reception reference Minimum: 1, Maximum: 99999999
$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.

AssignmentQuantity Decimal	Quantity assigned.
ThirdCountryMaterialCost Decimal	Third country material cost.
TotalMaterialCost Decimal	Total materialcost.

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

AssignmentQuantity Decimal	Quantity assigned
ThirdCountryMaterialCost Decimal	Third country material cost
TotalMaterialCost Decimal	Total materialcost

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>
                                    

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

<CustomsTariff

CustomsTariff

Customs tariff identifier

<Domestic

Domestic

Domestic tariff identifier

<CustomsTariffId

CustomsTariffId

Customs tariff identifier

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

>{Integer}</CustomsTariffId>

<Code

Code

Customs tariff code

>{String}</Code>

<Description

Description

Description of customs tariff code

>{String}</Description>

<CustomsTariffLink

CustomsTariffLink

Customs tariff reference

>{String}</CustomsTariffLink>

                                                                 </Domestic>
                                    

<Eu

Eu

EU tariff identifier

<CustomsTariffId

CustomsTariffId

Customs tariff identifier

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

>{Integer}</CustomsTariffId>

<Code

Code

Customs tariff code

>{String}</Code>

<Description

Description

Description of customs tariff code

>{String}</Description>

<CustomsTariffLink

CustomsTariffLink

Customs tariff reference

>{String}</CustomsTariffLink>

                                                                 </Eu>
                                    

                                                            </CustomsTariff>
                                    

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<Assignment

Assignment

Assignment reference

<Quantity

Quantity

Quantity assigned

>{Decimal}</Quantity>

                                                       </Assignment>
                                    

<MaterialCost

MaterialCost

Material cost

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<Total

Total

Total materialcost

>{Decimal}</Total>

<ThirdCountry

ThirdCountry

Third country material cost

>{Decimal}</ThirdCountry>

                                                       </MaterialCost>
                                    

<ShippingAdviceItem

ShippingAdviceItem

Shipping advice item reference

<ShippingAdviceItemId

ShippingAdviceItemId

Shipping advice item reference

>{Integer}</ShippingAdviceItemId>

<ShippingAdvice

ShippingAdvice

Shipping advice reference

<ShippingAdviceId

ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>

<ShippingAdviceLink

ShippingAdviceLink

Shipping advice item reference

>{String}</ShippingAdviceLink>

                                                            </ShippingAdvice>
                                    

<ShippingAdviceItemLink

ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>

                                                       </ShippingAdviceItem>
                                    

<GoodsReceptionItem

GoodsReceptionItem

Goods reception item reference

<GoodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>

<GoodsReception

GoodsReception

Goods reception reference

<GoodsReceptionId

GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>

<GoodsReceptionLink

GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>

                                                            </GoodsReception>
                                    

<GoodsReceptionItemLink

GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>

                                                       </GoodsReceptionItem>
                                    

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

<Country

Country

Supplier country reference

<CountryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>

<Name

Name

English name of country.

>{String}</Name>

                                                            </Country>
                                    

<SupplierLink

SupplierLink

Supplier reference

>{String}</SupplierLink>

                                                       </Supplier>
                                    

<CountryOfOriginCode

CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>{String}</CountryOfOriginCode>

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

{

"product

Product

Product reference

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"customsTariff

CustomsTariff

Customs tariff identifier

": {

"domestic

Domestic

Domestic tariff identifier

": {

"customsTariffId

CustomsTariffId

Customs tariff identifier

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

": "{Integer}",

"code

Code

Customs tariff code

": "{String}",

"description

Description

Description of customs tariff code

": "{String}",

"customsTariffLink

CustomsTariffLink

Customs tariff reference

": "{String}"

},

"eu

Eu

EU tariff identifier

": {

"customsTariffId

CustomsTariffId

Customs tariff identifier

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

": "{Integer}",

"code

Code

Customs tariff code

": "{String}",

"description

Description

Description of customs tariff code

": "{String}",

"customsTariffLink

CustomsTariffLink

Customs tariff reference

": "{String}"

}

},

"productLink

ProductLink

Product reference

": "{String}"

},

"assignment

Assignment

Assignment reference

": {

"quantity

Quantity

Quantity assigned

": "{Decimal}"

},

"materialCost

MaterialCost

Material cost

": {

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"total

Total

Total materialcost

": "{Decimal}",

"thirdCountry

ThirdCountry

Third country material cost

": "{Decimal}"

},

"shippingAdviceItem

ShippingAdviceItem

Shipping advice item reference

": {

"shippingAdviceItemId

ShippingAdviceItemId

Shipping advice item reference

": "{Integer}",

"shippingAdvice

ShippingAdvice

Shipping advice reference

": {

"shippingAdviceId

ShippingAdviceId

Shipping advice identifier

": "{Integer}",

"shippingAdviceLink

ShippingAdviceLink

Shipping advice item reference

": "{String}"

},

"shippingAdviceItemLink

ShippingAdviceItemLink

Shipping advice item reference

": "{String}"

},

"goodsReceptionItem

GoodsReceptionItem

Goods reception item reference

": {

"goodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",

"goodsReception

GoodsReception

Goods reception reference

": {

"goodsReceptionId

GoodsReceptionId

Goods reception identifier

": "{Integer}",

"goodsReceptionLink

GoodsReceptionLink

Goods reception reference

": "{String}"

},

"goodsReceptionItemLink

GoodsReceptionItemLink

Goods reception 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}",

"country

Country

Supplier country reference

": {

"countryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",

"name

Name

English name of country.

": "{String}"

},

"supplierLink

SupplierLink

Supplier reference

": "{String}"

},

"countryOfOriginCode

CountryOfOriginCode

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