ROSE Developers - Web API Reference

Assets | Asset Forecast Posting

The Asset Forecast Posting end point is used to process depreciation forcasts for the asset documents, such as Impairments, scraps or disposals.

Overview


URL api/{tenantKey}/{orgKey}/assetsCore/assetForecastPostings
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET AssetForecastPostings

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See AssetForecastPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /assetsCore/assetForecastPostings

GET AssetForecastPostings (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See AssetForecastPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /assetsCore/assetForecastPostings?page={page}&pageSize={pageSize}

GET AssetForecastPosting by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See AssetForecastPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{id}

GET AssetForecastPosting by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

Response:

When successful, the response body contains the entity record. See AssetForecastPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{companyKey}/{postingKey}

GET Print AssetForecastPosting by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{id}/print?template={template}

GET Print AssetForecastPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/print

GET Original Print AssetForecastPostingOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{id}/printOriginal?template={template}

GET Original Print AssetForecastPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/printOriginal

POST Operations

POST AssetForecastPostings

Creates a new entity record.

The following elements are required:

assetForecastPostingResource (ApiAssetForecastPostingResource) The request body should contain the entity record that should be created.
See ApiAssetForecastPostingResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAssetForecastPostingResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /assetsCore/assetForecastPostings

POST Process Forecast Impairments

Processes the Forcast for Impairment Asset Transactions.

The following elements are required:

companyKey (string) The Company Key.
currencyKey (string) The Currency Key.
amount (decimal) The Impairment Amount.
assetKey (string) The Asset Key.
referenceDate (DateTimeOffset) The Date Reference.
depreciationArea (string) The Depreciation Area Key.

Response:

When successful, the response body is empty.

Resource URL:

POST /assetsCore/assetForecastPostings/processForecastImpairments/{companyKey}/{currencyKey}/{amount}/{assetKey}

POST Process Forecast Scrap

Processes the Forcast for Scrap AssetTransactions.

The following elements are required:

companyKey (string) The Company Key.
currencyKey (string) The Currency Key.
assetKey (string) The Asset Key.
referenceDate (DateTimeOffset) The Date Referenced.
quantity (int) The Quantity of the transaction.

Response:

When successful, the response body is empty.

Resource URL:

POST /assetsCore/assetForecastPostings/processForecastScrap/{companyKey}/{currencyKey}/{assetKey}

POST Process Forecast Disposal

Processes the Forcast for Disposal AssetTransactions.

The following elements are required:

companyKey (string) The Company key.
currencyKey (string) The Currency Key.
assetKey (string) The Asset Key.
referenceDate (DateTimeOffset) The Date Reference.
quantity (int) The Transaction Quantity.

Response:

When successful, the response body is empty.

Resource URL:

POST /assetsCore/assetForecastPostings/processForecastDisposal/{companyKey}/{currencyKey}/{assetKey}

POST Process Forecast Acquisition

Processes the Forcast for Aquisition AssetTransactions.

The following elements are required:

companyKey (string) The Company Key.
currencyKey (string) The Currency Key.
amount (decimal) The Amount to be transacted.
assetKey (string) The Asset Key.
referenceDate (DateTimeOffset) The Reference Date.
period (int) Period from Asset History Transaction.
recalculateDepreciationToDate (bool) Indicates if the the recalculation is to be proccessed to the actual date.

Response:

When successful, the response body is empty.

Resource URL:

POST /assetsCore/assetForecastPostings/processForecastAcquisition/{companyKey}/{currencyKey}/{amount}/{assetKey}

POST Process Forecast Depreciation

Processes the Forcast for Depreciation AssetTransactions.

The following elements are required:

companyKey (string) The Company Key.
amount (decimal) The transaction Amount(Money).
assetKey (string) The Asset Key.
referenceDate (DateTimeOffset) The Date Referenced.
depreciationArea (string) The Depreciation Area.

Response:

When successful, the response body is empty.

Resource URL:

POST /assetsCore/assetForecastPostings/processForecastDepreciation/{companyKey}/{amount}/{assetKey}

PUT Operations

PUT Set Company AssetForecastPosting

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/company

PUT Set Currency AssetForecastPosting

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/currency

PUT Set DeprecatedAmount AssetForecastPosting

Updates the value of attribute 'DeprecatedAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/deprecatedAmount

PUT Set DepreciationArea AssetForecastPosting

Updates the value of attribute 'DepreciationArea' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/depreciationArea

PUT Set FinancialAsset AssetForecastPosting

Updates the value of attribute 'FinancialAsset' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/financialAsset

PUT Set FinancialPeriod AssetForecastPosting

Updates the value of attribute 'FinancialPeriod' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/financialPeriod

PUT Set FinancialPeriodName AssetForecastPosting

Updates the value of attribute 'FinancialPeriodName' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/financialPeriodName

PUT Set FinancialYear AssetForecastPosting

Updates the value of attribute 'FinancialYear' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/financialYear

PUT Set FluctuationAmount AssetForecastPosting

Updates the value of attribute 'FluctuationAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/fluctuationAmount

PUT Set ImpairmentAmount AssetForecastPosting

Updates the value of attribute 'ImpairmentAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/impairmentAmount

PUT Set IsActive AssetForecastPosting

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/isActive

PUT Set IsProcessed AssetForecastPosting

Updates the value of attribute 'IsProcessed' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/isProcessed

PUT Set Nature AssetForecastPosting

Updates the value of attribute 'Nature' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (enum AccountingNature) The request body should contain the new value for the attribute.
See AccountingNature.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/nature

PUT Set PostingDate AssetForecastPosting

Updates the value of attribute 'PostingDate' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/postingDate

PUT Set ProcessedAmount AssetForecastPosting

Updates the value of attribute 'ProcessedAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/processedAmount

PUT Set Quantity AssetForecastPosting

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/quantity

PUT Set RetroactiveAmount AssetForecastPosting

Updates the value of attribute 'RetroactiveAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/retroactiveAmount

PUT Set TotalAmount AssetForecastPosting

Updates the value of attribute 'TotalAmount' in the specified entity record.

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /assetsCore/assetForecastPostings/{companyKey}/{postingKey}/totalAmount

DELETE Operations

DELETE AssetForecastPosting by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /assetsCore/assetForecastPostings/{id}

DELETE AssetForecastPosting by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /assetsCore/assetForecastPostings/{companyKey}/{postingKey}

Resources


ApiAssetForecastPostingResource

The following elements are required:

impairmentAmount (MoneyResource) The total Impairment book value of an asset.
See MoneyResource .
fluctuationAmount (MoneyResource) The fluctuation amount.
See MoneyResource .
totalAmount (MoneyResource) The doucument Total.
See MoneyResource .
deprecatedAmount (MoneyResource) The decrease in the value of th asset.
See MoneyResource .
isProcessed (bool) Has the asset already been processed.
processedAmount (MoneyResource) The amount which the asset was processed.
See MoneyResource .
retroactiveAmount (MoneyResource) The delayed amount for the depreciation already performed at a lower rate.
See MoneyResource .
company (string) The company key.
currency (string) The transaction currency.
depreciationArea (string) The depreciation Area for the entity.
financialAsset (string) The financial asset to be posted.
financialYear (string) The financial year of the posting.

The following elements are optional:

postingDate (DateTime) The date when the document is created.
nature (enum AccountingNature) The nature of the account posting.
See AccountingNature.
quantity (int) The quantity selected to be processed.
financialPeriod (int) The Financial year period.
financialPeriodName (string) The financial period name.


AssetForecastPostingResource

The following elements are required:

postingKey (int) The posting's key.
impairmentAmount (MoneyResource) The total Impairment book value of an asset.
See MoneyResource .
fluctuationAmount (MoneyResource) The fluctuation amount.
See MoneyResource .
totalAmount (MoneyResource) The doucument Total.
See MoneyResource .
deprecatedAmount (MoneyResource) The decrease in the value of th asset.
See MoneyResource .
isProcessed (bool) Has the asset already been processed.
processedAmount (MoneyResource) The amount which the asset was processed.
See MoneyResource .
retroactiveAmount (MoneyResource) The delayed amount for the depreciation already performed at a lower rate.
See MoneyResource .
company (string) The company key.
currency (string) The transaction currency.
depreciationArea (string) The depreciation Area for the entity.
financialAsset (string) The financial asset to be posted.
financialYear (string) The financial year of the posting.

The following elements are optional:

postingDate (DateTime) The date when the document is created.
nature (enum AccountingNature) The nature of the account posting.
See AccountingNature.
quantity (int) The quantity selected to be processed.
financialPeriod (int) The Financial year period.
financialPeriodName (string) The financial period name.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



Enumerations


AccountingNature

1 Debit
2 Credit