Budget Movement¶
Budget Movement - Create Budget Movement¶
HTTP Request
POST /api/budget-movements
📋 Description: Creates new budget movement entries within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze financial allocations related to portfolio assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing budget movement details, including asset allocation, portfolio adjustments, and relevant analytics for real estate property management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "date": "2019-08-24T14:15:22Z",
10 "description": "string",
11 "openingBalance": 0,
12 "movementBalance": 0,
13 "closingBalance": 0,
14 "budgetId": 0,
15 "projectId": 0,
16 "milestoneId": 0,
17 "milestoneTaskId": 0
18}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Budget Movement - Get All Budget Movements By Budget ID¶
HTTP Request
GET /api/budget-movements/budgets/{budgetId}
📋 Description: Retrieves detailed budget movement information for a specified budget, enabling comprehensive analysis of portfolio and asset performance within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
budgetId |
path |
integer(int64) |
true |
Unique identifier for the budget |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "date": "2019-08-24T14:15:22Z",
11 "description": "string",
12 "openingBalance": 0,
13 "movementBalance": 0,
14 "closingBalance": 0,
15 "budgetId": 0,
16 "projectId": 0,
17 "milestoneId": 0,
18 "milestoneTaskId": 0
19 }
20]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the financial movements within a portfolio, providing insights into budget allocations and adjustments for real estate properties and assets within the Nakisa Portfolio Management Suite.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» date |
string(date-time) |
false |
none |
Date of the resource |
» description |
string |
false |
none |
Description of the resource |
» openingBalance |
number |
false |
none |
Value for openingBalance field |
» movementBalance |
number |
false |
none |
Value for movementBalance field |
» closingBalance |
number |
false |
none |
Value for closingBalance field |
» budgetId |
integer(int64) |
false |
none |
Unique identifier for the budget |
» projectId |
integer(int64) |
false |
none |
Unique identifier for the project |
» milestoneId |
integer(int64) |
false |
none |
Unique identifier for the milestone |
» milestoneTaskId |
integer(int64) |
false |
none |
Unique identifier for the milestone task |
Budget Movement - Delete Budget Movement¶
HTTP Request
DELETE /api/budget-movements/{id}
📋 Description: Deletes a specified budget movement from the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial records within their portfolio and asset management processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |