Lessee Account Mapping¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/lessee-account-mappings/{id}
📋 Description: Retrieves the details of a specific lessee account mapping identified by the provided ID, facilitating insights into the organization’s financial structure and hierarchy.
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 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "determinationId": 0,
32 "determinationDisplayId": "string",
33 "accountType": "INCENTIVE_CLEARING",
34 "accountSubType": "LEASE",
35 "generalLedgerAccountId": 0,
36 "generalLedgerAccountDisplayId": "string",
37 "generalLedgerAccountShortName": "string"
38 }
39}
Update A Resource¶
HTTP Request
PUT /api/v1/lessee-account-mappings/{id}
📋 Description: Updates the lessee account mapping for a specified identifier, allowing for modifications to the organizational structure and hierarchy within the financial entity framework. This operation ensures that the mapping aligns with the current business requirements and organizational changes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated lessee account mapping details, including organizational hierarchy and financial entity attributes. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "determinationId": 0,
19 "determinationDisplayId": "string",
20 "accountType": "INCENTIVE_CLEARING",
21 "accountSubType": "LEASE",
22 "generalLedgerAccountId": 0,
23 "generalLedgerAccountDisplayId": "string",
24 "generalLedgerAccountShortName": "string"
25}
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 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "determinationId": 0,
32 "determinationDisplayId": "string",
33 "accountType": "INCENTIVE_CLEARING",
34 "accountSubType": "LEASE",
35 "generalLedgerAccountId": 0,
36 "generalLedgerAccountDisplayId": "string",
37 "generalLedgerAccountShortName": "string"
38 }
39}
Delete¶
HTTP Request
DELETE /api/v1/lessee-account-mappings/{id}
📋 Description: Deletes a specified lessee account mapping from the financial organization structure, ensuring the integrity of the organizational hierarchy within the financial entity.
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}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/lessee-account-mappings/createOrUpdate/bulk
📋 Description: Creates or updates multiple lessee account mappings in bulk, facilitating the efficient management of financial entity hierarchies within the organizational structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating lessee account mappings, including organizational identifiers and hierarchical relationships within the financial entity structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "determinationId": 0,
20 "determinationDisplayId": "string",
21 "accountType": "INCENTIVE_CLEARING",
22 "accountSubType": "LEASE",
23 "generalLedgerAccountId": 0,
24 "generalLedgerAccountDisplayId": "string",
25 "generalLedgerAccountShortName": "string"
26 }
27]
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 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "determinationId": 0,
33 "determinationDisplayId": "string",
34 "accountType": "INCENTIVE_CLEARING",
35 "accountSubType": "LEASE",
36 "generalLedgerAccountId": 0,
37 "generalLedgerAccountDisplayId": "string",
38 "generalLedgerAccountShortName": "string"
39 }
40 ]
41}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/lessee-account-mappings/createOrUpdate
📋 Description: Updates or creates lessee account mappings within the financial organization structure, ensuring accurate representation of organizational hierarchy and relationships among financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details for creating or updating lessee account mappings, including organizational hierarchy and financial entity information. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "determinationId": 0,
19 "determinationDisplayId": "string",
20 "accountType": "INCENTIVE_CLEARING",
21 "accountSubType": "LEASE",
22 "generalLedgerAccountId": 0,
23 "generalLedgerAccountDisplayId": "string",
24 "generalLedgerAccountShortName": "string"
25}
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 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "determinationId": 0,
32 "determinationDisplayId": "string",
33 "accountType": "INCENTIVE_CLEARING",
34 "accountSubType": "LEASE",
35 "generalLedgerAccountId": 0,
36 "generalLedgerAccountDisplayId": "string",
37 "generalLedgerAccountShortName": "string"
38 }
39}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/lessee-account-mappings/bulk
📋 Description: Updates multiple lessee account mappings in bulk, allowing for efficient management of financial entity relationships within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of lessee account mappings to facilitate the bulk updating of organizational structure within the financial entity hierarchy. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "determinationId": 0,
20 "determinationDisplayId": "string",
21 "accountType": "INCENTIVE_CLEARING",
22 "accountSubType": "LEASE",
23 "generalLedgerAccountId": 0,
24 "generalLedgerAccountDisplayId": "string",
25 "generalLedgerAccountShortName": "string"
26 }
27]
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 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "determinationId": 0,
33 "determinationDisplayId": "string",
34 "accountType": "INCENTIVE_CLEARING",
35 "accountSubType": "LEASE",
36 "generalLedgerAccountId": 0,
37 "generalLedgerAccountDisplayId": "string",
38 "generalLedgerAccountShortName": "string"
39 }
40 ]
41}
Bulk Create¶
HTTP Request
POST /api/v1/lessee-account-mappings/bulk
📋 Description: Creates multiple lessee account mappings in bulk, facilitating the organization and hierarchy of financial entities within the financial organization structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of lessee account mappings, including details necessary for establishing financial entity relationships within the organizational structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "determinationId": 0,
20 "determinationDisplayId": "string",
21 "accountType": "INCENTIVE_CLEARING",
22 "accountSubType": "LEASE",
23 "generalLedgerAccountId": 0,
24 "generalLedgerAccountDisplayId": "string",
25 "generalLedgerAccountShortName": "string"
26 }
27]
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 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "determinationId": 0,
33 "determinationDisplayId": "string",
34 "accountType": "INCENTIVE_CLEARING",
35 "accountSubType": "LEASE",
36 "generalLedgerAccountId": 0,
37 "generalLedgerAccountDisplayId": "string",
38 "generalLedgerAccountShortName": "string"
39 }
40 ]
41}
Bulk Delete¶
HTTP Request
DELETE /api/v1/lessee-account-mappings/bulk
📋 Description: Deletes multiple lessee account mappings in a single operation, streamlining the management of financial entity hierarchies within the organizational structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of lessee account mapping identifiers to facilitate the bulk deletion of financial entity associations within the organizational 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}
Search Resources¶
HTTP Request
POST /api/v1/lessee-account-mappings/search
📋 Description: Submits a search request for lessee account mappings within the financial organization structure, enabling users to identify and analyze the hierarchical relationships of financial entities.
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 the criteria for searching lessee account mappings within the financial organization structure, including relevant identifiers and hierarchical relationships. |
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 "generalLedgerAccountDisplayIdLike": "string",
16 "determinationIdEqual": 0,
17 "determinationDisplayIdLike": "string",
18 "accountTypeIn": [
19 "INCENTIVE_CLEARING"
20 ],
21 "generalLedgerAccountIdEqual": 0,
22 "generalLedgerAccountShortNameLike": "string"
23}
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 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "determinationId": 0,
37 "determinationDisplayId": "string",
38 "accountType": "INCENTIVE_CLEARING",
39 "accountSubType": "LEASE",
40 "generalLedgerAccountId": 0,
41 "generalLedgerAccountDisplayId": "string",
42 "generalLedgerAccountShortName": "string"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "unsorted": true,
48 "sorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}
List All Resources¶
HTTP Request
GET /api/v1/lessee-account-mappings
📋 Description: Retrieves the mappings of lessee accounts within the financial organization structure, providing insights into the hierarchical relationships and organizational alignment of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lessee account mappings should be returned in a paginated format, facilitating efficient navigation through 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 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "determinationId": 0,
37 "determinationDisplayId": "string",
38 "accountType": "INCENTIVE_CLEARING",
39 "accountSubType": "LEASE",
40 "generalLedgerAccountId": 0,
41 "generalLedgerAccountDisplayId": "string",
42 "generalLedgerAccountShortName": "string"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "unsorted": true,
48 "sorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}
Create¶
HTTP Request
POST /api/v1/lessee-account-mappings
📋 Description: Creates a new mapping between lessee accounts and the financial organization structure, facilitating the alignment of organizational hierarchy with financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the mapping data for lessee accounts, including organizational hierarchy and financial entity details essential for structuring financial relationships. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "determinationId": 0,
19 "determinationDisplayId": "string",
20 "accountType": "INCENTIVE_CLEARING",
21 "accountSubType": "LEASE",
22 "generalLedgerAccountId": 0,
23 "generalLedgerAccountDisplayId": "string",
24 "generalLedgerAccountShortName": "string"
25}
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 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "determinationId": 0,
32 "determinationDisplayId": "string",
33 "accountType": "INCENTIVE_CLEARING",
34 "accountSubType": "LEASE",
35 "generalLedgerAccountId": 0,
36 "generalLedgerAccountDisplayId": "string",
37 "generalLedgerAccountShortName": "string"
38 }
39}
Get Metadata¶
HTTP Request
GET /api/v1/lessee-account-mappings/meta
📋 Description: Retrieves metadata for lessee account mappings within the financial organization structure, providing insights into the hierarchical relationships and organizational entities involved.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "ACCOUNT_TYPE"
3]