ROSE Developers - Web API Reference

Assets | Sales to Assets

The Process Disposal endpoint is used to process an asset's sale into a disposal.

Overview


URL api/{tenantKey}/{orgKey}/assets/processDisposals
Methods Supported POST, GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Sales to Assets

Returns the list of entity records that can be processed by the 'AssetDisposals' service.

The following elements are required:

pageIndex (int) The index of the page of the list that should be returned.
pageSize (int) The number of page elements that should be returned (max. is 1000).
company (string) The company filter.
currency (string) The currency filter.

The following elements are optional:

party (string) The supplier filter. This is a query string parameter.
saleDate (DateTime?) The document date will be used on the acquisition document. This is a query string parameter.
saleFromDate (DateTime?) The from date filter. This is a query string parameter.
saleToDate (DateTime?) The to date filter. This is a query string parameter.
postingDate (DateTime?) The document posting date This is a query string parameter.
documentDate (DateTime?) The document date This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See DisposalLine.

Response status codes:

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

Resource URL:

GET /assets/processDisposals/{pageIndex}/{pageSize}?party={party}&saleDate={saleDate}&saleFromDate={saleFromDate}&saleToDate={saleToDate}&postingDate={postingDate}&documentDate={documentDate}

POST Operations

POST Post Disposal

This service represent the application picking, given a resource it will process the assets.

The following elements are required:

disposal (Disposal) This resource contains information about disposals to be processed to asset disposals.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST /assets/processDisposals/postDisposal

POST Post Transfer Clearing Account

This service represent the application picking for the transfer clearing account, given a resource it will process the assets.

The following elements are required:

disposal (Disposal) This resource contains information about capitalizations to be processed to transfer clearing account.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST /assets/processDisposals/postTransferClearingAccount

POST Sales to Assets

Instructs the 'AssetDisposals' service to process the specified entity records.

The following elements are required:

list (DisposalLine) List of the entity records that should be processed.
See DisposalLine.
companyKey (string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

POST /assets/processDisposals/{companyKey}

Resources


Disposal

The following elements are required:

company (string) The company filter.
selectedCount (int) Internal - count of selected lines.
currency (string) The currency filter.

The following elements are optional:

party (string) The supplier filter.
saleDate (DateTime) The document date will be used on the acquisition document.
saleFromDate (DateTime) The from date filter.
saleToDate (DateTime) The to date filter.
postingDate (DateTime) The document posting date.
documentDate (DateTime) The document date.


DisposalLine

The following elements are required:

selected (bool) Indicate if true the line is selected otherwise the line is not selected.
sourceDoc (string) The source document key of the sales document.
sourceDocLine (int) The source line index.
quantity (int) The quantity selected to be processed.

The following elements are optional:

party (string) The party of the sales document.
documentDate (DateTime) The document date of the sales document.
sourceDocId (Guid) The source document identifier of the sales document.
sourceDocLineId (Guid) The source document line identifier of the sales document.
sourceSchemaEntityId (Guid) The schema entity identifier of the sales document.
lineDescription (string) The source line description.
originalQuantity (int) The original quantity of the sales document.
openQuantity (int) The remaining quantities.
unit (string) The Unit of the sales document.
asset (string) Asset.
gLAccount (string) GL Account.