Retrieve a list of all fiscal years.

Table Specific Information

Select

The add-in uses the SAP Concur APIs to process filters that refer to Id, UserName, and ExternalId. The add-in processes other filters client-side within the add-in.

For example, the add-in offloads the processing of the following queries to the SAP Concur APIs:

SELECT * FROM FiscalYears WHERE IncludeRemoved = 'True'
SELECT * FROM FiscalYears WHERE LastModified > '2024-02-20 09:51:20.0'
SELECT * FROM FiscalPeriod WHERE fiscalYearId = '7af8977c-d996-4ca7-834a-a8e5b719fa95'

Insert

To create a fiscal year, the following columns are required: Name, StartDate, EndDate, Status and MonthlyFiscalPeriods.

MonthlyFiscalPeriods can either be an aggregate object containing the full list of fiscal periods or the name of a temp table.

Insert using a temp table:

INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('JAN', 'MONTHLY',  '2023-01-01', '2023-01-31', 'OPEN')
INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('FEB', 'MONTHLY',  '2023-02-01', '2023-02-28', 'OPEN')
INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('MAR', 'MONTHLY',  '2023-03-01', '2023-03-31', 'OPEN')

INSERT INTO FiscalYears (name, startDate, endDate,Status, MonthlyFiscalPeriods) VALUES ('NewPeriod', '2023-01-01', '2023-03-31', 'OPEN', 'FiscalPeriod#TEMP')

Insert using a JSON aggregate:

INSERT INTO FiscalYears (name, startDate, endDate,Status, MonthlyFiscalPeriods) VALUES ('NewPeriod', '2023-01-01', '2023-03-31', 'OPEN', '[{"name": "JAN","periodType": "MONTHLY","startDate": "2023-01-01","endDate": "2023-01-31","fiscalPeriodStatus": "OPEN"}]')

Update

The API treats update operations as a replace. The flow is the same as the INSERT operation with the difference that the Id of the fiscal year to be updated needs to be specified in the query.

INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('JAN', 'MONTHLY',  '2023-01-01', '2023-01-31', 'OPEN')
INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('FEB', 'MONTHLY',  '2023-02-01', '2023-02-28', 'OPEN')
INSERT INTO FiscalPeriod#TEMP (Name, PeriodType,StartDate,EndDate,Status) VALUES ('MAR', 'MONTHLY',  '2023-03-01', '2023-03-31', 'OPEN')

UPDATE FiscalYears SET startDate = '2023-01-01', endDate = '2023-03-31', Status = 'OPEN', Name = 'TEST' , MonthlyFiscalPeriods = 'FiscalPeriod#TEMP' WHERE id  = 'c891b0fb-ae64-45dc-84e4-a43d2adf4332'

Delete

In order to delete a fiscal year, the Id is required. You can specify the fiscal year Id in the query. Otherwise, the add-in resolves the Id internally by processing the criteria.

When Id is not specified, an extra request is issued to find the Id of all fiscal years with the name 'TEST'.

DELETE FROM fiscalYears WHERE name = 'TEST'

When Id is specified in the query, the add-in issues a DELETE request directly with no extra processing:

DELETE FROM fiscalYears WHERE Id = 'c891b0fb-ae64-45dc-84e4-a43d2adf4332'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The budget service's key for this object.
Name	String	False		The name of this fiscal year. Must be unique for this entity.
Status	String	False		The status of this fiscal year. Supported values: OPEN, CLOSED, REMOVED
StartDate	Date	False		The start date for this fiscal year. The distance between start date and end date may not be more than two years.
EndDate	Date	False		The end date for this fiscal year. The distance between start date and end date may not be more than two years.
CurrentYear	Boolean	False		True if this the current fiscal year based on the current date and time, False otherwise.
LastModified	Datetime	False		The UTC date and time when this object was last changed.
DisplayName	String	False		Display name for fiscal year. For date range budget item we use this field to display.
MonthlyFiscalPeriods	String	False		If true, the service will return all Fiscal Years, including those that were previously removed. If not supplied, this field defaults to false.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IncludeRemoved	Boolean	If true, the service will return all Fiscal Years, including those that were previously removed. If not supplied, this field defaults to false.