Master

Master Service APIs

APIs to create, update or search masters.

Get the list of funds

post

funds

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 50Optional

name is the name of the fund . Example :Municipal Fund,Capital Fund. Also name is unique.

codestring · max: 50Optional

code is a unique number given to each fund . ULB may refer this for the short name

identifierstringOptional

identifier of the Fund

parentinteger · int64Optional

parent adding a parent will create the fund as a sub-fund (child) of a fund already created (parent fund).

activebooleanOptional

active is a boolean value which says whether fund is in use or not . If Fund is active, then accounting of transactions under the fund is enabled. If Fund becomes inactive, and no transactions can be accounted under the Fund.

isParentbooleanOptional

isParent is updated internally so that system can identify whether the fund is parent or child. Only child which is not parent for any other fund can only participate in transaction .

levelinteger · int64Optional

level identifies what is the level of the fund in the tree structure. Top most parent will have level 0 and its child will have level as 1

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Fund retrieved Successfully

*/*
post
/funds/_search

Create new funds

post

Create new funds

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Fund items are used in case of create or update

Responses
post
/funds/_create

Update any of the funds

post

Update any of the funds

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Fund items are used in case of create or update

Responses
200

Fund updated Successfully

*/*
post
/funds/_update

Get the list of financialyears

post

financialyears

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

finYearRangestring · max: 25Optional

finYearRange is the name of the Financial Year . for example for accounting year 2017 and 2018 it may be named 2017-18

startingDatestring · dateOptional

startingDate is the date on which Accounting Year starts. Usually it is 1st April of that year.

endingDatestring · dateOptional

endingDate is the date on which Financial Year ends. Usually it is 31st march of next year

activebooleanOptional

active says whether Financial Year is active or not . Over a period system will have number of Financial years. Reports ,searches,transactions will need to display this.If the active value is true then Financial Year is listed, if value is false it wont be listed

isActiveForPostingbooleanOptional

isActiveForPosting refers whether posting allowed for the Financial Year or not . This value will be true for current year and few previous year for which data entry will be happening. Once the account is closed this value is set to false . All transactions will happen if and only if isActiveForPosting is true

isClosedbooleanOptional

isClosed refers whether the account is closed or not . Once the account is closed and balance is transferred this value is set to false if the account is closed no transaction can happen on that financial year.

transferClosingBalancebooleanOptional

transferClosingBalance informs whether While closing account balance is transferred or not .

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

FinancialYear retrieved Successfully

*/*
post
/financialyears/_search

Create new financialyears

post

Create new financialyears

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialYear items are used in case of create or update

Responses
post
/financialyears/_create

Update any of the financialyears

post

Update any of the financialyears

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialYear items are used in case of create or update

Responses
200

FinancialYear updated Successfully

*/*
post
/financialyears/_update

Get the list of fiscalperiods

post

fiscalperiods

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 25Optional

name of the FiscalPeriod

financialYearinteger · int64Optional

financial year of the FiscalPeriod

startingDatestring · dateOptional

startingDate is the date on which period starts.

endingDatestring · dateOptional

endingDate is the date on which period ends.

activebooleanOptional

active says whether fiscal period is active or not . Over a period system will have number of fiscal period. Reports ,searches,transactions will need to display this.If the active value is true then fiscal period is listed, if value is false it wont be listed

isActiveForPostingbooleanOptional

isActiveForPosting refers whether posting allowed for the fiscal period or not . This value will be true for current year and few previous year for which data entry will be happening. Once the account is closed this value is set to false . All transactions will happen if and only if isActiveForPosting is true

isClosedbooleanOptional

isClosed refers whether the account is closed or not . Once the account is closed and balance is transferred this value is set to false if the account is closed no transaction can happen on that fiscal period.

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

FiscalPeriod retrieved Successfully

*/*
post
/fiscalperiods/_search

Create new fiscalperiods

post

Create new fiscalperiods

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FiscalPeriod items are used in case of create or update

Responses
post
/fiscalperiods/_create

Update any of the fiscalperiods

post

Update any of the fiscalperiods

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FiscalPeriod items are used in case of create or update

Responses
200

FiscalPeriod updated Successfully

*/*
post
/fiscalperiods/_update

Get the list of functions

post

functions

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 128Optional

name is the name of the function .

codestring · max: 16Optional

code is a unique number given to each function . ULBs may refer this for the short name.

levelinteger · int32Optional

level identifies what is the level of the function in the tree structure. Top most parent will have level 0 and its child will have level as 1

activebooleanOptional

active is a boolean value which says whether function is in use or not . If Function is active, then accounting of transactions under the Function is enabled. If Function becomes inactive, and no transactions can be accounted under the Function. Only leaf function can be used in transaction ie function which is not parent to any other function

parentIdinteger · int64Optional

parent id of the Function

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Function retrieved Successfully

*/*
post
/functions/_search

Create new functions

post

Create new functions

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Function items are used in case of create or update

Responses
post
/functions/_create

Update any of the functions

post

Update any of the functions

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Function items are used in case of create or update

Responses
200

Function updated Successfully

*/*
post
/functions/_update

Get the list of functionaries

post

functionaries

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

codestring · max: 16Optional

code is uniue identifier and ULB may refer this for short name.

namestring · max: 256Optional

name is the name of the functionary

activebooleanOptional

active states whether the functionary is active or not . Only active functionaries will be used in transaction

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Functionary retrieved Successfully

*/*
post
/functionaries/_search

Create new functionaries

post

Create new functionaries

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Functionary items are used in case of create or update

Responses
post
/functionaries/_create

Update any of the functionaries

post

Update any of the functionaries

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Functionary items are used in case of create or update

Responses
200

Functionary updated Successfully

*/*
post
/functionaries/_update

Get the list of fundsources

post

fundsources

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

codestring · max: 25Optional

code of the Fundsource

namestring · max: 25Optional

name of the Fundsource

typestring · max: 25Optional

type of the Fundsource

parentinteger · int64Optional

parent of the Fundsource

llevelnumber · doubleOptional

llevel of the Fundsource

activebooleanOptional

Whether Fundsource is Active or not. If the value is TRUE, then Fundsource is active,If the value is FALSE then Fundsource is inactive,Default value is TRUE

isParentbooleanOptional

is parent of the Fundsource

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Fundsource retrieved Successfully

*/*
post
/fundsources/_search

Create new fundsources

post

Create new fundsources

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Fundsource items are used in case of create or update

Responses
post
/fundsources/_create

Update any of the fundsources

post

Update any of the fundsources

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Fundsource items are used in case of create or update

Responses
200

Fundsource updated Successfully

*/*
post
/fundsources/_update

Get the list of schemes

post

schemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

fundinteger · int64Optional

fund of the Scheme

codestring · max: 25Optional

code of the Scheme

namestring · max: 25Optional

name of the Scheme

validFromstring · dateOptional

valid from of the Scheme

validTostring · dateOptional

valid to of the Scheme

activebooleanOptional

Whether Scheme is Active or not. If the value is TRUE, then Scheme is active,If the value is FALSE then Scheme is inactive,Default value is TRUE

descriptionstring · max: 256Optional

description of the Scheme

boundarystringOptional

boundary of the Scheme

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Scheme retrieved Successfully

*/*
post
/schemes/_search

Create new schemes

post

Create new schemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Scheme items are used in case of create or update

Responses
post
/schemes/_create

Update any of the schemes

post

Update any of the schemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Scheme items are used in case of create or update

Responses
200

Scheme updated Successfully

*/*
post
/schemes/_update

Get the list of banks

post

banks

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

codestringOptional

code is the code of the bank

namestringOptional

name is the Bank Name .

descriptionstringOptional

description more detailed description of the bank

activebooleanOptional

active states whether the bank is active in the system or not .

typestringOptional

type of the Bank

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Bank retrieved Successfully

*/*
post
/banks/_search

Create new banks

post

Create new banks

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Bank items are used in case of create or update

Responses
post
/banks/_create

Update any of the banks

post

Update any of the banks

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Bank items are used in case of create or update

Responses
200

Bank updated Successfully

*/*
post
/banks/_update

Get the list of bankbranches

post

bankbranches

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

bankinteger · int64Optional

bank is the bank of the branch

codestring · max: 50Optional

code is the branch code

namestring · max: 50Optional

name is the branch name

addressstring · max: 50Optional

address2 is the secondary address of the branch

address2string · max: 50Optional

address2 of the BankBranch

citystring · max: 50Optional

city is the name of the bank branches city

statestring · max: 50Optional

state is the name of the state

pincodestring · max: 50Optional

pincode is the pincode of the branch

phonestring · max: 15Optional

phone is the phone number of the branch

faxstring · max: 15Optional

fax is the fax number of the branch

contactPersonstring · max: 50Optional

contactPerson is the name of the person in contact

activebooleanOptional

active states whether branch is active. i.e is usable by the system or not if not active it cannot be used

descriptionstring · max: 256Optional

description is the more detailed description of the branch

micrstring · max: 50Optional

micr is the micr code of the bank branch

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

BankBranch retrieved Successfully

*/*
post
/bankbranches/_search

Create new bankbranches

post

Create new bankbranches

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BankBranch items are used in case of create or update

Responses
post
/bankbranches/_create

Update any of the bankbranches

post

Update any of the bankbranches

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BankBranch items are used in case of create or update

Responses
200

BankBranch updated Successfully

*/*
post
/bankbranches/_update

Get the list of bankaccounts

post

bankaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

bankBranchinteger · int64Optional

bank branch of the BankAccount

chartOfAccountinteger · int64Optional

chart of account of the BankAccount

fundinteger · int64Optional

fund of the BankAccount

accountNumberstring · max: 25Optional

account number of the BankAccount

accountTypestringOptional

account type of the BankAccount

descriptionstring · max: 256Optional

description of the BankAccount

activebooleanOptional

Whether BankAccount is Active or not. If the value is TRUE, then BankAccount is active,If the value is FALSE then BankAccount is inactive,Default value is TRUE

payTostringOptional

pay to of the BankAccount

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

BankAccount retrieved Successfully

*/*
post
/bankaccounts/_search

Create new bankaccounts

post

Create new bankaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BankAccount items are used in case of create or update

Responses
post
/bankaccounts/_create

Update any of the bankaccounts

post

Update any of the bankaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BankAccount items are used in case of create or update

Responses
200

BankAccount updated Successfully

*/*
post
/bankaccounts/_update

Get the list of subschemes

post

subschemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

schemeinteger · int64Optional

scheme of the SubScheme

codestring · max: 50Optional

code of the SubScheme

namestring · max: 50Optional

name of the SubScheme

validFromstring · dateOptional

valid from of the SubScheme

validTostring · dateOptional

valid to of the SubScheme

activebooleanOptional

Whether SubScheme is Active or not. If the value is TRUE, then SubScheme is active,If the value is FALSE then SubScheme is inactive,Default value is TRUE

departmentIdstringOptional

department id of the SubScheme

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

SubScheme retrieved Successfully

*/*
post
/subschemes/_search

Create new subschemes

post

Create new subschemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of SubScheme items are used in case of create or update

Responses
post
/subschemes/_create

Update any of the subschemes

post

Update any of the subschemes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of SubScheme items are used in case of create or update

Responses
200

SubScheme updated Successfully

*/*
post
/subschemes/_update

Get the list of suppliers

post

suppliers

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

codestring · max: 50Optional

code of the Supplier

namestring · max: 50Optional

name of the Supplier

addressstring · max: 300Optional

address of the Supplier

mobilestring · max: 10Optional

mobile of the Supplier

emailstring · max: 25Optional

email of the Supplier

descriptionstring · max: 250Optional

description of the Supplier

activebooleanOptional

Whether Supplier is Active or not. If the value is TRUE, then Supplier is active,If the value is FALSE then Supplier is inactive,Default value is TRUE

panNostring · max: 10Optional

pan no of the Supplier

tinNostring · max: 20Optional

tin no of the Supplier

registationNostring · max: 25Optional

registation no of the Supplier

bankAccountinteger · int64Optional

bank account of the Supplier

ifscCodestring · max: 12Optional

ifsc code of the Supplier

bankinteger · int64Optional

bank of the Supplier

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

Supplier retrieved Successfully

*/*
post
/suppliers/_search

Create new suppliers

post

Create new suppliers

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Supplier items are used in case of create or update

Responses
post
/suppliers/_create

Update any of the suppliers

post

Update any of the suppliers

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of Supplier items are used in case of create or update

Responses
200

Supplier updated Successfully

*/*
post
/suppliers/_update

Get the list of accountdetailtypes

post

accountdetailtypes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 50Optional

name of the AccountDetailType

descriptionstring · max: 50Optional

description of the AccountDetailType

tableNamestring · max: 25Optional

table name of the AccountDetailType

activebooleanOptional

Whether AccountDetailType is Active or not. If the value is TRUE, then AccountDetailType is active,If the value is FALSE then AccountDetailType is inactive,Default value is TRUE

fullyQualifiedNamestring · max: 250Optional

fully qualified name of the AccountDetailType

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

AccountDetailType retrieved Successfully

*/*
post
/accountdetailtypes/_search

Create new accountdetailtypes

post

Create new accountdetailtypes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountDetailType items are used in case of create or update

Responses
post
/accountdetailtypes/_create

Update any of the accountdetailtypes

post

Update any of the accountdetailtypes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountDetailType items are used in case of create or update

Responses
200

AccountDetailType updated Successfully

*/*
post
/accountdetailtypes/_update

Get the list of accountdetailkeys

post

accountdetailkeys

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

keystringOptional

key of the AccountDetailKey

accountDetailTypeinteger · int64Optional

account detail type of the AccountDetailKey

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

AccountDetailKey retrieved Successfully

*/*
post
/accountdetailkeys/_search

Create new accountdetailkeys

post

Create new accountdetailkeys

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountDetailKey items are used in case of create or update

Responses
post
/accountdetailkeys/_create

Update any of the accountdetailkeys

post

Update any of the accountdetailkeys

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountDetailKey items are used in case of create or update

Responses
200

AccountDetailKey updated Successfully

*/*
post
/accountdetailkeys/_update

Get the list of accountentities

post

accountentities

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

accountDetailTypeinteger · int64Optional

account detail type of the AccountEntity

codestring · max: 25Optional

code of the AccountEntity

namestring · max: 350Optional

name of the AccountEntity

activebooleanOptional

Whether AccountEntity is Active or not. If the value is TRUE, then AccountEntity is active,If the value is FALSE then AccountEntity is inactive,Default value is TRUE

descriptionstring · max: 256Optional

description of the AccountEntity

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

AccountEntity retrieved Successfully

*/*
post
/accountentities/_search

Create new accountentities

post

Create new accountentities

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountEntity items are used in case of create or update

Responses
post
/accountentities/_create

Update any of the accountentities

post

Update any of the accountentities

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountEntity items are used in case of create or update

Responses
200

AccountEntity updated Successfully

*/*
post
/accountentities/_update

Get the list of accountcodepurposes

post

accountcodepurposes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 256Optional

name of the AccountCodePurpose

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

AccountCodePurpose retrieved Successfully

*/*
post
/accountcodepurposes/_search

Create new accountcodepurposes

post

Create new accountcodepurposes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountCodePurpose items are used in case of create or update

Responses
post
/accountcodepurposes/_create

Update any of the accountcodepurposes

post

Update any of the accountcodepurposes

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of AccountCodePurpose items are used in case of create or update

Responses
200

AccountCodePurpose updated Successfully

*/*
post
/accountcodepurposes/_update

Get the list of chartofaccounts

post

chartofaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

glcodestring · max: 16Optional

glcode is the Account Code or Account Head in Accounting terms.It may be Major head,Minor head or Detailed head.It is numeric examples are 1,110,1101,1101001,2,210,21000,210010

namestring · max: 128Optional

name is the name of the account code . for example 110 glcode has the name "Tax Revenue"

accountCodePurposeinteger · int64Optional

accountCodePurpose is the mapped AccountCodePurpose . This mapping can happen at any level say Major,minor or detailed. When Account code is searched 1. If mapped at major code then it lists major and all other codes under that major code 2. If mapped at minor code then it list minor code and all other codes under that minor code 3. If mapped at detailed code then it lists only that code

descriptionstring · max: 256Optional

description is the more detailed description about the account code

isActiveForPostingbooleanOptional

isActiveForPosting true will be considered for transactions. All major,minor codes will be false and only detailed code will be true . Further any account code can be disabled for transaction by making this field false

parentIdinteger · int64Optional

parentId is the id of other account code in the chart of account .Chart of account is created in tree structure. Any code can have other code as parent . All minor code will have manjor code as parent . All detailed code will have minor code as parent only leaf account code that is which is not parent for any account code will used for transactions.

typestringOptional

type is a single character representation of account code type I: Income E: Expenditure L: Liability A: Asset Account code for all I start with 1 Account code for all E start with 2 Account code for all L start with 3 Account code for all A start with 4

classificationinteger · int64Optional

classification is internal to the system. This tells whether the code is Major ,Minor,Subminor or detailed. Major code classification value is 1 Minor code is 2 Subminor code is 3 Detailed code is 4. Only classification 4 and is activeforposting=true will be used in transactions. Reports can be generated at any level.

functionRequiredbooleanOptional

functionRequired field specifies while transacting with this accountcode is the function is mandatory or not . For any account code this field is set to true then all transactions expect a fun=ction code to be passed along with account code

budgetCheckRequiredbooleanOptional

budgetCheckRequired field specifies whether budgeting check required for this account code. Apart from global Budgetcheck configuration this is where glcode wise budget check decision is made.

majorCodestring · max: 16Optional

major code of the ChartOfAccount

isSubLedgerbooleanOptional

is sub ledger of the ChartOfAccount

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

ChartOfAccount retrieved Successfully

*/*
post
/chartofaccounts/_search

Create new chartofaccounts

post

Create new chartofaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of ChartOfAccount items are used in case of create or update

Responses
post
/chartofaccounts/_create

Update any of the chartofaccounts

post

Update any of the chartofaccounts

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of ChartOfAccount items are used in case of create or update

Responses
200

ChartOfAccount updated Successfully

*/*
post
/chartofaccounts/_update

Get the list of chartofaccountdetails

post

chartofaccountdetails

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

chartOfAccountinteger · int64Optional

chart of account of the ChartOfAccountDetail

accountDetailTypeinteger · int64Optional

account detail type of the ChartOfAccountDetail

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

ChartOfAccountDetail retrieved Successfully

*/*
post
/chartofaccountdetails/_search

Create new chartofaccountdetails

post

Create new chartofaccountdetails

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of ChartOfAccountDetail items are used in case of create or update

Responses
post
/chartofaccountdetails/_create

Update any of the chartofaccountdetails

post

Update any of the chartofaccountdetails

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of ChartOfAccountDetail items are used in case of create or update

Responses
200

ChartOfAccountDetail updated Successfully

*/*
post
/chartofaccountdetails/_update

Get the list of budgetgroups

post

budgetgroups

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestring · max: 250Optional

name of the BudgetGroup

descriptionstring · max: 250Optional

description of the BudgetGroup

majorCodeinteger · int64Optional

major code of the BudgetGroup

maxCodeinteger · int64Optional

max code of the BudgetGroup

minCodeinteger · int64Optional

min code of the BudgetGroup

activebooleanOptional

Whether BudgetGroup is Active or not. If the value is TRUE, then BudgetGroup is active,If the value is FALSE then BudgetGroup is inactive,Default value is TRUE

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

BudgetGroup retrieved Successfully

*/*
post
/budgetgroups/_search

Create new budgetgroups

post

Create new budgetgroups

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BudgetGroup items are used in case of create or update

Responses
post
/budgetgroups/_create

Update any of the budgetgroups

post

Update any of the budgetgroups

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of BudgetGroup items are used in case of create or update

Responses
200

BudgetGroup updated Successfully

*/*
post
/budgetgroups/_update

Get the list of financialstatuses

post

financialstatuses

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

moduleTypestringOptional

module type of the FinancialStatus

codestringOptional

code of the FinancialStatus

namestringOptional

name of the FinancialStatus

descriptionstringOptional

description of the FinancialStatus

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

FinancialStatus retrieved Successfully

*/*
post
/financialstatuses/_search

Create new financialstatuses

post

Create new financialstatuses

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialStatus items are used in case of create or update

Responses
post
/financialstatuses/_create

Update any of the financialstatuses

post

Update any of the financialstatuses

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialStatus items are used in case of create or update

Responses
200

FinancialStatus updated Successfully

*/*
post
/financialstatuses/_update

Get the list of financialconfigurations

post

financialconfigurations

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[] · max: 50Optional

comma seperated list of Ids

namestringOptional

name of the FinancialConfiguration

descriptionstringOptional

description of the FinancialConfiguration

modulestringOptional

module of the FinancialConfiguration

pageSizeinteger · int32Optional

pageSize

offsetinteger · int32Optional

offset

sortBystringOptional

This takes any field from the Object seperated by comma and asc,desc keywords.
example name asc,code desc or name,code or name,code desc

Body

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200

FinancialConfiguration retrieved Successfully

*/*
post
/financialconfigurations/_search

Create new financialconfigurations

post

Create new financialconfigurations

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialConfiguration items are used in case of create or update

Responses
post
/financialconfigurations/_create

Update any of the financialconfigurations

post

Update any of the financialconfigurations

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

Body

Contract class for web request. Array of FinancialConfiguration items are used in case of create or update

Responses
200

FinancialConfiguration updated Successfully

*/*
post
/financialconfigurations/_update

Last updated

Was this helpful?