ROSE Developers - Web API Reference

Assets | DisposalClearingAccountTransfer

The Disposal Account Transfer end point is used to record the information related with the process of tranfer a sale into a sale account, such as glaccount.

Overview


URL api/{tenantKey}/{orgKey}/assets/disposalAccountTransfers
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET DisposalAccountTransfers

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /assets/disposalAccountTransfers

GET DisposalAccountTransfers (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 DisposalAccountTransferResource.

Response status codes:

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

Resource URL:

GET /assets/disposalAccountTransfers?page={page}&pageSize={pageSize}

GET DisposalAccountTransfer 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 DisposalAccountTransferResource.

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 /assets/disposalAccountTransfers/{id}

GET DisposalAccountTransfer by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.

Response:

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

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}

GET Print DisposalAccountTransfer 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 /assets/disposalAccountTransfers/{id}/print?template={template}

GET Print DisposalAccountTransfer by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/print

GET Original Print DisposalAccountTransferOriginal 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 /assets/disposalAccountTransfers/{id}/printOriginal?template={template}

GET Original Print DisposalAccountTransfer by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/printOriginal

POST Operations

POST DisposalAccountTransfers

Creates a new entity record.

The following elements are required:

disposalAccountTransferResource (ApiDisposalAccountTransferResource) The request body should contain the entity record that should be created.
See ApiDisposalAccountTransferResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

POST /assets/disposalAccountTransfers

POST DisposalAccountTransfer

Inserts a new 'Disposal Account Transfer Line' in the 'DisposalAccountTransfer'.

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
companyKey (string) The company key.
value (ApiDisposalAccountTransferDocumentLinesResource) The ApiDisposalAccountTransferDocumentLinesResource instance.
See ApiDisposalAccountTransferDocumentLinesResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines

PUT Operations

PUT Set ChartOfAccount DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/chartOfAccount

PUT Set Company DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/company

PUT Set Currency DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/currency

PUT Set ExchangeRate DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/exchangeRate

PUT Set ExchangeRateDate DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/exchangeRateDate

PUT Set FinancialPeriod DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/financialPeriod

PUT Set FinancialPeriodName DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/financialPeriodName

PUT Set FinancialYear DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/financialYear

PUT Set IsActive DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/isActive

PUT Set Ledger DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/ledger

PUT Set Note DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/note

PUT Set SeriesNumber DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/seriesNumber

PUT Set SourceDocId DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/sourceDocId

PUT Set SourceDocLine DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/sourceDocLine

PUT Set SourceDocLineId DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/sourceDocLineId

PUT Set SourceSchemaEntityId DisposalAccountTransferLine

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/sourceSchemaEntityId

PUT Set TotalAmount DisposalAccountTransfer

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

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/totalAmount

PUT Set Custom Attribute DisposalAccountTransfer

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/{customAttributeName}

PUT Set Custom Attribute DisposalAccountTransferLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Disposal Account Transfer Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}/documentLines/{lineId}

DELETE DisposalAccountTransfer 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 /assets/disposalAccountTransfers/{id}

DELETE DisposalAccountTransfer by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.

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 /assets/disposalAccountTransfers/{companyKey}/{journalType}/{financialYear}/{ledger}/{seriesNumber}

Resources


ApiDisposalAccountTransferDocumentLinesResource

The following elements are required:

gLAccount (string) GL Account.
amount (MoneyResource) Amount.
See MoneyResource .
quantity (int) Quantity.
sourceDoc (string) Source Doc.
sourceDocLineId (Guid) Source Doc Line Id.
sourceSchemaEntityId (Guid) Source Schema Entity Id.
exchangeRate (decimal) Exchange Rate.
clearingAccount (string) Clearing Account.
currency (string) Currency.
unit (string) Unit.
ledger (string) Ledger.
chartOfAccount (string) Chart Of Account.

The following elements are optional:

description (string) Description.
sourceDocId (Guid) Source Doc Id.
sourceDocLine (int) Source Doc Line.
exchangeRateDate (DateTime) Exchange Rate Date.
dimensionSet (string) Dimension Set.


ApiDisposalAccountTransferResource

The following elements are required:

company (string) he company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
journalType (string) The journal type of the transaction.
financialYear (string) The financial year.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
postingDate (DateTime) The date when the document is created.
documentDate (DateTime) The document date.
financialPeriod (int) The Financial year period.
financialPeriodName (string) The financial period name.
totalAmount (MoneyResource) The document total.
See MoneyResource .
chartOfAccount (string) The chart of accounts of the company (Internal).
currency (string) The currency of the journal entry.

The following elements are optional:

note (string) A place to store related information with the journal entry.
documentLines (List of ApiDisposalAccountTransferDocumentLinesResource) The document lines.
See ApiDisposalAccountTransferDocumentLinesResource.


DisposalAccountTransferLineResource

The following elements are required:

gLAccount (string) GL Account.
amount (MoneyResource) Amount.
See MoneyResource .
quantity (int) Quantity.
sourceDoc (string) Source Doc.
sourceDocLineId (Guid) Source Doc Line Id.
sourceSchemaEntityId (Guid) Source Schema Entity Id.
exchangeRate (decimal) Exchange Rate.
clearingAccount (string) Clearing Account.
currency (string) Currency.
unit (string) Unit.
ledger (string) Ledger.
chartOfAccount (string) Chart Of Account.

The following elements are optional:

description (string) Description.
sourceDocId (Guid) Source Doc Id.
sourceDocLine (int) Source Doc Line.
exchangeRateDate (DateTime) Exchange Rate Date.
dimensionSetJson (string) Dimension Set Json.
dimensionSet (string) Dimension Set.


DisposalAccountTransferResource

The following elements are required:

company (string) he company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
journalType (string) The journal type of the transaction.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
financialYear (string) The financial year.
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
postingDate (DateTime) The date when the document is created.
documentDate (DateTime) The document date.
financialPeriod (int) The Financial year period.
financialPeriodName (string) The financial period name.
totalAmount (MoneyResource) The document total.
See MoneyResource .
chartOfAccount (string) The chart of accounts of the company (Internal).
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
currency (string) The currency of the journal entry.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.

The following elements are optional:

note (string) A place to store related information with the journal entry.
accountingDocument (string) The accounting document that was assigned in accounting.
documentLines (List of DisposalAccountTransferLineResource) The document lines.
See DisposalAccountTransferLineResource.


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.



ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.