Reversal Reason

Reversal Reason - Get

HTTP Request

GET /api/v1/reversal-reasons/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific reversal reason within the financial organization structure, identified by the provided ID, to support hierarchical decision-making and compliance within financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

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

Reversal Reason - Update

HTTP Request

PUT /api/v1/reversal-reasons/{id}

Interactive Demo

📋 Description: Updates the details of a specified reversal reason within the financial organization structure, ensuring that the hierarchy and organizational integrity of financial entities are maintained.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ReversalReasonDto	true	Request body containing the updated reversal reason data, including attributes that define its relationship within the financial organization structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

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

Reversal Reason - Delete

HTTP Request

DELETE /api/v1/reversal-reasons/{id}

Interactive Demo

📋 Description: Deletes a specified reversal reason from the financial organization structure, ensuring the integrity of the 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

Reversal Reason - Delete Or Decommission

HTTP Request

PUT /api/v1/reversal-reasons/remove/{id}

Interactive Demo

📋 Description: Removes a specified reversal reason from the financial organization structure, ensuring the integrity of the 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

Reversal Reason - Delete Or Decommission All

HTTP Request

PUT /api/v1/reversal-reasons/remove/bulk

Interactive Demo

📋 Description: Removes multiple reversal reasons in bulk from the financial organization structure, streamlining the management of hierarchical entities within the financial system.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity reversal reasons to be removed in bulk, ensuring streamlined organization and hierarchy management within the financial 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

Reversal Reason - Decommission

HTTP Request

PUT /api/v1/reversal-reasons/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified reversal reason within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant reversal reasons are no longer utilized in financial transactions.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

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

Reversal Reason - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/reversal-reasons/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions reversal reasons in the financial organization structure that were modified before the specified date, ensuring the integrity and relevance of the entity’s hierarchical data.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which reversal reasons are to be decommissioned within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Decommission Before Now

HTTP Request

PUT /api/v1/reversal-reasons/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions reversal reasons that have been modified before the current date within the financial organization structure, ensuring the hierarchy remains up-to-date and aligned with organizational policies.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Decommission All

HTTP Request

PUT /api/v1/reversal-reasons/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple reversal reasons within the financial organization structure, allowing for efficient management of the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity reversal reasons to be decommissioned in bulk, including relevant identifiers and metadata for organizational structure management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Create Or Update Bulk

HTTP Request

PUT /api/v1/reversal-reasons/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple reversal reasons in the financial organization structure, allowing for efficient management of hierarchical financial entities. This operation streamlines the process of maintaining accurate reversal reason data across the organization.

Parameters

Name	In	Type	Required	Description
body	body	ReversalReasonDto	true	Request body containing a list of reversal reasons, including their identifiers and associated metadata, for bulk creation or updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Create Or Update

HTTP Request

PUT /api/v1/reversal-reasons/createOrUpdate

Interactive Demo

📋 Description: Creates or updates reversal reasons within the financial organization structure, ensuring accurate representation of organizational hierarchy and financial entity management.

Parameters

Name	In	Type	Required	Description
body	body	ReversalReasonDto	true	Request body containing the details of reversal reasons, including their identifiers and associated metadata, to facilitate the creation or updating of financial entity structures within the organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

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

Reversal Reason - Bulk Update

HTTP Request

PUT /api/v1/reversal-reasons/bulk

Interactive Demo

📋 Description: Updates multiple reversal reasons in the financial organization structure, allowing for efficient management of hierarchy and organizational changes within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ReversalReasonDto	true	Request body containing a list of reversal reasons, including their identifiers and descriptions, to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Bulk Create

HTTP Request

POST /api/v1/reversal-reasons/bulk

Interactive Demo

📋 Description: Submits a bulk request to create or update reversal reasons within the financial organization structure, facilitating efficient management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ReversalReasonDto	true	Request body containing a list of reversal reasons, including associated metadata, to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

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

Reversal Reason - Bulk Delete

HTTP Request

DELETE /api/v1/reversal-reasons/bulk

Interactive Demo

📋 Description: Deletes multiple reversal reasons from the financial organization structure, allowing for streamlined management of hierarchical entities within the financial domain.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for multiple reversal reasons to be deleted within the financial organization 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

Reversal Reason - Search

HTTP Request

POST /api/v1/reversal-reasons/search

Interactive Demo

📋 Description: Submits a request to search for reversal reasons within the financial organization structure, allowing users to identify specific reasons associated with financial entity transactions.

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	ReversalReasonDtoFilter	false	Request body containing criteria for searching reversal reasons within the financial organization structure, including relevant identifiers and hierarchy details.

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",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReversalReasonDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "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

Reversal Reason - Find All

HTTP Request

GET /api/v1/reversal-reasons

Interactive Demo

📋 Description: Retrieves a list of reversal reasons associated with the financial organization structure, providing insights into the hierarchy and operational rationale within the financial entity.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the reversal reasons query should be returned in a paginated format, facilitating efficient navigation through the financial organization’s hierarchical structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReversalReasonDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "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

Reversal Reason - Create

HTTP Request

POST /api/v1/reversal-reasons

Interactive Demo

📋 Description: Creates a new reversal reason within the financial organization structure, enabling the classification and management of transaction reversals in alignment with the entity’s hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	ReversalReasonDto	true	Request body containing the reversal reason details, including the reason code and description, essential for maintaining the integrity of the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReversalReasonDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

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

Reversal Reason - Get Metadata

HTTP Request

GET /api/v1/reversal-reasons/meta

Interactive Demo

📋 Description: Retrieves metadata related to reversal reasons within the financial organization structure, providing insights into the hierarchy and classification of financial entities. This operation supports enhanced understanding and management of organizational processes.

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

Reversal Reason - Find All By System ID

HTTP Request

GET /api/v1/reversal-reasons/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the reversal reasons associated with a specified ERP system, providing insights into the financial organization structure and hierarchy of the entity.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of reversal reasons within the financial organization structure based on the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReversalReasonDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "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

---