API

Finance APIs

GET finance/stock-accruals/{stockAccrualId}

Stock accrual details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/stock-accruals/{stockAccrualId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockAccrualId} Stock accrual identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 516, 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:
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
<StockAccrual>
2
     <StockAccrualId
StockAccrualId

Stock accrual identifier

>{Integer}</StockAccrualId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Status
Status

Status of stock accrual

Possible domain values can be found here

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

Type of the stock accrual

Possible domain values can be found here

>{String}</Type>
6
     <IssueDate
IssueDate

Date when the stock accrual was issued.

>{Date}</IssueDate>
7
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
8
     <InternalMessage
InternalMessage

Internal message from the system

>{String}</InternalMessage>
9
     <Quantity
Quantity

Quantity of stock accrual

>{Decimal}</Quantity>
10
     <Assignee
Assignee

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

>
11
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
15
     </Assignee>
16
     <Counterparty
Counterparty

The customer or supplier involved in the stock accrual

>
17
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
18
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
19
          <Name
Name

Name of the customer/supplier, or last name if it is a person.

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

First name of the customer/supplier

>{String}</FirstName>
21
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
22
     </Counterparty>
23
     <Source>
24
          <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
25
          <Object>
26
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
27
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
28
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
29
               <AccountingPeriod>
30
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
31
                    <Period
Period

Accounting period

>{Integer}</Period>
32
                    <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
33
               </AccountingPeriod>
34
               <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
35
                    <ForwardedFromItem>
36
                         <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
37
                         <Object>
38
                              <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
39
                              <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
40
                              <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
41
                         </Object>
42
                         <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
43
                         <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
44
                    </ForwardedFromItem>
45
               </ForwardedFrom>
46
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
47
          </Object>
48
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
49
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
50
     </Source>
51
     <ClosingInformation>
52
          <Date
Date

Date when the stock accrual is closed.

>{Date}</Date>
53
          <IsManuallyClosed
IsManuallyClosed

Stock accrual is manually closed by user

>{Boolean}</IsManuallyClosed>
54
          <IsClosedByRevision
IsClosedByRevision

Stock accrual is closed by a revision

>{Boolean}</IsClosedByRevision>
55
          <Document
Document

Document which closes the stock accrual

>
56
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
57
               <Object>
58
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
59
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
60
                    <AccountingPeriod>
61
                         <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
62
                         <Period
Period

Accounting period

>{Integer}</Period>
63
                         <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
64
                    </AccountingPeriod>
65
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
66
               </Object>
67
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
68
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
69
          </Document>
70
          <AccountingPeriod>
71
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
72
               <Period
Period

Accounting period

>{Integer}</Period>
73
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
74
          </AccountingPeriod>
75
          <Totals>
76
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
77
               <Amount
Amount

Stock accrual close amount

>{Decimal}</Amount>
78
          </Totals>
79
          <TotalsConverted
TotalsConverted

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

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

>{String}</Currency>
81
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
82
               <Amount
Amount

Stock accrual close amount in company currency.

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

>{Decimal}</Amount>
83
          </TotalsConverted>
84
     </ClosingInformation>
85
     <GeneralLedgerPosting>
86
          <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
87
          <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
88
     </GeneralLedgerPosting>
89
     <AccountingPeriod>
90
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
91
          <Period
Period

Accounting period

>{Integer}</Period>
92
          <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
93
     </AccountingPeriod>
94
     <Location>
95
          <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
96
          <ShortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

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

>{String}</LocationLink>
98
     </Location>
99
     <Manufacturer>
100
          <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
104
     </Manufacturer>
105
     <ForwardedFrom>
106
          <StockAccrual>
107
               <StockAccrualId
StockAccrualId

Stock accrual identifier

>{Integer}</StockAccrualId>
108
               <StockAccrualLink
StockAccrualLink

Stock accrual reference

>{String}</StockAccrualLink>
109
          </StockAccrual>
110
     </ForwardedFrom>
111
     <ForwardedTo>
112
          <StockAccrual>
113
               <StockAccrualId
StockAccrualId

Stock accrual identifier

>{Integer}</StockAccrualId>
114
               <Totals>
115
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
116
                    <Amount
Amount

Stock accrual destination amount

>{Decimal}</Amount>
117
               </Totals>
118
               <TotalsConverted
TotalsConverted

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

>
119
                    <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=ForwardedTo.StockAccrual.TotalsConverted in your request URI to get this field

>{String}</Currency>
120
                    <ExchangeRate
ExchangeRate

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
121
                    <Amount
Amount

Stock accrual destination amount in company currency

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

>{Decimal}</Amount>
122
               </TotalsConverted>
123
               <StockAccrualLink
StockAccrualLink

Stock accrual reference

>{String}</StockAccrualLink>
124
          </StockAccrual>
125
     </ForwardedTo>
126
     <Totals>
127
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
128
          <Amount
Amount

Stock accrual amount

>{Decimal}</Amount>
129
          <InventoryAmount
InventoryAmount

Stock accrual inventory amount

>{Decimal}</InventoryAmount>
130
     </Totals>
131
     <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

>
132
          <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>
133
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

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}</ExchangeRate>
134
          <Amount
Amount

Stock accrual 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}</Amount>
135
          <InventoryAmount
InventoryAmount

Stock accrual inventory 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}</InventoryAmount>
136
     </TotalsConverted>
137
</StockAccrual>
1
{
2
     "stockAccrual": {
3
          "stockAccrualId
StockAccrualId

Stock accrual identifier

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

Date and time of creation

": "{Datetime}",
5
          "status
Status

Status of stock accrual

Possible domain values can be found here

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

Type of the stock accrual

Possible domain values can be found here

": "{String}",
7
          "issueDate
IssueDate

Date when the stock accrual was issued.

": "{Date}",
8
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "internalMessage
InternalMessage

Internal message from the system

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

Quantity of stock accrual

": "{Decimal}",
11
          "assignee
Assignee

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

": {
12
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
16
          },
17
          "counterparty
Counterparty

The customer or supplier involved in the stock accrual

": {
18
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
19
               "objectType
ObjectType

Type of object

": "{String}",
20
               "name
Name

Name of the customer/supplier, or last name if it is a person.

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

First name of the customer/supplier

": "{String}",
22
               "objectLink
ObjectLink

API reference to the object

": "{String}"
23
          },
24
          "source": {
25
               "itemId
ItemId

Identifier of the object

": "{Integer}",
26
               "object": {
27
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
28
                    "objectType
ObjectType

Type of object

": "{String}",
29
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
30
                    "accountingPeriod": {
31
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
32
                         "period
Period

Accounting period

": "{Integer}",
33
                         "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
34
                    },
35
                    "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
36
                         "forwardedFromItem": {
37
                              "itemId
ItemId

Identifier of the object

": "{Integer}",
38
                              "object": {
39
                                   "objectId
ObjectId

Identifier of the object

": "{Integer}",
40
                                   "objectType
ObjectType

Type of object

": "{String}",
41
                                   "objectLink
ObjectLink

API reference to the object

": "{String}"
42
                              },
43
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
44
                              "itemLink
ItemLink

API reference to the item

": "{String}"
45
                         }
46
                    },
47
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
48
               },
49
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
50
               "itemLink
ItemLink

API reference to the item

": "{String}"
51
          },
52
          "closingInformation": {
53
               "date
Date

Date when the stock accrual is closed.

": "{Date}",
54
               "isManuallyClosed
IsManuallyClosed

Stock accrual is manually closed by user

": "{Boolean}",
55
               "isClosedByRevision
IsClosedByRevision

Stock accrual is closed by a revision

": "{Boolean}",
56
               "document
Document

Document which closes the stock accrual

": {
57
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
58
                    "object": {
59
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
60
                         "objectType
ObjectType

Type of object

": "{String}",
61
                         "accountingPeriod": {
62
                              "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
63
                              "period
Period

Accounting period

": "{Integer}",
64
                              "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
65
                         },
66
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
67
                    },
68
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
69
                    "itemLink
ItemLink

API reference to the item

": "{String}"
70
               },
71
               "accountingPeriod": {
72
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
73
                    "period
Period

Accounting period

": "{Integer}",
74
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
75
               },
76
               "totals": {
77
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
78
                    "amount
Amount

Stock accrual close amount

": "{Decimal}"
79
               },
80
               "totalsConverted
TotalsConverted

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

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

": "{String}",
82
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

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

": "{Decimal}",
83
                    "amount
Amount

Stock accrual close amount in company currency.

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

": "{Decimal}"
84
               }
85
          },
86
          "generalLedgerPosting": {
87
               "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",
88
               "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
89
          },
90
          "accountingPeriod": {
91
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
92
               "period
Period

Accounting period

": "{Integer}",
93
               "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
94
          },
95
          "location": {
96
               "locationId
LocationId

Location identifier

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

": "{Integer}",
97
               "shortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

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

": "{String}"
99
          },
100
          "manufacturer": {
101
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
105
          },
106
          "forwardedFrom": {
107
               "stockAccrual": {
108
                    "stockAccrualId
StockAccrualId

Stock accrual identifier

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

Stock accrual reference

": "{String}"
110
               }
111
          },
112
          "forwardedTo": {
113
               "stockAccrual": {
114
                    "stockAccrualId
StockAccrualId

Stock accrual identifier

": "{Integer}",
115
                    "totals": {
116
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
117
                         "amount
Amount

Stock accrual destination amount

": "{Decimal}"
118
                    },
119
                    "totalsConverted
TotalsConverted

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

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

": "{String}",
121
                         "exchangeRate
ExchangeRate

The exchange rate used in convertion

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

": "{Decimal}",
122
                         "amount
Amount

Stock accrual destination amount in company currency

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

": "{Decimal}"
123
                    },
124
                    "stockAccrualLink
StockAccrualLink

Stock accrual reference

": "{String}"
125
               }
126
          },
127
          "totals": {
128
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
129
               "amount
Amount

Stock accrual amount

": "{Decimal}",
130
               "inventoryAmount
InventoryAmount

Stock accrual inventory amount

": "{Decimal}"
131
          },
132
          "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

": {
133
               "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}",
134
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

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}",
135
               "amount
Amount

Stock accrual 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}",
136
               "inventoryAmount
InventoryAmount

Stock accrual inventory 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}"
137
          }
138
     }
139
}

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 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers