Financials | Financial Settings
Service to manage entities of type 'FinancialSetup'.
Overview
URL | api/{tenantKey}/{orgKey}/financialCore/financialSetups |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive FinancialSetup
- PUT Set Company FinancialSetup
- PUT Set DefaultReceiptType FinancialSetup
- PUT Set DefaultPaymentType FinancialSetup
- PUT Set DefaultCreditCashFlowItem FinancialSetup
- PUT Set DefaultDebitCashFlowItem FinancialSetup
- PUT Set MainBankAccountType FinancialSetup
- PUT Set LastAccountingPeriodCloseDate FinancialSetup
- PUT Set AllowChangeCloseDate FinancialSetup
- PUT Set CloseAccountingAutomatically FinancialSetup
- PUT Set AccountingPeriodicity FinancialSetup
- PUT Set PeriodClosingDelay FinancialSetup
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET FinancialSetups (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 FinancialSetupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialSetup 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 FinancialSetupResource. |
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 FinancialSetup by key
Returns the entity record that matches the specified key.
The following elements are required:
company | (string) The associated setup company. |
Response:
When successful, the response body contains the entity record. See FinancialSetupResource. |
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 FinancialSetups
Creates a new entity record.
The following elements are required:
financialSetupResource | (ApiFinancialSetupResource) The request body should contain the entity record that should be created. See ApiFinancialSetupResource. |
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 ApiFinancialSetupResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AccountingPeriodicity FinancialSetup
Updates the value of attribute 'AccountingPeriodicity' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
value | (enum AccountingPeriodicity) The request body should contain the new value for the attribute. See AccountingPeriodicity. |
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 AllowChangeCloseDate FinancialSetup
Updates the value of attribute 'AllowChangeCloseDate' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 Set CloseAccountingAutomatically FinancialSetup
Updates the value of attribute 'CloseAccountingAutomatically' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 Set Company FinancialSetup
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 DefaultCreditCashFlowItem FinancialSetup
Updates the value of attribute 'DefaultCreditCashFlowItem' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 DefaultDebitCashFlowItem FinancialSetup
Updates the value of attribute 'DefaultDebitCashFlowItem' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 DefaultPaymentType FinancialSetup
Updates the value of attribute 'DefaultPaymentType' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 DefaultReceiptType FinancialSetup
Updates the value of attribute 'DefaultReceiptType' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 FinancialSetup
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 LastAccountingPeriodCloseDate FinancialSetup
Updates the value of attribute 'LastAccountingPeriodCloseDate' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 MainBankAccountType FinancialSetup
Updates the value of attribute 'MainBankAccountType' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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 PeriodClosingDelay FinancialSetup
Updates the value of attribute 'PeriodClosingDelay' in the specified entity record.
The following elements are required:
company | (string) The associated setup company. |
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:
DELETE FinancialSetup 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 FinancialSetup by key
Deletes the entity record that matches the specified key.
The following elements are required:
company | (string) The associated setup company. |
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
ApiFinancialSetupResource
The following elements are required:
company | (string) The associated setup company. |
allowChangeCloseDate | (bool) Allow Changing the Close Date. |
closeAccountingAutomatically | (bool) Close Accounting Automatically. |
accountingPeriodicity | (enum AccountingPeriodicity) Periodicity.
See AccountingPeriodicity. |
The following elements are optional:
defaultReceiptType | (string) The default receipt's type to be used. |
defaultPaymentType | (string) The default payment’s type to be used. |
defaultCreditCashFlowItem | (string) he default cash flow item’s to be used. |
defaultDebitCashFlowItem | (string) The default cash flow item’s to be used for debit movements. |
mainBankAccountType | (string) The main bank account's type. |
lastAccountingPeriodCloseDate | (DateTime) Last Accounting Period Close Date. |
periodClosingDelay | (int) Period Closing Delay (days). |
FinancialSetupResource
The following elements are required:
company | (string) The associated setup company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
allowChangeCloseDate | (bool) Allow Changing the Close Date. |
closeAccountingAutomatically | (bool) Close Accounting Automatically. |
accountingPeriodicity | (enum AccountingPeriodicity) Periodicity.
See AccountingPeriodicity. |
The following elements are optional:
defaultReceiptType | (string) The default receipt's type to be used.
(fk) Allowed value: the natural key of a record of type ReceiptType. These records are accessibly through the ReceiptTypes service. |
defaultPaymentType | (string) The default payment’s type to be used.
(fk) Allowed value: the natural key of a record of type PaymentType. These records are accessibly through the PaymentTypes service. |
defaultCreditCashFlowItem | (string) he default cash flow item’s to be used.
(fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service. |
defaultDebitCashFlowItem | (string) The default cash flow item’s to be used for debit movements.
(fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service. |
mainBankAccountType | (string) The main bank account's type.
(fk) Allowed value: the natural key of a record of type BankAccountType. |
lastAccountingPeriodCloseDate | (DateTime) Last Accounting Period Close Date. |
periodClosingDelay | (int) Period Closing Delay (days). |