SaveBudgetAllocation (POST)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This POST API can be used to capture new additions in Budget Allocation details from ERP into GEP SMART to be used as reference in P2P transactions.

 

URL Format: https://<Instance>/smartInterfaceAPI/api/BudgetAllLocation/BudgetAllocationDetails
 

Request 
[
      {
         "periodCode": "String",
         "periodType": "String",
         "accountCodes": [
            {
               "entityCode": "String",
               "isDefault": false,
               "entityType": "String"
            }
         ],
         "currencyCode": "String",
         "allocatedBudget": 0,
         "committedAmount": 0,
         "obligatedAmount": 0,
         "expensedAmount": 0,
         "availableAmount": 0,
         "overallBudget": 0,
         "isActive": true
      }
]

 

Response 
{
  "data": null,
  "statusCode": "String",
  "errorDetails": [
    {
      "key": "string",
      "errors": [
        {
          "errorCode": "string",
          "errorDescription": "string"
        }
      ]
    }
  ],
  "successDetails": [
    {
      "key": "String"
    }
  ]
}

 

Examples

Success Scenario - Request

Below request only contains mandatory attributes:

[
  {
    "PeriodCode": "2018",
    "AccountCodes": [
      {
        "EntityCode": "A-07-00022-01",
        "EntityType": "WBS"
      }
    ],
    "CurrencyCode": "USD"
  }
]

 

Success Scenario - Response

{
  "data": null,
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "2018|PeriodCode,A-07-00022-01|WBS,"
    }
  ]
}

 

Error Scenario 1 - Request

Below request contains a missing value of the mandatory attribute – PeriodCode:

[
  {
    "AccountCodes": [
      {
        "EntityCode": "A-07-00022-01",
        "EntityType": "WBS"
      }
    ],
    "CurrencyCode": "USD"
  }
]

 

Error Scenario 1 - Response

{
  "data": null,
  "statusCode": "400",
  "errorDetails": [
    {
      "key": "|PeriodCode,A-07-00022-01|WBS,",
      "errors": [
        {
          "errorCode": "DataValidation",
          "errorDescription": "PeriodCode is invalid or not exists in Calendar Period"
        }
      ]
    }
  ],
  "successDetails": []
}

 

Error Scenario 2 - Request

Below request contains an invalid format of CurrencyCode:

[
  {
    "PeriodCode": "2018",
    "PeriodType": "TestngType",
    "AccountCodes": [
      {
        "EntityCode": "A-07-00022-01",
        "IsDefault": false,
        "EntityType": "WBS"
      }
    ],
    "CurrencyCode": "USD1",
    "AllocatedBudget": 303234442242,
    "CommittedAmount": 0,
    "ObligatedAmount": 0,
    "ExpensedAmount": 0,
    "AvailableAmount": 15000,
    "OverallBudget": 0,
    "IsActive": true
  }
]

 

Error Scenario 2 - Response

{
  "data": null,
  "statusCode": "400",
  "errorDetails": [
    {
      "key": "2018|PeriodCode,A-07-00022-01|WBS,",
      "errors": [
        {
          "errorCode": "DataValidation",
          "errorDescription": "CurrencyCode is Invalid"
        }
      ]
    }
  ],
  "successDetails": []
}

 

Data Elements
 

Budget Allocation

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1

CurrencyCode

Yes

String (20)

Code of Currency

  • Currency is mandatory

  • Currency Code is Invalid

  • Currency Code cannot be changed for existing allocation

1.2

PeriodCode

No

String (100)

Code of Budget Allocation Period

  • Period Code is invalid or not exists in Calendar Period

1.3

PeriodType

No

String (100)

Type of Budget Allocation Period

 

1.4

AccountCodes

No

List of OrgEntity object

 

  • Account Codes are invalid according to Budget Structure

1.5

AllocatedBudget

No

Decimal (18,6)

Budget allocated

 

1.6

CommittedAmount

No

Decimal (18,6)

Amount committed

 

1.7

ObligatedAmount

No

Decimal (18,6)

Amount obliged

 

1.8

ExpensedAmount

No

Decimal (18,6)

Amount expensed

 

1.9

AvailableAmount

No

Decimal (18,6)

Amount available

 

1.10

OverallBudget

No

Decimal (18,6)

Overall budget

  • Overall Period is not configured so cannot accept Overall Budget

1.11

IsActive

No

Boolean

Status of the Budget allocation

 

 

 

AccountCodes

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.4.1

EntityCode

No

String (2000)

Code of Org Account Code

  • EntityCode with EntityType is invalid or not exists in Organization Entity

  • EntityCode with EntityType is invalid or not exists

1.4.2

IsDefault

No

Boolean

Status of the Account Code if this Account Code is default or not

 

1.4.3

EntityType

No

String (200)

Type of Account Code

 

1.4.4

LobEntityCode

No

String

Code of lob Entity