API

Logistics APIs

GET logistics/stock-adjustments/{stockAdjustmentId}

Stock adjustment details for provided identifier

HTTP method GET
URI https://api.rambase.net/logistics/stock-adjustments/{stockAdjustmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockAdjustmentId} Stock correction identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 625, version 22

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

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

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

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:
1
<StockAdjustment>
2
     <StockAdjustmentId
StockAdjustmentId

Stock correction identifier

>{Integer}</StockAdjustmentId>
3
     <Status
Status

Status of stock correction

Possible domain values can be found here

>{Integer}</Status>
4
     <Type
Type

Type of stock correction

Possible domain values can be found here

>{Integer}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
7
     <Quantity
Quantity

The quantity the stock has been (or will be) corrected by. Note that a negative quantity means that the stock will be adjusted up.

>{Decimal}</Quantity>
8
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
9
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
10
     <PartChangeInProductionCausedBy
PartChangeInProductionCausedBy

Details of what caused the part change in production.

Possible domain values can be found here

>{String}</PartChangeInProductionCausedBy>
11
     <Reason
Reason

Reason for stock correction

Possible domain values can be found here

>{Integer}</Reason>
12
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
13
          <UserId
UserId

User identifier

>{Integer}</UserId>
14
          <Name
Name

Name of the user

>{String}</Name>
15
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
16
          <UserLink
UserLink

User reference

>{String}</UserLink>
17
     </Assignee>
18
     <StockLocation
StockLocation

The stock location beeing adjusted

>
19
          <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
20
          <Name
Name

Name of stock location

>{String}</Name>
21
          <Label
Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>
22
          <Location>
23
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
24
               <Name
Name

Name of location

>{String}</Name>
25
               <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
26
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
27
          </Location>
28
          <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
29
     </StockLocation>
30
     <StockTaking>
31
          <StockTakingId
StockTakingId

Stock taking identifier

>{Integer}</StockTakingId>
32
          <Status
Status

Status of stock taking

Possible domain values can be found here

>{Integer}</Status>
33
          <Name
Name

Name of stock taking

>{String}</Name>
34
          <Type
Type

Type of stock taking

Possible domain values can be found here

>{String}</Type>
35
          <StockTakingLink
StockTakingLink

Stock taking reference

>{String}</StockTakingLink>
36
     </StockTaking>
37
     <GoodsReceptionItem>
38
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
39
          <ProductDescription
ProductDescription

Product description. Copied from product.

>{String}</ProductDescription>
40
          <MeasurementUnit>
41
               <MeasurementUnitId
MeasurementUnitId

Material unit reference

>{Integer}</MeasurementUnitId>
42
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
43
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
44
          </MeasurementUnit>
45
          <Product>
46
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
47
               <Name
Name

Name of the product

>{String}</Name>
48
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
49
               <Description
Description

Description of the item. If not specified, the description is by default copied from the product.

>{String}</Description>
50
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
51
          </Product>
52
          <Manufacturer>
53
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
54
               <Name
Name

Company name of the manufacturer.

This field is greyed out because it is an expandable field. You have to add $expand=GoodsReceptionItem.Manufacturer.Name in your request URI to get this field

>{String}</Name>
55
               <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
56
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
57
          </Manufacturer>
58
          <ManufacturersProduct
ManufacturersProduct

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

>
59
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
60
               <Name
Name

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

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

>{String}</Name>
61
               <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
62
          </ManufacturersProduct>
63
          <Price>
64
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
65
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
66
          </Price>
67
          <PriceConverted
PriceConverted

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

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

>{String}</Currency>
69
               <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=GoodsReceptionItem.PriceConverted in your request URI to get this field

>{Decimal}</NetPrice>
70
          </PriceConverted>
71
          <GoodsReception>
72
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
73
               <Supplier
Supplier

The supplier related to the stock correction

>
74
                    <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
75
                    <Name
Name

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

>{String}</Name>
76
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
77
               </Supplier>
78
               <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
79
          </GoodsReception>
80
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
81
     </GoodsReceptionItem>
82
     <Totals>
83
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
84
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
85
     </Totals>
86
     <TotalsConverted
TotalsConverted

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

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

>{String}</Currency>
88
          <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
89
     </TotalsConverted>
90
     <StockAccrual
StockAccrual

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

>
91
          <StockAccrualId
StockAccrualId

Stock accrual identifier

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

>{Integer}</StockAccrualId>
92
          <Status
Status

Status of stock accrual

Possible domain values can be found here

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

>{Integer}</Status>
93
          <StockAccrualLink
StockAccrualLink

Stock accrual reference

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

>{String}</StockAccrualLink>
94
     </StockAccrual>
95
     <HighlightedNotification
HighlightedNotification

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

>
96
          <NotificationId
NotificationId

Notification identifier

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

>{Integer}</NotificationId>
97
          <Status
Status

Status of the notification

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

>{Integer}</Status>
98
          <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
99
          <Message
Message

The message from the notification definition, expanded with parameters.

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

>{String}</Message>
100
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

>{String}</TranslatedMessage>
101
          <NotificationType
NotificationType

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

>
102
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
103
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

>{String}</Category>
104
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

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

>{String}</NotificationTypeLink>
105
          </NotificationType>
106
          <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
107
     </HighlightedNotification>
108
</StockAdjustment>
1
{
2
     "stockAdjustment": {
3
          "stockAdjustmentId
StockAdjustmentId

Stock correction identifier

": "{Integer}",
4
          "status
Status

Status of stock correction

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of stock correction

Possible domain values can be found here

": "{Integer}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
8
          "quantity
Quantity

The quantity the stock has been (or will be) corrected by. Note that a negative quantity means that the stock will be adjusted up.

": "{Decimal}",
9
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
10
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
11
          "partChangeInProductionCausedBy
PartChangeInProductionCausedBy

Details of what caused the part change in production.

Possible domain values can be found here

": "{String}",
12
          "reason
Reason

Reason for stock correction

Possible domain values can be found here

": "{Integer}",
13
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
14
               "userId
UserId

User identifier

": "{Integer}",
15
               "name
Name

Name of the user

": "{String}",
16
               "firstName
FirstName

First name of the user

": "{String}",
17
               "userLink
UserLink

User reference

": "{String}"
18
          },
19
          "stockLocation
StockLocation

The stock location beeing adjusted

": {
20
               "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
21
               "name
Name

Name of stock location

": "{String}",
22
               "label
Label

Name of current- and parent stock locations, including seperator for location

": "{String}",
23
               "location": {
24
                    "locationId
LocationId

Location identifier

": "{Integer}",
25
                    "name
Name

Name of location

": "{String}",
26
                    "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
27
                    "locationLink
LocationLink

Location reference

": "{String}"
28
               },
29
               "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
30
          },
31
          "stockTaking": {
32
               "stockTakingId
StockTakingId

Stock taking identifier

": "{Integer}",
33
               "status
Status

Status of stock taking

Possible domain values can be found here

": "{Integer}",
34
               "name
Name

Name of stock taking

": "{String}",
35
               "type
Type

Type of stock taking

Possible domain values can be found here

": "{String}",
36
               "stockTakingLink
StockTakingLink

Stock taking reference

": "{String}"
37
          },
38
          "goodsReceptionItem": {
39
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
40
               "productDescription
ProductDescription

Product description. Copied from product.

": "{String}",
41
               "measurementUnit": {
42
                    "measurementUnitId
MeasurementUnitId

Material unit reference

": "{Integer}",
43
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
44
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
45
               },
46
               "product": {
47
                    "productId
ProductId

Product identifier

": "{Integer}",
48
                    "name
Name

Name of the product

": "{String}",
49
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
50
                    "description
Description

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
51
                    "productLink
ProductLink

Product reference

": "{String}"
52
               },
53
               "manufacturer": {
54
                    "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
55
                    "name
Name

Company name of the manufacturer.

This field is greyed out because it is an expandable field. You have to add $expand=GoodsReceptionItem.Manufacturer.Name in your request URI to get this field

": "{String}",
56
                    "shortName
ShortName

Shortname/code of the manufacturer

": "{String}",
57
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
58
               },
59
               "manufacturersProduct
ManufacturersProduct

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

": {
60
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

": "{Integer}",
61
                    "name
Name

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

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

": "{String}",
62
                    "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

": "{String}"
63
               },
64
               "price": {
65
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
66
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
67
               },
68
               "priceConverted
PriceConverted

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

": {
69
                    "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=GoodsReceptionItem.PriceConverted in your request URI to get this field

": "{String}",
70
                    "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=GoodsReceptionItem.PriceConverted in your request URI to get this field

": "{Decimal}"
71
               },
72
               "goodsReception": {
73
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
74
                    "supplier
Supplier

The supplier related to the stock correction

": {
75
                         "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
76
                         "name
Name

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

": "{String}",
77
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
78
                    },
79
                    "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
80
               },
81
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
82
          },
83
          "totals": {
84
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
85
               "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
86
          },
87
          "totalsConverted
TotalsConverted

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

": {
88
               "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=TotalsConverted in your request URI to get this field

": "{String}",
89
               "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}"
90
          },
91
          "stockAccrual
StockAccrual

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

": {
92
               "stockAccrualId
StockAccrualId

Stock accrual identifier

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

": "{Integer}",
93
               "status
Status

Status of stock accrual

Possible domain values can be found here

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

": "{Integer}",
94
               "stockAccrualLink
StockAccrualLink

Stock accrual reference

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

": "{String}"
95
          },
96
          "highlightedNotification
HighlightedNotification

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

": {
97
               "notificationId
NotificationId

Notification identifier

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

": "{Integer}",
98
               "status
Status

Status of the notification

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

": "{Integer}",
99
               "createdAt
CreatedAt

Date and time of creation

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

": "{Datetime}",
100
               "message
Message

The message from the notification definition, expanded with parameters.

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

": "{String}",
101
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

": "{String}",
102
               "notificationType
NotificationType

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

": {
103
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
104
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

": "{String}",
105
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

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

": "{String}"
106
               },
107
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
108
          }
109
     }
110
}

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 100147 HTTP 404 Notification type not found
Error 100053 HTTP 403 You have only admittance to your own suppliers