KFS Chart Web Services
isValidKFSCharts(kfsChartCode)
This service is used to validate KFS chart codes. Returns an XML result set with a value of true or false (example isValidKFSCharts result) for each chart
Input Specifications:
| Parameter | Description | Required? | Data Type (max length) |
|---|---|---|---|
| kfsChartCode | The KFS chart of accounts code | Yes | String (2) |
Logic:
select distinct
'IR',
case when not exists (select * FROM dwhs_ods..ca_chart_t a where a.fin_coa_cd= 'IR'
AND a.FIN_COA_ACTIVE_CD <> 'N' )
then 'false'
else 'true'
end
Result Schema:
Returns the chart code and true or false
| Parameter | Description | Data Type | Example |
|---|---|---|---|
| kfsChartCode | KFS Chart Code | String (2) | 'IR' |
| isValid | Is the Chart Active for that Fiscal Period? | boolean | true |
getValidKFSCharts(kfsChartCodes)
This service is used retrieve valid KFS chart codes and related attributes. Returns an XML result set with a list of charts (example getAllValidKFSCharts result).
Input Specifications:
| Parameter | Description | Required? | Data Type (max length) |
|---|---|---|---|
| kfsChartCodeList | A list of KFS chart of accounts code | Yes | A List of String (2) |
Logic:
SELECT FIN_COA_CD
,FIN_COA_DESC
,FIN_COA_ACTIVE_CD
,FIN_CASH_OBJ_CD
,FIN_AP_OBJ_CD
,INCBDGT_ELIMOBJ_CD
,EXPBDGT_ELIMOBJ_CD
,RPTS_TO_FIN_COA_CD
,FIN_AR_OBJ_CD
,FIN_INT_ENC_OBJ_CD
,FIN_EXT_ENC_OBJ_CD
,FIN_PRE_ENC_OBJ_CD
,ICR_INC_FIN_OBJ_CD
,ICR_EXP_FIN_OBJ_CD
,FND_BAL_OBJ_CD
FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N'
and FIN_COA_CD IN ('<kfsChartCode1>', '<kfsChartCode2>', etc)
Result Schema: A list of following element
| Parameter | Description | Data Type | Example |
|---|---|---|---|
| kfsChartCode | KFS Chart Code | String (2) | 'IR' |
| kfsChartDescription | KFS Chart Description | String (40) | 'Irvine' |
| kfsChartActiveCode | KFS Chart Active Code ('Y' for yes, 'N' for no) | String (1) | 'Y' |
| kfsFinCashObjCode | KFS Cash Object Code | String (4) | '0000' |
| kfsFinAPObjCode | KFS Accounts Payable Object Code | String (4) | '0000' |
| kfsIncBdgtElimObjCode | KFS Income Budget Elimination Object Code | String (4) | '0000' |
| kfsExpBdgtElimObjCode | KFS Expense Budget Elimination Object Code | String (4) | '0000' |
| kfsRptsToChartCode | KFS Reports to Chart Code | String (2) | 'MC' |
| kfsARObjCode | KFS Accounts Receivable Object Code | String (4) | '0000' |
| kfsIntEncObjCode | KFS Internal Encumbrances Object Code | String (4) | '0000' |
kfsExtEncObjCode | KFS External Encumbrances Object Code | String (4) | '0000' |
| kfsPreEncObjCode | KFS Pre Encumbrances Object Code | String (4) | '0000' |
| kfsICRIncObjCode | KFS Indirect Cost Recovery Income Object Code | String (4) | '0000' |
| kfsICRExpObjCode | KFS Indirect Cost Recovery Expense Object Code | String (4) | '0000' |
| kfsFundBalObjCode | KFS Fund Balance Object Code | String (4) | '0000' |
getAllKFSCharts()
No input parameter, ALL charts will return in result set.
Logic:
SELECT FIN_COA_CD
,FIN_COA_DESC
,FIN_COA_ACTIVE_CD
,FIN_CASH_OBJ_CD
,FIN_AP_OBJ_CD
,INCBDGT_ELIMOBJ_CD
,EXPBDGT_ELIMOBJ_CD
,RPTS_TO_FIN_COA_CD
,FIN_AR_OBJ_CD
,FIN_INT_ENC_OBJ_CD
,FIN_EXT_ENC_OBJ_CD
,FIN_PRE_ENC_OBJ_CD
,ICR_INC_FIN_OBJ_CD
,ICR_EXP_FIN_OBJ_CD
,FND_BAL_OBJ_CD
FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N'
Result Schema: A list of following element
| Parameter | Description | Data Type | Example |
|---|---|---|---|
| kfsChartCode | KFS Chart Code | String (2) | 'IR' |
| kfsChartDescription | KFS Chart Description | String (40) | 'Irvine' |
| kfsChartActiveCode | KFS Chart Active Code ('Y' for yes, 'N' for no) | String (1) | 'Y' |
| kfsFinCashObjCode | KFS Cash Object Code | String (4) | '0000' |
| kfsFinAPObjCode | KFS Accounts Payable Object Code | String (4) | '0000' |
| kfsIncBdgtElimObjCode | KFS Income Budget Elimination Object Code | String (4) | '0000' |
| kfsExpBdgtElimObjCode | KFS Expense Budget Elimination Object Code | String (4) | '0000' |
| kfsRptsToChartCode | KFS Reports to Chart Code | String (2) | 'MC' |
| kfsARObjCode | KFS Accounts Receivable Object Code | String (4) | '0000' |
| kfsIntEncObjCode | KFS Internal Encumbrances Object Code | String (4) | '0000' |
kfsExtEncObjCode | KFS External Encumbrances Object Code | String (4) | '0000' |
| kfsPreEncObjCode | KFS Pre Encumbrances Object Code | String (4) | '0000' |
| kfsICRIncObjCode | KFS Indirect Cost Recovery Income Object Code | String (4) | '0000' |
| kfsICRExpObjCode | KFS Indirect Cost Recovery Expense Object Code | String (4) | '0000' |
| kfsFundBalObjCode | KFS Fund Balance Object Code | String (4) | '0000' |