Incremental Borrowing Rate

Incremental Borrowing Rate - Get

HTTP Request

GET /api/v1/incremental-borrowing-rates/{id}

Interactive Demo

📋 Description: Retrieves the incremental borrowing rate for a specified financial entity within the organizational structure, providing insights into the entity’s financial 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	ResponseIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
}

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

Incremental Borrowing Rate - Update

HTTP Request

PUT /api/v1/incremental-borrowing-rates/{id}

Interactive Demo

📋 Description: Updates the incremental borrowing rate for a specified financial entity within the organizational structure, ensuring alignment with current financial strategies and hierarchical requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	IncrementalBorrowingRateDto	true	Request body containing the updated incremental borrowing rate data for the specified financial entity, including relevant organizational structure details and hierarchy information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "validFrom": "2019-08-24",
  "validTo": "2019-08-24",
  "leaseLengthFrom": 0,
  "leaseLengthTo": 0,
  "rate": 0.1,
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "internalAssetClassId": 0,
  "internalAssetClassDisplayId": "string",
  "internalAssetClassName": "string",
  "contractCurrencyId": 0,
  "contractCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
}

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

Incremental Borrowing Rate - Delete

HTTP Request

DELETE /api/v1/incremental-borrowing-rates/{id}

Interactive Demo

📋 Description: Deletes a specified incremental borrowing rate from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial entity management.

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

Incremental Borrowing Rate - Delete Or Decommission

HTTP Request

PUT /api/v1/incremental-borrowing-rates/remove/{id}

Interactive Demo

📋 Description: Removes a specified incremental borrowing rate from the financial organization structure, ensuring that the hierarchy and associated financial entities are updated accordingly. This operation helps maintain accurate and relevant financial data within the organization.

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

Incremental Borrowing Rate - Delete Or Decommission All

HTTP Request

PUT /api/v1/incremental-borrowing-rates/remove/bulk

Interactive Demo

📋 Description: Removes multiple incremental borrowing rates from the financial organization structure, allowing for efficient management of financial entities within the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for the bulk removal of incremental borrowing rates 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

Incremental Borrowing Rate - Decommission

HTTP Request

PUT /api/v1/incremental-borrowing-rates/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified incremental borrowing rate within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant rates are no longer utilized in financial assessments.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
}

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

Incremental Borrowing Rate - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/incremental-borrowing-rates/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions incremental borrowing rates that were modified before the specified date, ensuring the financial organization structure remains current and aligned with organizational hierarchy requirements.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning incremental borrowing rates, ensuring that only rates modified before this date are processed within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Decommission Before Now

HTTP Request

PUT /api/v1/incremental-borrowing-rates/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions incremental borrowing rates for financial entities that were modified before the current date, ensuring the organization’s financial structure remains up-to-date and compliant with internal policies.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Decommission All

HTTP Request

PUT /api/v1/incremental-borrowing-rates/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple incremental borrowing rates within the financial organization structure, allowing for streamlined management of financial entity hierarchies.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and associated decommissioning details for bulk updates to the organization’s borrowing rates within the financial structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Create Or Update Bulk

HTTP Request

PUT /api/v1/incremental-borrowing-rates/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple incremental borrowing rates for financial entities within the organization’s structure, ensuring alignment with the established hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	IncrementalBorrowingRateDto	true	Request body containing a bulk array of incremental borrowing rate entries, including details necessary for updating or creating financial entity structures within the organization hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Create Or Update

HTTP Request

PUT /api/v1/incremental-borrowing-rates/createOrUpdate

Interactive Demo

📋 Description: Creates or updates incremental borrowing rates within the financial organization structure, ensuring alignment with the established hierarchy and financial entity requirements.

Parameters

Name	In	Type	Required	Description
body	body	IncrementalBorrowingRateDto	true	Request body containing the incremental borrowing rates data, including financial entity identifiers and hierarchical structure details for creating or updating organizational borrowing parameters.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "validFrom": "2019-08-24",
  "validTo": "2019-08-24",
  "leaseLengthFrom": 0,
  "leaseLengthTo": 0,
  "rate": 0.1,
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "internalAssetClassId": 0,
  "internalAssetClassDisplayId": "string",
  "internalAssetClassName": "string",
  "contractCurrencyId": 0,
  "contractCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
}

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

Incremental Borrowing Rate - Bulk Update

HTTP Request

PUT /api/v1/incremental-borrowing-rates/bulk

Interactive Demo

📋 Description: Updates multiple incremental borrowing rates in bulk for a specified financial entity within the organizational structure, ensuring alignment with hierarchical financial policies.

Parameters

Name	In	Type	Required	Description
body	body	IncrementalBorrowingRateDto	true	Request body containing a collection of incremental borrowing rate adjustments for multiple financial entities within the organizational structure, including relevant metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Bulk Create

HTTP Request

POST /api/v1/incremental-borrowing-rates/bulk

Interactive Demo

📋 Description: Submits bulk updates for incremental borrowing rates within the financial organization structure, allowing for efficient adjustments across multiple financial entities in the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	IncrementalBorrowingRateDto	true	Request body containing a collection of incremental borrowing rate entries, each associated with a financial entity within the organizational structure, to facilitate bulk updates.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "string"
    }
  ]
}

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

Incremental Borrowing Rate - Bulk Delete

HTTP Request

DELETE /api/v1/incremental-borrowing-rates/bulk

Interactive Demo

📋 Description: Deletes multiple incremental borrowing rates in bulk for a specified financial organization structure, ensuring the hierarchy and integrity of financial entities are maintained.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for the bulk deletion of incremental borrowing rates within the organization’s hierarchical 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

Incremental Borrowing Rate - Search

HTTP Request

POST /api/v1/incremental-borrowing-rates/search

Interactive Demo

📋 Description: Submits a request to search for incremental borrowing rates within the financial organization structure, allowing users to access relevant data based on the specified hierarchy and organizational parameters.

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	IncrementalBorrowingRateDtoFilter	false	Request body containing the criteria for searching incremental borrowing rates within the financial organization structure, including relevant parameters related to the organization’s hierarchy and 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",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "nameLike": "string",
  "validFromGreaterThanOrEqual": "2019-08-24",
  "validFromLessThanOrEqual": "2019-08-24",
  "validFromEqual": "2019-08-24",
  "validToGreaterThanOrEqual": "2019-08-24",
  "validToLessThanOrEqual": "2019-08-24",
  "validToEqual": "2019-08-24",
  "leaseLengthFromLike": "string",
  "leaseLengthToLike": "string",
  "rateLike": "string",
  "companyIdEqual": 0,
  "companyDisplayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdLike": "string",
  "internalAssetClassIdEqual": 0,
  "internalAssetClassDisplayIdLike": "string",
  "internalAssetClassNameLike": "string",
  "contractCurrencyIdEqual": 0,
  "contractCurrencyDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageIncrementalBorrowingRateDto

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,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "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

Incremental Borrowing Rate - Detach Company

HTTP Request

POST /api/v1/incremental-borrowing-rates/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from the incremental borrowing rates within the financial organization structure, ensuring that the company’s financial entity is no longer associated with the defined borrowing parameters.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to specify which company’s borrowing rates are to be detached in the request.
body	body	IncrementalBorrowingRateDto	true	Request body containing the details of the financial entity’s incremental borrowing rates to be detached from the specified company within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
]

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

Incremental Borrowing Rate - Attach Company

HTTP Request

POST /api/v1/incremental-borrowing-rates/attach/company/{company_id}

Interactive Demo

📋 Description: Attaches incremental borrowing rates to a specified company within the financial organization structure, facilitating the management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to associate incremental borrowing rates with the specified company.
body	body	IncrementalBorrowingRateDto	true	Request body containing the incremental borrowing rate data to be associated with the specified financial entity, including relevant parameters for organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
]

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

Incremental Borrowing Rate - Find All

HTTP Request

GET /api/v1/incremental-borrowing-rates

Interactive Demo

📋 Description: Retrieves the incremental borrowing rates for financial entities within the organization’s structure, providing insights into the hierarchical financial framework.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the incremental borrowing rates query should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageIncrementalBorrowingRateDto

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,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "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

Incremental Borrowing Rate - Create

HTTP Request

POST /api/v1/incremental-borrowing-rates

Interactive Demo

📋 Description: Submits incremental borrowing rates for a specified financial entity within the organizational structure, enabling accurate financial planning and analysis based on hierarchical data.

Parameters

Name	In	Type	Required	Description
body	body	IncrementalBorrowingRateDto	true	Request body containing the incremental borrowing rates data, including relevant financial entity identifiers and hierarchical structure details for the organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "validFrom": "2019-08-24",
  "validTo": "2019-08-24",
  "leaseLengthFrom": 0,
  "leaseLengthTo": 0,
  "rate": 0.1,
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "internalAssetClassId": 0,
  "internalAssetClassDisplayId": "string",
  "internalAssetClassName": "string",
  "contractCurrencyId": 0,
  "contractCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseIncrementalBorrowingRateDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "validFrom": "2019-08-24",
    "validTo": "2019-08-24",
    "leaseLengthFrom": 0,
    "leaseLengthTo": 0,
    "rate": 0.1,
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "internalAssetClassId": 0,
    "internalAssetClassDisplayId": "string",
    "internalAssetClassName": "string",
    "contractCurrencyId": 0,
    "contractCurrencyDisplayId": "string"
  }
}

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

Incremental Borrowing Rate - Get Metadata

HTTP Request

GET /api/v1/incremental-borrowing-rates/meta

Interactive Demo

📋 Description: Retrieves metadata related to incremental borrowing rates within the financial organization structure, providing essential insights into the hierarchy and relationships of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

Incremental Borrowing Rate - Get All By Company

HTTP Request

GET /api/v1/incremental-borrowing-rates/company/{companyId}

Interactive Demo

📋 Description: Retrieves the incremental borrowing rates for a specified financial entity within the organization’s structure, identified by the company ID. This operation provides insights into the borrowing costs associated with the hierarchical financial framework.

Parameters

Name	In	Type	Required	Description
companyId	path	integer(int64)	true	Unique identifier for the company
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of incremental borrowing rates for a specified financial entity within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageIncrementalBorrowingRateDto

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,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "leaseLengthFrom": 0,
      "leaseLengthTo": 0,
      "rate": 0.1,
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "internalAssetClassId": 0,
      "internalAssetClassDisplayId": "string",
      "internalAssetClassName": "string",
      "contractCurrencyId": 0,
      "contractCurrencyDisplayId": "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

---