Expense Category¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/expense-categories/{id}
📋 Description: Retrieves detailed information about a specific expense category within the financial organization structure, identified by its unique ID, to support effective financial management and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "editable": true,
20 "expenseCategoryType": "PAYMENT"
21 }
22}
Update A Resource¶
HTTP Request
PUT /api/v1/expense-categories/{id}
📋 Description: Updates the details of a specific expense category within the financial organization structure, enabling users to refine the hierarchy and classification of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details for the specified expense category, including attributes such as name, description, and hierarchy level within the financial organization structure. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "editable": true,
7 "expenseCategoryType": "PAYMENT"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "editable": true,
20 "expenseCategoryType": "PAYMENT"
21 }
22}
Delete¶
HTTP Request
DELETE /api/v1/expense-categories/{id}
📋 Description: Deletes a specified expense category from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Delete Or Decommission¶
HTTP Request
PUT /api/v1/expense-categories/remove/{id}
📋 Description: Removes a specified expense category from the financial organization structure, ensuring that the hierarchy remains accurate and up-to-date for effective financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Delete Or Decommission All¶
HTTP Request
PUT /api/v1/expense-categories/remove/bulk
📋 Description: Removes multiple expense categories from the financial organization structure, streamlining the hierarchy of financial entities for improved management and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of expense category identifiers to be removed in bulk from the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Decommission¶
HTTP Request
PUT /api/v1/expense-categories/decommission/{id}
📋 Description: Decommissions a specified expense category within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that the organizational structure remains up-to-date and aligned with current financial management practices.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "editable": true,
20 "expenseCategoryType": "PAYMENT"
21 }
22}
Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/expense-categories/decommission/modified-before/{modified_before}
📋 Description: Decommissions expense categories within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with organizational needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the date and time before which expense categories will be decommissioned, facilitating the management of financial organization structures and hierarchies. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Decommission Before Now¶
HTTP Request
PUT /api/v1/expense-categories/decommission/modified-before-now
📋 Description: Decommissions expense categories that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with the entity’s operational hierarchy.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Decommission All¶
HTTP Request
PUT /api/v1/expense-categories/decommission/bulk
📋 Description: Decommissions multiple expense categories in bulk, allowing financial organizations to efficiently manage their organizational structure and hierarchy by removing obsolete or redundant categories.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of expense category identifiers to be decommissioned in bulk, reflecting changes in the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/expense-categories/createOrUpdate/bulk
📋 Description: Creates or updates multiple expense categories in bulk within the financial organization structure, ensuring alignment with the hierarchical framework of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a list of expense category objects for bulk creation or update within the financial organization structure, including relevant identifiers and attributes. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "editable": true,
8 "expenseCategoryType": "PAYMENT"
9 }
10]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/expense-categories/createOrUpdate
📋 Description: Creates or updates expense categories within the financial organization structure, ensuring alignment with the entity’s hierarchical framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the expense category, including identifiers, attributes, and hierarchical relationships relevant to the financial organization structure. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "editable": true,
7 "expenseCategoryType": "PAYMENT"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "editable": true,
20 "expenseCategoryType": "PAYMENT"
21 }
22}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/expense-categories/bulk
📋 Description: Updates multiple expense categories within the financial organization structure, allowing for efficient management of hierarchical classifications essential for financial reporting and analysis.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of expense category objects to update the financial organization structure in bulk, ensuring alignment with the hierarchy of the financial entity. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "editable": true,
8 "expenseCategoryType": "PAYMENT"
9 }
10]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Bulk Create¶
HTTP Request
POST /api/v1/expense-categories/bulk
📋 Description: Creates multiple expense categories in bulk for a financial organization, enabling efficient management of the organization’s financial structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a list of expense category definitions, including hierarchical relationships and associated metadata, to facilitate the structured organization of financial entities. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "editable": true,
8 "expenseCategoryType": "PAYMENT"
9 }
10]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "editable": true,
21 "expenseCategoryType": "PAYMENT"
22 }
23 ]
24}
Bulk Delete¶
HTTP Request
DELETE /api/v1/expense-categories/bulk
📋 Description: Deletes multiple expense categories within the financial organization structure, allowing for streamlined management of the hierarchy and organization of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of expense category identifiers to be deleted, reflecting the financial organization structure and hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search Resources¶
HTTP Request
POST /api/v1/expense-categories/search
📋 Description: Submits a request to search for expense categories within the financial organization structure, allowing users to identify and categorize expenses based on the organization’s hierarchy and financial entity requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing search criteria for expense categories within the financial organization structure, including filters for hierarchy and organizational context. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "uiSelector": "string",
24 "nameLike": "string",
25 "editableEqual": true,
26 "expenseCategoryTypeIn": [
27 "PAYMENT"
28 ],
29 "expenseCategoryTypeEqual": "PAYMENT",
30 "principalPositionTypeIn": [
31 "LESSEE"
32 ],
33 "principalPositionTypeEqual": "LESSEE",
34 "includeNonLease": true,
35 "leaseTypeInIn": [
36 "LEASE_CONTRACT_FIXED_PART_A"
37 ],
38 "leaseTypeInEqual": "LEASE_CONTRACT_FIXED_PART_A"
39}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "pageSize": 0,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "editable": true,
25 "expenseCategoryType": "PAYMENT"
26 }
27 ],
28 "number": 0,
29 "sort": {
30 "unsorted": true,
31 "sorted": true,
32 "empty": true
33 },
34 "first": true,
35 "last": true,
36 "empty": true
37}
List All Resources¶
HTTP Request
GET /api/v1/expense-categories
📋 Description: Retrieves a list of expense categories within the financial organization structure, enabling users to understand the hierarchical classification of financial entities. This operation supports effective budget management and financial reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently navigate through the hierarchy of expense categories within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "pageSize": 0,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "editable": true,
25 "expenseCategoryType": "PAYMENT"
26 }
27 ],
28 "number": 0,
29 "sort": {
30 "unsorted": true,
31 "sorted": true,
32 "empty": true
33 },
34 "first": true,
35 "last": true,
36 "empty": true
37}
Create¶
HTTP Request
POST /api/v1/expense-categories
📋 Description: Creates a new expense category within the financial organization structure, enabling the classification and management of expenses according to the established hierarchy of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of new expense categories, including category name, description, and associated financial hierarchy, to enhance the organization’s financial structure. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "editable": true,
7 "expenseCategoryType": "PAYMENT"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "editable": true,
20 "expenseCategoryType": "PAYMENT"
21 }
22}
Get Metadata¶
HTTP Request
GET /api/v1/expense-categories/meta
📋 Description: Retrieves metadata for expense categories within the financial organization structure, providing essential information for understanding the hierarchy and classification of financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "NAME"
3]