Logistics APIs
Bank Balances and Movements - By Date & Bank
| Report name | Deliveries to stock |
| Report identifier | 107535 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/107535/result-set?view={view}&locationId={locno}&productId={it} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4880, version 24 |
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.
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.
| view String, optional |
Selection of documents to include
Default: STOCKANDBACKLOG |
| locationId Integer, optional |
Location identifier
Minimum: 10000 |
| productId Integer, optional |
Product identifier
Minimum: 10000 |
| $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.
| AvailableQuantity Decimal | Quantity available/free for use. Not assigned to anything. |
| ConfirmedDate Date | Confirmed delivery date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| HeatNumber String | A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill. |
| ProductId Integer | Product identifier. |
| ProductionLot String | The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch. |
| ProductName String | Name of the product. |
| ProductRevision String | Revision number. |
| Quantity Decimal | Item quantity. |
| RequestedDate Date | The delivery date as requested by the buyer/purchaser. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ReservedQuantity Decimal | Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.. |
| Status Integer | Status of the Supplier item. |
| StockedDate Date | Stocked Date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| StockQuantity Decimal | Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production. |
| SupplierId Integer | RamBase supplier identifier. |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
Read more about filters and sorting on how to use sortable parameters
| AvailableQuantity Decimal | Quantity available/free for use. Not assigned to anything. |
| ConfirmedDate Date | Confirmed delivery date |
| HeatNumber String | A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill. |
| ProductId Integer | Product identifier |
| ProductionLot String | The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch. |
| ProductName String | Name of the product |
| ProductRevision String | Revision number |
| Quantity Decimal | Item quantity. |
| RequestedDate Date | The delivery date as requested by the buyer/purchaser |
| ReservedQuantity Decimal | Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released. |
| Status Integer | Status of the Supplier item |
| StockedDate Date | Stocked Date |
| StockQuantity Decimal | Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production. |
| SupplierId Integer | RamBase supplier identifier |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
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.
Status
Status of the Supplier item
>{Integer}</Status>Location
Location reference
>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>SupplierItem
Identifier of the SupplierItem
>ItemId
Item-number of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>Supplier
Supplier reference
>SupplierId
RamBase supplier identifier
>{String}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
API reference to the item
>{String}</SupplierLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>ProductRevision
The Revision of the product
>Revision
Revision number
>{String}</Revision>ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
>{String}</ProductionLot>HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
>{String}</HeatNumber>StockedDate
Stocked Date
>{Date}</StockedDate>RequestedDate
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDate>ConfirmedDate
Confirmed delivery date
>{Date}</ConfirmedDate>Quantity
Item quantity.
>{Decimal}</Quantity>RemainingQuantity
Remaining Quantity
>{Decimal}</RemainingQuantity>StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
>{Decimal}</StockQuantity>AssignedQuantity
Assigned Quantity
>{Decimal}</AssignedQuantity>BlockedQuantity
Blocked Quantity
>{Decimal}</BlockedQuantity>ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
>{Decimal}</ReservedQuantity>AvailableQuantity
Quantity available/free for use. Not assigned to anything.
>{Decimal}</AvailableQuantity>PickedToProduction
Quantity picked
>{Decimal}</PickedToProduction>GrossPrice
Gross price/{CUR}
>{Decimal}</GrossPrice>GrossAmount
Gross amount/{CUR}
>{Decimal}</GrossAmount>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Status
Status of the Supplier item
": "{Integer}",Location
Location reference
": {LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"SupplierItem
Identifier of the SupplierItem
": {ItemId
Item-number of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemLink
API reference to the item
": "{String}"Supplier
Supplier reference
": {SupplierId
RamBase supplier identifier
": "{String}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
API reference to the item
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"ProductRevision
The Revision of the product
": {Revision
Revision number
": "{String}"ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
": "{String}",HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
": "{String}",StockedDate
Stocked Date
": "{Date}",RequestedDate
The delivery date as requested by the buyer/purchaser
": "{Date}",ConfirmedDate
Confirmed delivery date
": "{Date}",Quantity
Item quantity.
": "{Decimal}",RemainingQuantity
Remaining Quantity
": "{Decimal}",StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
": "{Decimal}",AssignedQuantity
Assigned Quantity
": "{Decimal}",BlockedQuantity
Blocked Quantity
": "{Decimal}",ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
": "{Decimal}",AvailableQuantity
Quantity available/free for use. Not assigned to anything.
": "{Decimal}",PickedToProduction
Quantity picked
": "{Decimal}",GrossPrice
Gross price/{CUR}
": "{Decimal}",GrossAmount
Gross amount/{CUR}
": "{Decimal}",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 |