Financials | Financial Settings

Service to manage entities of type 'FinancialSetup'.

Overview

api/{tenantKey}/{orgKey}/financialCore/financialSetups

URL	api/{tenantKey}/{orgKey}/financialCore/financialSetups
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST FinancialSetups
PUT:
DELETE:
- DELETE FinancialSetup by identifier
- DELETE FinancialSetup by key

All Resources

This service uses the following resources:

ApiFinancialSetupResource
FinancialSetupResource

All Enumerations

This service uses the following enumerations:

AccountingPeriodicity

GET Operations

GET FinancialSetups

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups

GET /financialCore/financialSetups

GET FinancialSetups (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 FinancialSetupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialSetups?page={page}&pageSize={pageSize}

GET /financialCore/financialSetups?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{id}

GET /financialCore/financialSetups/{id}

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}

GET /financialCore/financialSetups/{company}

GET Print FinancialSetup 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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{id}/print?template={template}

GET /financialCore/financialSetups/{id}/print?template={template}

GET Print FinancialSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The associated setup company.

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/print

GET /financialCore/financialSetups/{company}/print

GET Original Print FinancialSetupOriginal 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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{id}/printOriginal?template={template}

GET /financialCore/financialSetups/{id}/printOriginal?template={template}

GET Original Print FinancialSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The associated setup company.

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/printOriginal

GET /financialCore/financialSetups/{company}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups

POST /financialCore/financialSetups

PUT Operations

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/accountingPeriodicity

PUT /financialCore/financialSetups/{company}/accountingPeriodicity

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/allowChangeCloseDate

PUT /financialCore/financialSetups/{company}/allowChangeCloseDate

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/closeAccountingAutomatically

PUT /financialCore/financialSetups/{company}/closeAccountingAutomatically

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/company

PUT /financialCore/financialSetups/{company}/company

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/defaultCreditCashFlowItem

PUT /financialCore/financialSetups/{company}/defaultCreditCashFlowItem

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/defaultDebitCashFlowItem

PUT /financialCore/financialSetups/{company}/defaultDebitCashFlowItem

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/defaultPaymentType

PUT /financialCore/financialSetups/{company}/defaultPaymentType

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/defaultReceiptType

PUT /financialCore/financialSetups/{company}/defaultReceiptType

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/isActive

PUT /financialCore/financialSetups/{company}/isActive

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/lastAccountingPeriodCloseDate

PUT /financialCore/financialSetups/{company}/lastAccountingPeriodCloseDate

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/mainBankAccountType

PUT /financialCore/financialSetups/{company}/mainBankAccountType

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}/periodClosingDelay

PUT /financialCore/financialSetups/{company}/periodClosingDelay

DELETE Operations

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{id}

DELETE /financialCore/financialSetups/{id}

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:

api/{tenantKey}/{orgKey}/financialCore/financialSetups/{company}

DELETE /financialCore/financialSetups/{company}

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

Enumerations

AccountingPeriodicity

1	Monthly
2	Quarterly
3	Annual