Financials | Financial Account Transfer
Service to manage entities of type 'FinancialAccountTransfer'.
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/financialAccountTransfers |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET FinancialAccountTransfers (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See FinancialAccountTransferResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialAccountTransfer 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 FinancialAccountTransferResource. |
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 FinancialAccountTransfer by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| transferKey | (int) Transfer. |
Response:
| When successful, the response body contains the entity record. See FinancialAccountTransferResource. |
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 FinancialAccountTransfers
Creates a new entity record.
The following elements are required:
| financialAccountTransferResource | (ApiFinancialAccountTransferResource) The request body should contain the entity record that should be created. See ApiFinancialAccountTransferResource. |
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 ApiFinancialAccountTransferResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Amount FinancialAccountTransfer
Updates the value of attribute 'Amount' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 Currency FinancialAccountTransfer
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 DocumentDate FinancialAccountTransfer
Updates the value of attribute 'DocumentDate' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 ExchangeRate FinancialAccountTransfer
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 IsActive FinancialAccountTransfer
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 Note FinancialAccountTransfer
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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 Remarks FinancialAccountTransfer
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| transferKey | (int) Transfer. |
| 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:
DELETE FinancialAccountTransfer 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 FinancialAccountTransfer by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| transferKey | (int) Transfer. |
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
ApiFinancialAccountTransferResource
The following elements are required:
| transferKey | (int) Transfer. |
| company | (string) Company. |
| documentDate | (DateTime) Date. |
| financialAccount | (string) Source Financial Account. |
| targetFinancialAccount | (string) Target Financial Account. |
| amount | (MoneyResource) Amount.
See MoneyResource . |
| currency | (string) Currency. |
| exchangeRate | (decimal) Exchange Rate. |
The following elements are optional:
| note | (string) Reference. |
| remarks | (string) Remarks. |
FinancialAccountTransferResource
The following elements are required:
| transferKey | (int) Transfer. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| postingDate | (DateTime) Posting Date. |
| documentDate | (DateTime) Date. |
| financialAccount | (string) Source Financial Account.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
| targetFinancialAccount | (string) Target Financial Account.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
| amount | (MoneyResource) Amount.
See MoneyResource . |
| currency | (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| exchangeRate | (decimal) Exchange Rate. |
| isBankAccount | (bool) Is Bank Account. |
| pettyCashAllowsForeignCurrency | (bool) Petty Cash Allows Foreign Currency. |
| targetIsBankAccount | (bool) Target Is Bank Account. |
| targetPettyCashAllowsForeignCurrency | (bool) Target Petty Cash Allows Currency. |
The following elements are optional:
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| note | (string) Reference. |
| remarks | (string) Remarks. |
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.