Operating Cost Period Expense

Get Operating Cost Period Expense

HTTP Request

GET /api/operating-cost-period-expenses/{id}

📋 Description: Retrieves detailed expense information for a specified operating cost period, enabling businesses to analyze financial performance and make informed budgeting decisions.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostPeriodExpenseDto

Example Responses

 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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Update Operating Cost Period Expense

HTTP Request

PUT /api/operating-cost-period-expenses/{id}

📋 Description: Updates the operating cost period expenses for a specified ID, allowing businesses to maintain accurate financial records and manage budget allocations effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

OperatingCostPeriodExpenseDto

true

Request body containing the updated operating cost period expense details, including financial figures and relevant metadata for the specified expense ID.

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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostPeriodExpenseDto

Example Responses

 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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Get Operating Cost Period Expenses

HTTP Request

GET /api/operating-cost-period-expenses

📋 Description: Retrieves detailed information on operating cost period expenses, enabling users to analyze financial performance over specified timeframes.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the operating cost period expenses query should be returned in a paginated format to enhance data retrieval efficiency.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponseOperatingCostPeriodExpenseDto

Example Responses

 1{
 2  "page": {
 3    "size": 0,
 4    "totalElements": 0,
 5    "totalPages": 0,
 6    "number": 0
 7  },
 8  "content": [
 9    {
10      "createdBy": "string",
11      "lastModifiedBy": "string",
12      "createdDate": "2019-08-24T14:15:22Z",
13      "lastModifiedDate": "2019-08-24T14:15:22Z",
14      "archived": true,
15      "externalId": "string",
16      "id": 0,
17      "operatingCostExpenseTypeId": 0,
18      "amount": 0,
19      "revisedAmount": 0,
20      "considerRevisedAmount": true,
21      "operatingCostExpenseType": {
22        "createdBy": "string",
23        "lastModifiedBy": "string",
24        "createdDate": "2019-08-24T14:15:22Z",
25        "lastModifiedDate": "2019-08-24T14:15:22Z",
26        "archived": true,
27        "externalId": "string",
28        "id": 0,
29        "priority": 0,
30        "internalId": 0,
31        "pickListCode": "string",
32        "pickListLabel": "string",
33        "label": "string",
34        "cultureId": 0,
35        "labelDtos": [
36          {
37            "createdBy": "string",
38            "lastModifiedBy": "string",
39            "createdDate": "2019-08-24T14:15:22Z",
40            "lastModifiedDate": "2019-08-24T14:15:22Z",
41            "archived": true,
42            "externalId": "string",
43            "id": 0,
44            "cultureId": 0,
45            "value": "string"
46          }
47        ]
48      },
49      "expenseGroup": {
50        "createdBy": "string",
51        "lastModifiedBy": "string",
52        "createdDate": "2019-08-24T14:15:22Z",
53        "lastModifiedDate": "2019-08-24T14:15:22Z",
54        "archived": true,
55        "externalId": "string",
56        "id": 0,
57        "priority": 0,
58        "internalId": 0,
59        "pickListCode": "string",
60        "pickListLabel": "string",
61        "label": "string",
62        "cultureId": 0,
63        "labelDtos": [
64          {
65            "createdBy": "string",
66            "lastModifiedBy": "string",
67            "createdDate": "2019-08-24T14:15:22Z",
68            "lastModifiedDate": "2019-08-24T14:15:22Z",
69            "archived": true,
70            "externalId": "string",
71            "id": 0,
72            "cultureId": 0,
73            "value": "string"
74          }
75        ]
76      }
77    }
78  ],
79  "_embedded": {
80    "property1": {},
81    "property2": {}
82  },
83  "_links": {
84    "property1": {},
85    "property2": {}
86  }
87}