Budget Operations

Provides all the portfolio's budget rest endpoints

Key: com.greffon.folio Path: <JIRA_BASE_URL>/rest/folio/1.0 WADL: <JIRA_BASE_URL>/rest/folio/1.0/application.wadl

RETRIEVE BUDGET

GET

/budget/{folioId}

Parameter	Type
folioId	Long

Result example

{

"success": {

"folioId": 2,

"canEdit": true,

"numberOfExpenses": 6,

"currency": {

"code": "USD",

"symbol": "$",

"description": "United States Dollar ($)"

},

"opexCategory": {

"name": "OPEX",

"displayName": "Operational Expenditures",

"salarySectionName": "Salaries",

"expenseTypes": [

{

"id": "-392593660",

"name": "Advertising",

"expenses": [

{

"id": 54,

"name": "Magazine ad",

"displayAmount": "500.00",

"description": "To announce the product launch date.",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"displayRecurrence": "Monthly on day 23, from 23/Apr/13",

"frequency": {

"name": "MONTHLY",

"displayName": "per month"

},

"canBeAmortized": true,

"displayPayment": "500.00",

"paymentsCount": 5,

"startDate": "23/Apr/13",

"firstPaymentDate": "23/Aug/13",

"lastPaymentDate": "23/Dec/13",

"recurrenceBy": {

"name": "DAY_OF_MONTH",

"displayName": "By day of the month"

},

"occurrences": 0,

"interval": 1,

"shortDisplayRecurrence": "Monthly",

"displayRecurrenceWithoutDate": "Monthly on day 23"

},

"displayActualCost": "2,500.00",

"actualCost": 2500,

"amortized": false,

"amount": 500

}

],

"displayTotalCost": "2,500.00",

"totalCost": 2500

}

],

"positionTitles": [

{

"id": "-361671554",

"name": "Administration",

"recurrence": {

"frequency": {

"name": "HOURLY",

"displayName": "per hour"

},

"canBeAmortized": false,

"paymentsCount": 0,

"occurrences": 0,

"interval": 1

},

"positions": [

{

"id": 6,

"name": "Scrum Master",

"displayAmount": "40.00",

"description": "A scrum master is the facilitator for a product development team that uses scrum, a rugby analogy for a development methodology that allows a team to self-organize and make changes quickly. The scrum master manages the process for how information is exchanged.",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"frequency": {

"name": "HOURLY",

"displayName": "per hour"

},

"canBeAmortized": false,

"paymentsCount": 0,

"occurrences": 0,

"interval": 1

},

"displayActualCost": "36,800.00",

"actualCost": 36800,

"displayDetailedEffort": "From 23/Apr/13 to 8/Jan/14 at 100%",

"isAssigned": false,

"isSynchedWithJIRA": false,

"isOverCapacity": false,

"budgetedEffort": 0,

"displayBudgetedDetailedEffort": "From 23/Apr/13 to 8/Jan/14 at 100%",

"displayEffort": "920.00 h",

"effort": 920,

"wages": [

{

"id": 6,

"startDate": "23/Apr/13",

"endDate": "8/Jan/14",

"weight": 100,

"displayWeight": "100.00",

"wage": 40,

"displayWage": "40.00"

}

],

"workedHours": [],

"currentWage": {

"id": 6,

"startDate": "23/Apr/13",

"endDate": "8/Jan/14",

"weight": 100,

"displayWeight": "100.00",

"wage": 40,

"displayWage": "40.00"

}

],

"displayTotalCost": "36,800.00",

"totalCost": 36800,

"displayTotalEffort": "920.00 h",

"totalEffort": 920,

"displayAverageWage": "40.00",

"averageWage": 40

}

],

"displayTotalCost": "39,300.00",

"totalCost": 39300,

"displayPositionsTotalCost": "36,800.00",

"positionsTotalCost": 36800,

"displayExpensesTotalCost": "2,500.00",

"expensesTotalCost": 2500,

"displayTotalEffort": "920.00 h",

"totalEffort": 920,

"empty": false

},

"capexCategory": {

"name": "CAPEX",

"displayName": "Capital Expenditures",

"salarySectionName": "Salaries",

"expenseTypes": [

{

"id": "-1214642834",

"name": "Equipment",

"expenses": [

{

"id": 56,

"name": "Computers",

"displayAmount": "40,000.00",

"description": "About 4 computers for devs and 2 laptops for admins.",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"displayRecurrence": "Monthly on day 23, from 23/Apr/13, 12 times",

"frequency": {

"name": "MONTHLY",

"displayName": "per month"

},

"canBeAmortized": true,

"displayPayment": "3,333.33",

"paymentsCount": 5,

"startDate": "23/Apr/13",

"firstPaymentDate": "23/Aug/13",

"lastPaymentDate": "23/Dec/13",

"recurrenceBy": {

"name": "DAY_OF_MONTH",

"displayName": "By day of the month"

},

"occurrences": 12,

"interval": 1,

"shortDisplayRecurrence": "Monthly",

"displayRecurrenceWithoutDate": "Monthly on day 23"

},

"displayActualCost": "16,666.67",

"actualCost": 16666.67,

"amortized": true,

"amount": 40000

},

{

"id": 55,

"name": "Head office furniture",

"displayAmount": "30,000.00",

"description": "A couple of desks and some chairs.",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"displayRecurrence": "Monthly on day 23, from 23/Apr/13, 12 times",

"frequency": {

"name": "MONTHLY",

"displayName": "per month"

},

"canBeAmortized": true,

"displayPayment": "2,500.00",

"paymentsCount": 5,

"startDate": "23/Apr/13",

"firstPaymentDate": "23/Aug/13",

"lastPaymentDate": "23/Dec/13",

"recurrenceBy": {

"name": "DAY_OF_MONTH",

"displayName": "By day of the month"

},

"occurrences": 12,

"interval": 1,

"shortDisplayRecurrence": "Monthly",

"displayRecurrenceWithoutDate": "Monthly on day 23"

},

"displayActualCost": "12,500.00",

"actualCost": 12500,

"amortized": true,

"amount": 30000

}

],

"displayTotalCost": "29,166.67",

"totalCost": 29166.67

},

{

"id": "73298585",

"name": "Legal",

"expenses": [

{

"id": 57,

"name": "Algorithm patent",

"displayAmount": "2,000.00",

"description": "If we need one...",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"displayRecurrence": "Once on 23/Apr/13",

"frequency": {

"name": "ONCE",

"displayName": ""

},

"canBeAmortized": false,

"displayPayment": "0.00",

"paymentsCount": 0,

"startDate": "23/Apr/13",

"occurrences": 1,

"interval": 1,

"shortDisplayRecurrence": "",

"displayRecurrenceWithoutDate": ""

},

"displayActualCost": "0.00",

"actualCost": 0,

"amortized": false,

"amount": 2000

}

],

"displayTotalCost": "0.00",

"totalCost": 0

}

],

"displayTotalCost": "29,166.67",

"totalCost": 29166.67,

"displayExpensesTotalCost": "29,166.67",

"expensesTotalCost": 29166.67,

"empty": false

},

"finexCategory": {

"name": "FINEX",

"displayName": "Financial Expenditures",

"salarySectionName": "Salaries",

"expenseTypes": [

{

"id": "1426673667",

"name": "Loans & Credits",

"expenses": [

{

"id": 59,

"name": "Bank loan",

"displayAmount": "500.00",

"description": "Expected loan for initial cash flow",

"actual": false,

"reporter": {

"avatarUrl": "/jira/secure/useravatar?avatarId=10122",

"displayName": "admin",

"username": "admin",

"renderedLink": " <a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>",

"canEvaluate": false,

"isDeleted": false

},

"recurrence": {

"displayRecurrence": "Monthly on day 23, from 23/Apr/13",

"frequency": {

"name": "MONTHLY",

"displayName": "per month"

},

"canBeAmortized": true,

"displayPayment": "500.00",

"paymentsCount": 5,

"startDate": "23/Apr/13",

"firstPaymentDate": "23/Aug/13",

"lastPaymentDate": "23/Dec/13",

"recurrenceBy": {

"name": "DAY_OF_MONTH",

"displayName": "By day of the month"

},

"occurrences": 0,

"interval": 1,

"shortDisplayRecurrence": "Monthly",

"displayRecurrenceWithoutDate": "Monthly on day 23"

},

"displayActualCost": "2,500.00",

"actualCost": 2500,

"amortized": false,

"amount": 500

}

],

"displayTotalCost": "2,500.00",

"totalCost": 2500

}

],

"displayTotalCost": "2,500.00",

"totalCost": 2500,

"displayExpensesTotalCost": "2,500.00",

"expensesTotalCost": 2500,

"empty": false

},

"displayTotalCost": "70,966.67",

"totalCost": 70966.67

}

CREATE EXPENSE

POST

/budget/{folioId}/expense

UPDATE EXPENSE

PUT

/budget/{folioId}/expense/

COPY TO ACTUAL

POST

/budget/copyToActual/expenses

DELETE EXPENSES & POSITIONS

POST

/budget/{folioId}/remove/expenses

CREATE POSITION

POST

/budget/{folioId}/position

UPDATE POSITION

PUT

/budget/{folioId}/position