Financials | Financial Calendar
The Financial Calendar is used to record information about the financial calendar. The financial calendar consists of twelve operating periods (1-12 represent a calendar month), one opening period (same month as the first period) and up to three closing periods (same month as period 12).
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/financialCalendars |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET FinancialCalendars
- GET FinancialCalendars (paged)
- GET FinancialCalendar by identifier
- GET FinancialCalendar by key
- GET Print FinancialCalendar by identifier
- GET Print FinancialCalendar by key
- GET Original Print FinancialCalendarOriginal by identifier
- GET Original Print FinancialCalendar by key
- GET Get Date Time Financial Date By Company Key
- GET Get Calendar Date By Company Key
- GET Get Financial Periods For Reference Date
- POST:
-
PUT:
- PUT Set IsActive FinancialCalendar
- PUT Set CalendarKey FinancialCalendar
- PUT Set Description FinancialCalendar
- PUT Set NumberOfClosingPeriods FinancialCalendar
- PUT Set EndMonth FinancialCalendar
- PUT Set FinancialYearOffset FinancialCalendar
- PUT Set Period FinancialPeriod
- PUT Set Name FinancialPeriod
- PUT Set PeriodType FinancialPeriod
- PUT Set CalendarMonth FinancialPeriod
- DELETE:
All Resources
This service uses the following resources:
- ApiFinancialCalendarFinancialPeriodsResource
- ApiFinancialCalendarResource
- FinancialCalendarResource
- FinancialDate
- FinancialPeriodResource
All Enumerations
This service uses the following enumerations:
GET FinancialCalendars
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See FinancialCalendarResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialCalendars (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 FinancialCalendarResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FinancialCalendar 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 FinancialCalendarResource. |
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 FinancialCalendar by key
Returns the entity record that matches the specified key.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
Response:
| When successful, the response body contains the entity record. See FinancialCalendarResource. |
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 FinancialCalendar 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 FinancialCalendar by key
Prints the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
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 FinancialCalendarOriginal 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 FinancialCalendar by key
Prints the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
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 Get Date Time Financial Date By Company Key
This operation gets the Financial Year and Financial Period given a Company Key and a Date.
The following elements are required:
| companyKey | (string) The Company Key. |
| referenceDate | (DateTime?) The reference date. |
Response:
| When successful, the response body contains a resource of type 'FinancialDate'. See FinancialDate. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Calendar Date By Company Key
This operation gets the Calendar date (last day) given a Company Key, Financial Year and a Financial Period.
The following elements are required:
| companyKey | (string) The Company Key. |
| financialYear | (int) The Financial Year. |
| period | (int) The Financial Period. |
Response:
| When successful, the response body contains an item of type 'date'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Financial Periods For Reference Date
This operation gets all Periods given a reference date.
The following elements are required:
| companyId | (Guid) The Company Identifier. |
| taxClassId | (Guid) The Tax Class Identifier. |
| referenceDate | (DateTime?) The Reference Date. |
Response:
| When successful, the response body contains a list of resources of type 'FinancialDate'. See FinancialDate. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST FinancialCalendars
Creates a new entity record.
The following elements are required:
| financialCalendarResource | (ApiFinancialCalendarResource) The request body should contain the entity record that should be created. See ApiFinancialCalendarResource. |
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 ApiFinancialCalendarResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Financial Calendar
Inserts a new 'Financial Period' in the 'Financial Calendar'.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| value | (ApiFinancialCalendarFinancialPeriodsResource) The ApiFinancialCalendarFinancialPeriodsResource instance. See ApiFinancialCalendarFinancialPeriodsResource. |
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 CalendarKey FinancialCalendar
Updates the value of attribute 'CalendarKey' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar 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 CalendarMonth FinancialPeriod
Updates the value of attribute 'CalendarMonth' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| lineId | (string) The detail identifier. |
| value | (enum Month) The request body should contain the new value for the attribute. See Month. |
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 FinancialCalendar
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar 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 EndMonth FinancialCalendar
Updates the value of attribute 'EndMonth' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| value | (enum Month) The request body should contain the new value for the attribute. See Month. |
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 FinancialYearOffset FinancialCalendar
Updates the value of attribute 'FinancialYearOffset' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| value | (enum FinancialYearOffset) The request body should contain the new value for the attribute. See FinancialYearOffset. |
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 FinancialCalendar
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar 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 Name FinancialPeriod
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| lineId | (string) The detail identifier. |
| 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 NumberOfClosingPeriods FinancialCalendar
Updates the value of attribute 'NumberOfClosingPeriods' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar 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 Period FinancialPeriod
Updates the value of attribute 'Period' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| lineId | (string) The detail identifier. |
| 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 PeriodType FinancialPeriod
Updates the value of attribute 'PeriodType' in the specified entity record.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| lineId | (string) The detail identifier. |
| value | (enum PeriodType) The request body should contain the new value for the attribute. See PeriodType. |
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 Period by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| calendarKey | (string) The financial calendar 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 FinancialCalendar 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 FinancialCalendar by key
Deletes the entity record that matches the specified key.
The following elements are required:
| calendarKey | (string) The financial calendar key. |
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
ApiFinancialCalendarFinancialPeriodsResource
The following elements are required:
| period | (int) The period number. |
| name | (string) The name of the period. |
| periodType | (enum PeriodType) The period type (opening, regular, closing).
See PeriodType. |
| calendarMonth | (enum Month) The calendar month.
See Month. |
ApiFinancialCalendarResource
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| numberOfClosingPeriods | (int) The number of closing periods. |
| endMonth | (enum Month) The last month of the financial calendar.
See Month. |
The following elements are optional:
| description | (string) Enter a description of the calendar. |
| financialPeriods | (List of ApiFinancialCalendarFinancialPeriodsResource) The financial calendar periods.
See ApiFinancialCalendarFinancialPeriodsResource. |
| financialYearOffset | (enum FinancialYearOffset) The offset of the financial year. Choose if the the company works on the next year at the begining of the financial year or at the previous year at the end of the financial year. Only available if the end month is not december.
See FinancialYearOffset. |
FinancialCalendarResource
The following elements are required:
| calendarKey | (string) The financial calendar key. |
| numberOfClosingPeriods | (int) The number of closing periods. |
| endMonth | (enum Month) The last month of the financial calendar.
See Month. |
The following elements are optional:
| description | (string) Enter a description of the calendar. |
| financialPeriods | (List of FinancialPeriodResource) The financial calendar periods.
See FinancialPeriodResource. |
| financialYearOffset | (enum FinancialYearOffset) The offset of the financial year. Choose if the the company works on the next year at the begining of the financial year or at the previous year at the end of the financial year. Only available if the end month is not december.
See FinancialYearOffset. |
FinancialDate
The following elements are required:
| financialYear | (int) The financial year. |
| period | (int) The financial period. |
| periodName | (string) The period name (internal). |
| financialYearId | (Guid) The financial year identifier. |
The following elements are optional:
| isActive | (bool) Indicates whether the resource is active. |
| date | (DateTime) The financial date. |
FinancialPeriodResource
The following elements are required:
| period | (int) The period number. |
| name | (string) The name of the period. |
| periodType | (enum PeriodType) The period type (opening, regular, closing).
See PeriodType. |
| calendarMonth | (enum Month) The calendar month.
See Month. |