Lessor Account Mapping

Lessor Account Mapping - Get

HTTP Request

GET /api/v1/lessor-account-mappings/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific lessor account mapping by its unique identifier, providing insights into the financial organization structure and hierarchy of the associated 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	OK	ResponseLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Update

HTTP Request

PUT /api/v1/lessor-account-mappings/{id}

Interactive Demo

📋 Description: Updates the details of a specific lessor account mapping identified by the provided ID, ensuring alignment within the financial organization structure and hierarchy. This operation facilitates the management of relationships between financial entities and their associated accounts.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	LessorAccountMappingDto	true	Request body containing the updated financial entity mapping data, including organizational structure details and hierarchy adjustments for the specified lessor account.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "accountType": "ACCRUED_INTEREST_INCOME",
  "accountSubType": "LEASE",
  "generalLedgerAccountId": 0,
  "generalLedgerAccountDisplayId": "string",
  "generalLedgerAccountShortName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Delete

HTTP Request

DELETE /api/v1/lessor-account-mappings/{id}

Interactive Demo

📋 Description: Deletes a specific lessor account mapping identified by the provided ID, thereby maintaining the integrity of the financial organization structure and hierarchy within the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Create Or Update Bulk

HTTP Request

PUT /api/v1/lessor-account-mappings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple lessor account mappings in bulk, facilitating the management of financial entity hierarchies within the organizational structure. This operation ensures efficient alignment of lessor accounts with the overarching financial organization framework.

Parameters

Name	In	Type	Required	Description
body	body	LessorAccountMappingDto	true	Request body containing a bulk array of financial entity mappings, including organization identifiers and hierarchical relationships for effective management of the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "accountType": "ACCRUED_INTEREST_INCOME",
      "accountSubType": "LEASE",
      "generalLedgerAccountId": 0,
      "generalLedgerAccountDisplayId": "string",
      "generalLedgerAccountShortName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Create Or Update

HTTP Request

PUT /api/v1/lessor-account-mappings/createOrUpdate

Interactive Demo

📋 Description: Creates or updates lessor account mappings within the financial organization structure, ensuring accurate representation of the hierarchy and relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LessorAccountMappingDto	true	Request body containing the financial entity’s organization structure data, including details for creating or updating lessor account mappings within the hierarchy.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "accountType": "ACCRUED_INTEREST_INCOME",
  "accountSubType": "LEASE",
  "generalLedgerAccountId": 0,
  "generalLedgerAccountDisplayId": "string",
  "generalLedgerAccountShortName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Bulk Update

HTTP Request

PUT /api/v1/lessor-account-mappings/bulk

Interactive Demo

📋 Description: Updates multiple lessor account mappings in bulk, allowing for efficient management of financial entity hierarchies within the organization’s structure.

Parameters

Name	In	Type	Required	Description
body	body	LessorAccountMappingDto	true	Request body containing a collection of lessor account mapping entries, including organizational identifiers and hierarchical relationships for financial entity structuring.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "accountType": "ACCRUED_INTEREST_INCOME",
      "accountSubType": "LEASE",
      "generalLedgerAccountId": 0,
      "generalLedgerAccountDisplayId": "string",
      "generalLedgerAccountShortName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Bulk Create

HTTP Request

POST /api/v1/lessor-account-mappings/bulk

Interactive Demo

📋 Description: Facilitates the bulk creation of lessor account mappings within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LessorAccountMappingDto	true	Request body containing a collection of lessor account mappings, including organizational identifiers and hierarchical relationships essential for structuring financial entities.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "accountType": "ACCRUED_INTEREST_INCOME",
      "accountSubType": "LEASE",
      "generalLedgerAccountId": 0,
      "generalLedgerAccountDisplayId": "string",
      "generalLedgerAccountShortName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Bulk Delete

HTTP Request

DELETE /api/v1/lessor-account-mappings/bulk

Interactive Demo

📋 Description: Deletes multiple lessor account mappings in bulk, allowing for efficient management of financial organization structures and hierarchies within a financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk deletion of lessor account mappings within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Search

HTTP Request

POST /api/v1/lessor-account-mappings/search

Interactive Demo

📋 Description: Submits a search request for lessor account mappings within the financial organization structure, enabling users to identify and analyze relationships between financial entities based on organizational hierarchy.

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	LessorAccountMappingDtoFilter	false	Request body containing the criteria for searching lessor account mappings, including organizational structure and hierarchy details relevant to financial entities.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "generalLedgerAccountDisplayIdLike": "string",
  "determinationIdEqual": 0,
  "determinationDisplayIdLike": "string",
  "accountTypeIn": [
    "ACCRUED_INTEREST_INCOME"
  ],
  "generalLedgerAccountIdEqual": 0,
  "generalLedgerAccountShortNameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLessorAccountMappingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "accountType": "ACCRUED_INTEREST_INCOME",
      "accountSubType": "LEASE",
      "generalLedgerAccountId": 0,
      "generalLedgerAccountDisplayId": "string",
      "generalLedgerAccountShortName": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Find All

HTTP Request

GET /api/v1/lessor-account-mappings

Interactive Demo

📋 Description: Retrieves the mappings of lessor accounts within the financial organization structure, providing insights into the hierarchical relationships between financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the financial organization structure can be paginated for improved navigation through the hierarchy of lessor account mappings.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLessorAccountMappingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "accountType": "ACCRUED_INTEREST_INCOME",
      "accountSubType": "LEASE",
      "generalLedgerAccountId": 0,
      "generalLedgerAccountDisplayId": "string",
      "generalLedgerAccountShortName": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Create

HTTP Request

POST /api/v1/lessor-account-mappings

Interactive Demo

📋 Description: Creates a new mapping between lessor accounts within the financial organization structure, facilitating the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LessorAccountMappingDto	true	Request body containing the mapping data for lessor accounts, including organizational identifiers and hierarchical relationships within the financial entity structure.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "accountType": "ACCRUED_INTEREST_INCOME",
  "accountSubType": "LEASE",
  "generalLedgerAccountId": 0,
  "generalLedgerAccountDisplayId": "string",
  "generalLedgerAccountShortName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLessorAccountMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "accountType": "ACCRUED_INTEREST_INCOME",
    "accountSubType": "LEASE",
    "generalLedgerAccountId": 0,
    "generalLedgerAccountDisplayId": "string",
    "generalLedgerAccountShortName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Lessor Account Mapping - Get Metadata

HTTP Request

GET /api/v1/lessor-account-mappings/meta

Interactive Demo

📋 Description: Retrieves metadata related to lessor account mappings within the financial organization structure, providing insights into the hierarchical relationships of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "ACCOUNT_TYPE"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---