Platform

Specification

Technical Specification

Information Model

Government

This object captures the fiscal information of external systems.

Field

Type

Description

String (64,1)

Unique Identifier

name

String (256,2)

Name of the Government or Tenant - e.g. India, Nigeria, Punjab

Department

Captures the department attributes.

Field

Type

Description

string

Unique Identifier

name

string

Name of the Department - e.g. Department of Water Supply and Sanitation

code

string

Unique Code e.g. DWSS

Chart of Account

Captures the COA data as a map.

Field

Type

Description

name

String

Name of the Account

coaCode

String

Full Chart of Account String eg: 1234-123-123-12-12-12

majorHead

String

Major head code

majorHeadName

String

Major head name

majorHeadType

String

Major head code type

subMajorHead

String

Sub-Major head code

subMajorHeadName

String

Sub-Major head name

minorHead

String

Minor head code

minorHeadName

String

Minor head name

subHead

String

Sub-Head code

subHeadName

String

Sub-Head name

groupHead

String

Group head code

groupHeadName

String

Group head name

objectHead

String

Object head code

objectHeadName

String

Object head name

Expenditure

Captures the Expenditure attributes - encapsulates all scheme and non-scheme expenditure details.

Field

Type

Description

String

Unique Identifier

name

String

Name of the Expenditure - This could be a scheme or a non-scheme expenditure - e.g. Jal Jeevan Mission

code

String

Unique Code e.g. JJM

type

Enum

Type of Expenditure - [Scheme, Non-Scheme]

Project

Captures the Project attributes.

Field

Type

Description

String

Unique Identifier

name

String

Name of the Project - e.g. Kartarpur Sahib Water Supply Project

code

String

Code of the Project - e.g. S572

Amount

Field

Type

Description

String

Unique Identifier

amount

Number

Transaction Amount

coaId

String

Chart of Account ID

fromBillingPeriod

Integer($int64)

Start date of the billing period for which transaction is applicable

toBillingPeriod

Integer($int64)

End date of the billing period for which transaction is applicable

Fiscal Event

Field

Type

Description

version

String

Version of the Information Model

String

System Generated Unique ID

tenantId

String

Government ID

projectId

String

Unique ID of the Associated Project

eventType

String

Type of Fiscal Event e.g. Demand, Bill, Payment, Receipt

eventTime

integer($int64)

Time Stamp when the event occurred in the source system

referenceId

String

Unique Transaction Reference ID in the source system

parentEventId

String

Unique ID of the Parent Event to which this event is linked

amountDetails

Array[Amount]

Array of type Amount

PreviousTechnical Specification NextAPIs

Last updated 2 years ago

Was this helpful?

Platform

Specification

Technical Specification

Information Model

Government

This object captures the fiscal information of external systems.

Field

Type

Description

String (64,1)

Unique Identifier

name

String (256,2)

Name of the Government or Tenant - e.g. India, Nigeria, Punjab

Department

Captures the department attributes.

Field

Type

Description

string

Unique Identifier

name

string

Name of the Department - e.g. Department of Water Supply and Sanitation

code

string

Unique Code e.g. DWSS

Chart of Account

Captures the COA data as a map.

Field

Type

Description

name

String

Name of the Account

coaCode

String

Full Chart of Account String eg: 1234-123-123-12-12-12

majorHead

String

Major head code

majorHeadName

String

Major head name

majorHeadType

String

Major head code type

subMajorHead

String

Sub-Major head code

subMajorHeadName

String

Sub-Major head name

minorHead

String

Minor head code

minorHeadName

String

Minor head name

subHead

String

Sub-Head code

subHeadName

String

Sub-Head name

groupHead

String

Group head code

groupHeadName

String

Group head name

objectHead

String

Object head code

objectHeadName

String

Object head name

Expenditure

Captures the Expenditure attributes - encapsulates all scheme and non-scheme expenditure details.

Field

Type

Description

String

Unique Identifier

name

String

Name of the Expenditure - This could be a scheme or a non-scheme expenditure - e.g. Jal Jeevan Mission

code

String

Unique Code e.g. JJM

type

Enum

Type of Expenditure - [Scheme, Non-Scheme]

Project

Captures the Project attributes.

Field

Type

Description

String

Unique Identifier

name

String

Name of the Project - e.g. Kartarpur Sahib Water Supply Project

code

String

Code of the Project - e.g. S572

Amount

Field

Type

Description

String

Unique Identifier

amount

Number

Transaction Amount

coaId

String

Chart of Account ID

fromBillingPeriod

Integer($int64)

Start date of the billing period for which transaction is applicable

toBillingPeriod

Integer($int64)

End date of the billing period for which transaction is applicable

Fiscal Event

Field

Type

Description

version

String

Version of the Information Model

String

System Generated Unique ID

tenantId

String

Government ID

projectId

String

Unique ID of the Associated Project

eventType

String

Type of Fiscal Event e.g. Demand, Bill, Payment, Receipt

eventTime

integer($int64)

Time Stamp when the event occurred in the source system

referenceId

String

Unique Transaction Reference ID in the source system

parentEventId

String

Unique ID of the Parent Event to which this event is linked

amountDetails

Array[Amount]

Array of type Amount

All content on this page by is licensed under a .

PreviousTechnical Specification NextAPIs

Last updated 2 years ago

Was this helpful?