Financials | Financial Year
The Financial Year end point is used to record financial reporting and budgeting by a company or an organization. A financial year is most commonly used for accounting purposes to prepare financial statements. Although a financial ear can start on January 1st and end on December 31st, not all fiscal years correspond with the calendar year. For example, universities often begin and end their fiscal years according to the school year.
Overview
URL | api/{tenantKey}/{orgKey}/financialCore/financialYears |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET FinancialYears
- GET FinancialYears (paged)
- GET FinancialYear by identifier
- GET FinancialYear by key
- GET Print FinancialYear by identifier
- GET Print FinancialYear by key
- GET Original Print FinancialYearOriginal by identifier
- GET Original Print FinancialYear by key
- GET Check Period Is Closed By Company Key
- GET Get Company Financial Years
- POST:
-
PUT:
- PUT Set IsActive FinancialYear
- PUT Set Year FinancialYear
- PUT Set Company FinancialYear
- PUT Set Description FinancialYear
- PUT Set ApplyAutomaticClosingPeriod FinancialYear
- PUT Set NumberDaysAutomaticClosingPeriod FinancialYear
- PUT Set CopyFrom FinancialYear
- PUT Set HasClosingDocuments FinancialYear
- PUT Set HasOpeningDocuments FinancialYear
- PUT Set IsClosed FinancialYearPeriod
- PUT Set Purchases FinancialYearPeriod
- PUT Set Sales FinancialYearPeriod
- PUT Set AccountsPayable FinancialYearPeriod
- PUT Set AccountsReceivable FinancialYearPeriod
- PUT Set Accounting FinancialYearPeriod
- PUT Set Assets FinancialYearPeriod
- PUT Set Taxes FinancialYearPeriod
- PUT Set Stocks FinancialYearPeriod
- PUT Set Bank FinancialYearPeriod
- DELETE:
All Resources
This service uses the following resources:
- ApiFinancialYearFinancialYearPeriodsResource
- ApiFinancialYearResource
- FinancialYearPeriodResource
- FinancialYearResource
All Enumerations
This service uses the following enumerations:
GET FinancialYears
Returns the list of all the entity records available.
Response:
When successful, the response body contains the list of records available. See FinancialYearResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialYears (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 FinancialYearResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialYear 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 FinancialYearResource. |
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 FinancialYear by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
year | (int) The financial year. |
Response:
When successful, the response body contains the entity record. See FinancialYearResource. |
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 FinancialYear 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 FinancialYear by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
year | (int) The financial year. |
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 FinancialYearOriginal 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 FinancialYear by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
year | (int) The financial year. |
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 Check Period Is Closed By Company Key
This operation checks if a financial period of a given date is closed.
The following elements are required:
companyKey | (string) The Company Key. |
module | (string) The module. |
postingDate | (DateTime?) The posting date. |
Response:
When successful, the response body contains an item of type 'boolean'. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Company Financial Years
This operation gets a list of financial year for a company.
The following elements are required:
company | (string) The Company Key. |
Response:
When successful, the response body contains a list of resources of type 'FinancialYearResource'. See FinancialYearResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST FinancialYears
Creates a new entity record.
The following elements are required:
financialYearResource | (ApiFinancialYearResource) The request body should contain the entity record that should be created. See ApiFinancialYearResource. |
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 ApiFinancialYearResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Financial Year
Inserts a new 'Financial Year Period' in the 'Financial Year'.
The following elements are required:
year | (int) The financial year. |
companyKey | (string) The company key. |
value | (ApiFinancialYearFinancialYearPeriodsResource) The ApiFinancialYearFinancialYearPeriodsResource instance. See ApiFinancialYearFinancialYearPeriodsResource. |
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 Close Financial Year
This operation executes the financial year closing process which produces one or more closing documents.
The following elements are required:
company | (string) The Company Key. |
financialYear | (int) The Financial Year. |
Response:
When successful, the response body contains a list of strings. |
Resource URL:
POST Copy Accounts Balance
This operation executes the financial year opening process which produces one or more opening documents. The process involves closing the homologous financial year and copying the balances to the new financial year by creating account postings with each account's balance.
The following elements are required:
company | (string) The Company Key. |
financialYear | (int) The Financial Year. |
Response:
When successful, the response body contains a list of strings. |
Resource URL:
PUT Set Accounting FinancialYearPeriod
Updates the value of attribute 'Accounting' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set AccountsPayable FinancialYearPeriod
Updates the value of attribute 'AccountsPayable' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set AccountsReceivable FinancialYearPeriod
Updates the value of attribute 'AccountsReceivable' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set ApplyAutomaticClosingPeriod FinancialYear
Updates the value of attribute 'ApplyAutomaticClosingPeriod' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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. |
Resource URL:
PUT Set Assets FinancialYearPeriod
Updates the value of attribute 'Assets' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Bank FinancialYearPeriod
Updates the value of attribute 'Bank' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Company FinancialYear
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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 CopyFrom FinancialYear
Updates the value of attribute 'CopyFrom' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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 Description FinancialYear
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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 HasClosingDocuments FinancialYear
Updates the value of attribute 'HasClosingDocuments' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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. |
Resource URL:
PUT Set HasOpeningDocuments FinancialYear
Updates the value of attribute 'HasOpeningDocuments' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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. |
Resource URL:
PUT Set IsActive FinancialYear
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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 IsClosed FinancialYearPeriod
Updates the value of attribute 'IsClosed' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set NumberDaysAutomaticClosingPeriod FinancialYear
Updates the value of attribute 'NumberDaysAutomaticClosingPeriod' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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 Purchases FinancialYearPeriod
Updates the value of attribute 'Purchases' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Sales FinancialYearPeriod
Updates the value of attribute 'Sales' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Stocks FinancialYearPeriod
Updates the value of attribute 'Stocks' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Taxes FinancialYearPeriod
Updates the value of attribute 'Taxes' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
lineId | (string) The detail identifier. |
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. |
Resource URL:
PUT Set Year FinancialYear
Updates the value of attribute 'Year' in the specified entity record.
The following elements are required:
year | (int) The financial year. |
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:
DELETE Financial Year Period by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
year | (int) The financial year. |
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 FinancialYear 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 FinancialYear by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
year | (int) The financial year. |
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
ApiFinancialYearFinancialYearPeriodsResource
The following elements are required:
isClosed | (bool) If true all modules are automatically closed otherwise the property of the module define if is closed. |
purchases | (bool) If true the purchases module is closed. |
sales | (bool) If true the sales module is closed. |
accountsPayable | (bool) If true the accounts payable module is closed. |
accountsReceivable | (bool) If true the accounts receivable module is closed. |
accounting | (bool) If true the accounting module is closed. |
assets | (bool) If true the assets module is closed. |
taxes | (bool) If true the taxes module is closed. |
stocks | (bool) If true the stocks module is closed. |
bank | (bool) If true the bank module is closed. |
ApiFinancialYearResource
The following elements are required:
year | (int) The financial year. |
company | (string) The company key. |
applyAutomaticClosingPeriod | (bool) If true the system will automatically close the period after the number of days selected on number days for automatic closing. |
The following elements are optional:
description | (string) The financial year description. |
financialYearPeriods | (List of ApiFinancialYearFinancialYearPeriodsResource) The financial year period lines.
See ApiFinancialYearFinancialYearPeriodsResource. |
numberDaysAutomaticClosingPeriod | (int) The number days automatic closing period is used to define the number of days the previous period still open. |
copyFrom | (string) The financial year to copy data from (e.g. Journal Types). |
hasClosingDocuments | (bool) Has Closing Documents. |
hasOpeningDocuments | (bool) Has Opening Documents. |
FinancialYearPeriodResource
The following elements are required:
period | (int) The period number. |
periodName | (string) The period name. |
isClosed | (bool) If true all modules are automatically closed otherwise the property of the module define if is closed. |
purchases | (bool) If true the purchases module is closed. |
sales | (bool) If true the sales module is closed. |
accountsPayable | (bool) If true the accounts payable module is closed. |
accountsReceivable | (bool) If true the accounts receivable module is closed. |
accounting | (bool) If true the accounting module is closed. |
assets | (bool) If true the assets module is closed. |
taxes | (bool) If true the taxes module is closed. |
stocks | (bool) If true the stocks module is closed. |
bank | (bool) If true the bank module is closed. |
FinancialYearResource
The following elements are required:
year | (int) The financial year. |
company | (string) The company key. |
applyAutomaticClosingPeriod | (bool) If true the system will automatically close the period after the number of days selected on number days for automatic closing. |
yearType | (enum LedgerType) Type of Year(Actual or Forecast).
See LedgerType. |
The following elements are optional:
description | (string) The financial year description. |
financialYearPeriods | (List of FinancialYearPeriodResource) The financial year period lines.
See FinancialYearPeriodResource. |
numberDaysAutomaticClosingPeriod | (int) The number days automatic closing period is used to define the number of days the previous period still open. |
copyFrom | (string) The financial year to copy data from (e.g. Journal Types). |
hasClosingDocuments | (bool) Has Closing Documents. |
hasOpeningDocuments | (bool) Has Opening Documents. |