Lessee Account Mapping

Lessee Account Mapping - Get

HTTP Request

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

Interactive Demo

📋 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	OK	ResponseLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
    "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

Lessee Account Mapping - Update

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDto	true	Request body containing the updated lessee account mapping details, including organizational hierarchy and financial entity attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
    "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

Lessee Account Mapping - Delete

HTTP Request

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

Interactive Demo

📋 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	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

Lessee Account Mapping - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDto	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

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
      "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

Lessee Account Mapping - Create Or Update

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDto	true	Request body containing the details for creating or updating lessee account mappings, including organizational hierarchy and financial entity information.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
    "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

Lessee Account Mapping - Bulk Update

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDto	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

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
      "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

Lessee Account Mapping - Bulk Create

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDto	true	Request body containing a collection of lessee account mappings, including details necessary for establishing financial entity relationships within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
      "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

Lessee Account Mapping - Bulk Delete

HTTP Request

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

Interactive Demo

📋 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

[
  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

Lessee Account Mapping - Search

HTTP Request

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

Interactive Demo

📋 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	LesseeAccountMappingDtoFilter	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	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": [
    "INCENTIVE_CLEARING"
  ],
  "generalLedgerAccountIdEqual": 0,
  "generalLedgerAccountShortNameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
      "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

Lessee Account Mapping - Find All

HTTP Request

GET /api/v1/lessee-account-mappings

Interactive Demo

📋 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	Pageable	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	OK	PageLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
      "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

Lessee Account Mapping - Create

HTTP Request

POST /api/v1/lessee-account-mappings

Interactive Demo

📋 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	LesseeAccountMappingDto	true	Request body containing the mapping data for lessee accounts, including organizational hierarchy and financial entity details essential for structuring financial relationships.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLesseeAccountMappingDto

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": "INCENTIVE_CLEARING",
    "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

Lessee Account Mapping - Get Metadata

HTTP Request

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

Interactive Demo

📋 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	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

---