Assets | Acquisition Account Transfer
The Acquisition Account Transfer end point is used to record the information related with the process of tranfer a purchase into a purchase account, such as glaccounts.
Overview
| URL | api/{tenantKey}/{orgKey}/assets/acquisitionAccountTransfers |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET AcquisitionAccountTransfers
- GET AcquisitionAccountTransfers (paged)
- GET AcquisitionAccountTransfer by identifier
- GET AcquisitionAccountTransfer by key
- GET Print AcquisitionAccountTransfer by identifier
- GET Print AcquisitionAccountTransfer by key
- GET Original Print AcquisitionAccountTransferOriginal by identifier
- GET Original Print AcquisitionAccountTransfer by key
- POST:
-
PUT:
- PUT Set Custom Attribute AcquisitionAccountTransfer
- PUT Set Custom Attribute AcquisitionAccountTransferLine
- PUT Set IsActive AcquisitionAccountTransfer
- PUT Set Company AcquisitionAccountTransfer
- PUT Set FinancialYear AcquisitionAccountTransfer
- PUT Set Ledger AcquisitionAccountTransfer
- PUT Set SeriesNumber AcquisitionAccountTransfer
- PUT Set Currency AcquisitionAccountTransfer
- PUT Set FinancialPeriod AcquisitionAccountTransfer
- PUT Set FinancialPeriodName AcquisitionAccountTransfer
- PUT Set ChartOfAccount AcquisitionAccountTransfer
- PUT Set Note AcquisitionAccountTransfer
- PUT Set TotalAmount AcquisitionAccountTransfer
- PUT Set ChartOfAccount AcquisitionAccountTransferLine
- PUT Set Currency AcquisitionAccountTransferLine
- PUT Set SourceDocId AcquisitionAccountTransferLine
- PUT Set SourceDocLine AcquisitionAccountTransferLine
- PUT Set SourceDocLineId AcquisitionAccountTransferLine
- PUT Set SourceSchemaEntityId AcquisitionAccountTransferLine
- PUT Set ExchangeRate AcquisitionAccountTransferLine
- PUT Set ExchangeRateDate AcquisitionAccountTransferLine
- PUT Set Ledger AcquisitionAccountTransferLine
- DELETE:
All Resources
This service uses the following resources:
GET AcquisitionAccountTransfers
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See AcquisitionAccountTransferResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AcquisitionAccountTransfers (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 AcquisitionAccountTransferResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AcquisitionAccountTransfer 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 AcquisitionAccountTransferResource. |
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 AcquisitionAccountTransfer 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 AcquisitionAccountTransferResource. |
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 Print AcquisitionAccountTransfer 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 Print AcquisitionAccountTransfer 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 Original Print AcquisitionAccountTransferOriginal 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 Original Print AcquisitionAccountTransfer 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:
POST AcquisitionAccountTransfers
Creates a new entity record.
The following elements are required:
| acquisitionAccountTransferResource | (ApiAcquisitionAccountTransferResource) The request body should contain the entity record that should be created. See ApiAcquisitionAccountTransferResource. |
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 ApiAcquisitionAccountTransferResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Acquisition Account Transfer
Inserts a new 'Acquisition Account Transfer Line' in the 'Acquisition Account Transfer'.
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 | (ApiAcquisitionAccountTransferDocumentLinesResource) The ApiAcquisitionAccountTransferDocumentLinesResource instance. See ApiAcquisitionAccountTransferDocumentLinesResource. |
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:
PUT Set ChartOfAccount AcquisitionAccountTransfer
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 Set ChartOfAccount AcquisitionAccountTransferLine
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. |
| lineId | (string) The detail identifier. |
| 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 Set Company AcquisitionAccountTransfer
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 Set Currency AcquisitionAccountTransfer
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 Set Currency AcquisitionAccountTransferLine
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. |
| lineId | (string) The detail identifier. |
| 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 Set ExchangeRate AcquisitionAccountTransferLine
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 Set ExchangeRateDate AcquisitionAccountTransferLine
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 Set FinancialPeriod AcquisitionAccountTransfer
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 Set FinancialPeriodName AcquisitionAccountTransfer
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 Set FinancialYear AcquisitionAccountTransfer
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 Set IsActive AcquisitionAccountTransfer
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 Set Ledger AcquisitionAccountTransfer
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 Set Ledger AcquisitionAccountTransferLine
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. |
| lineId | (string) The detail identifier. |
| 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 Set Note AcquisitionAccountTransfer
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 Set SeriesNumber AcquisitionAccountTransfer
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 Set SourceDocId AcquisitionAccountTransferLine
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 Set SourceDocLine AcquisitionAccountTransferLine
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 Set SourceDocLineId AcquisitionAccountTransferLine
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 Set SourceSchemaEntityId AcquisitionAccountTransferLine
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 Set TotalAmount AcquisitionAccountTransfer
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 Set Custom Attribute AcquisitionAccountTransfer
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 Set Custom Attribute AcquisitionAccountTransferLine
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:
DELETE Acquisition 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 AcquisitionAccountTransfer 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 AcquisitionAccountTransfer 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:
Resources
AcquisitionAccountTransferLineResource
The following elements are required:
| gLAccount | (string) GL Account. |
| clearingAccount | (string) Clearing Account. |
| amount | (MoneyResource) Amount.
See MoneyResource . |
| quantity | (int) Quantity. |
| chartOfAccount | (string) Chart Of Account. |
| currency | (string) Currency. |
| sourceDoc | (string) Source Doc. |
| sourceDocLineId | (Guid) Source Doc Line Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
| exchangeRate | (decimal) Exchange Rate. |
| ledger | (string) Ledger. |
The following elements are optional:
| description | (string) Description. |
| dimensionSet | (string) Dimension Set. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceDocLine | (int) Source Doc Line. |
| unit | (string) Unit. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| dimensionSetJson | (string) Dimension Set Json. |
AcquisitionAccountTransferResource
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. |
| 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. |
| documentDate | (DateTime) The document date. |
| financialPeriod | (int) The Financial year period. |
| financialPeriodName | (string) The financial period name. |
| totalAmount | (MoneyResource) The doucument Total.
See MoneyResource . |
The following elements are optional:
| documentLines | (List of AcquisitionAccountTransferLineResource) The document lines.
See AcquisitionAccountTransferLineResource. |
| 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. |
| note | (string) A place to store related information with the journal entry. |
| accountingDocument | (string) The accounting document that was assigned in accounting. |
ApiAcquisitionAccountTransferDocumentLinesResource
The following elements are required:
| gLAccount | (string) GL Account. |
| clearingAccount | (string) Clearing Account. |
| amount | (MoneyResource) Amount.
See MoneyResource . |
| quantity | (int) Quantity. |
| chartOfAccount | (string) Chart Of Account. |
| currency | (string) Currency. |
| sourceDoc | (string) Source Doc. |
| sourceDocLineId | (Guid) Source Doc Line Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
| exchangeRate | (decimal) Exchange Rate. |
| ledger | (string) Ledger. |
The following elements are optional:
| description | (string) Description. |
| dimensionSet | (string) Dimension Set. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceDocLine | (int) Source Doc Line. |
| unit | (string) Unit. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
ApiAcquisitionAccountTransferResource
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. |
| currency | (string) The currency of the journal entry. |
| documentDate | (DateTime) The document date. |
| financialPeriod | (int) The Financial year period. |
| financialPeriodName | (string) The financial period name. |
| totalAmount | (MoneyResource) The doucument Total.
See MoneyResource . |
The following elements are optional:
| documentLines | (List of ApiAcquisitionAccountTransferDocumentLinesResource) The document lines.
See ApiAcquisitionAccountTransferDocumentLinesResource. |
| chartOfAccount | (string) The chart of accounts of the company (Internal). |
| note | (string) A place to store related information with the journal entry. |
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. |