Finance APIs

GET finance/stock-accruals/totals

Aggregated values of amount for stock accruals

HTTP method	GET
URI	https://api.rambase.net/finance/stock-accruals/totals
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	7030, version 3

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.

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

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

ActiveStockAccruals() Named filter	Active stock accruals (Status equals 4)
ClosedByRevision() Named filter	Stock accruals closed by revision.
ManuallyClosed() Named filter	Manually closed stock accruals
WaitingForGoods() Named filter	Stock accruals that are waiting for goods.
AccountingPeriod Integer	Accounting period.
CloseDocument String	Internal RamBase identifier of the object/item.
ClosingInformationAccountingPeriod Integer	Accounting period identifier.
ClosingInformationDate Date	Date when the stock accrual is closed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ClosingInformationDocumentAccountingPeriod Integer	Accounting period identifier.
Currency String	Three character code following the ISO 4217 standard.
CustomerId Integer	Customer identifier.
IssueDate Date	Date when the stock accrual was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
LocationShortName String	Unique abbreviation/short name of the location.
ManufacturerShortName String	Shortname/code of the manufacturer.
Quantity Decimal	Quantity of stock accrual.
RegistrationDate Date	Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SourceItemId Integer	Identifier of the object.
SourceObjectId Integer	Identifier of the object.
SourceObjectType String	Type of object.
Status Integer	Status of stock accrual.
StockAccrualId Integer	Stock accrual identifier.
SupplierId Integer	Customer identifier.
Type String	Type of the stock accrual.

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

AccountingPeriod Integer	Accounting period
CloseDocument String	Internal RamBase identifier of the object/item
ClosingInformationAccountingPeriod Integer	Accounting period identifier
ClosingInformationDate Date	Date when the stock accrual is closed.
ClosingInformationDocumentAccountingPeriod Integer	Accounting period identifier
Currency String	Three character code following the ISO 4217 standard
IssueDate Date	Date when the stock accrual was issued.
LocationShortName String	Unique abbreviation/short name of the location
ManufacturerShortName String	Shortname/code of the manufacturer
Quantity Decimal	Quantity of stock accrual
RegistrationDate Date	Date of registration
Status Integer	Status of stock accrual
StockAccrualId Integer	Stock accrual identifier
Type String	Type of the stock accrual

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:

                                        <Total>
                                    

                                             <TotalsConverted>
                                    

<Amount

Amount

Stock accrual amount in company currency.

>{Decimal}</Amount>

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

                                             </TotalsConverted>
                                    

                                        </Total>
                                    

{

                                             "total": {
                                    

                                                  "totalsConverted": {
                                    

"amount

Amount

Stock accrual amount in company currency.

": "{Decimal}",

"currency

Currency

Three character code following the ISO 4217 standard

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