Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Data Properties:

Expand
titleClick here to view all data properties under the /localBudgets endpoint:

#

Property Name

Data Type

Public (Required/ Optional/ Conditional)

Choice (Required/ Optional/ Conditional)

Business Definition

1.0

accountIdentifier

string

REQ'D

NOT REQ'D

The full 18-digit account string (“00T000000000000000”) to with the amount is associated to

2.0

educationOrganizationId

integer

REQ'D

NOT REQ'D

LEA ID or School ID

3.0

fiscalYear

integer

REQ'D

NOT REQ'D

Fiscal year for which the COA is in effect for LEA accounting and reporting (e.g. 2020 for fiscal year 2020, the 2019-2020 school year).

4.0

asOfDate

string

REQ'D

NOT REQ'D

Reported date

5.0

amount

number

REQ'D

NOT REQ'D

Current balance for the account

...

Use Cases:

Expand
titleClick here to view all the use cases pertaining to the /localBudgets endpoint:

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Sending the budgeted amounts to the local accounts

LEAs are expected to submit the budgeted amounts to the local accounts which are referenced to the DPI chart of account.

In order to push the Local Budget, the /localAccount endpoint should exist for the LEA/School.

POST on /localBudget:
asOfDate: 2020-09-26
localAccountReference:
accountIdentifier: 10E110000100000
educationOrganizationId: 3166
fiscalYear: 2020
amount: 8449.93

2.0

Sending the budget amount multiple times for an account (multiple AsOfDate values)

LEAs/Schools may revise or amend the original budget amounts for an account. If the account has been already submitted to DPI with an As of Date, then the LEA/School has to submit a revised budget Amount with a new As of Date.

POST on /localBudget

...

JSON Sample:

Expand
titleClick here to view view the JSON sample for posting the /localBudgets endpoint:
Code Block
{
    "asOfDate": "2018-12-11 01:02:21.000",
    "localAccountReference": {
      "accountIdentifier": "50B000111456000000",
      "educationOrganizationId": 7533,
      "fiscalYear": 2020,
},
    "amount": '44202',
 }