Unit Of Measure

Unit Of Measure - Get

HTTP Request

GET /api/v1/unit-of-measures/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific unit of measure within the financial organization structure, identified by its unique ID, to support effective hierarchy management and financial entity analysis.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUnitOfMeasureDto

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

Unit Of Measure - Update

HTTP Request

PUT /api/v1/unit-of-measures/{id}

Interactive Demo

📋 Description: Updates the details of a specific unit of measure within the financial organization structure, enabling accurate representation and management of measurement standards across the financial entity’s hierarchy.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	UnitOfMeasureDto	true	Request body containing the updated unit of measure data, including its name, type, and associated financial entity details, to ensure accurate representation within the organization’s financial structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUnitOfMeasureDto

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

Unit Of Measure - Delete

HTTP Request

DELETE /api/v1/unit-of-measures/{id}

Interactive Demo

📋 Description: Deletes a specified unit of measure from the financial organization structure, ensuring that the hierarchy remains accurate and up-to-date for all 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	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

Unit Of Measure - Delete Or Decommission

HTTP Request

PUT /api/v1/unit-of-measures/remove/{id}

Interactive Demo

📋 Description: Removes a specified unit of measure 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

Unit Of Measure - Delete Or Decommission All

HTTP Request

PUT /api/v1/unit-of-measures/remove/bulk

Interactive Demo

📋 Description: Removes multiple unit of measures from the financial organization structure in a single operation, streamlining the management of hierarchical data within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of unit of measure identifiers to be removed in bulk from 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

Unit Of Measure - Decommission

HTTP Request

PUT /api/v1/unit-of-measures/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified unit of measure within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unnecessary units are no longer utilized in financial transactions and reporting.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUnitOfMeasureDto

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

Unit Of Measure - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/unit-of-measures/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions unit of measures in the financial organization structure that were modified before the specified date, ensuring the hierarchy remains streamlined and relevant to current operational needs.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Decommission Before Now

HTTP Request

PUT /api/v1/unit-of-measures/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions unit of measures that were modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational requirements. This operation supports the maintenance of an accurate hierarchy within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Decommission All

HTTP Request

PUT /api/v1/unit-of-measures/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple unit of measures in a financial organization structure, ensuring the hierarchy and integrity of the financial entity are maintained during the bulk update process.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of unit of measure identifiers and their corresponding decommissioning details, facilitating the bulk decommissioning process within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Create Or Update Bulk

HTTP Request

PUT /api/v1/unit-of-measures/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple unit of measures in bulk within the financial organization structure, ensuring alignment with the hierarchical framework of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	UnitOfMeasureDto	true	Request body containing a bulk array of unit of measure data, including identifiers and attributes, to facilitate the creation or update 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	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Create Or Update

HTTP Request

PUT /api/v1/unit-of-measures/createOrUpdate

Interactive Demo

📋 Description: Creates or updates unit of measure entries within the financial organization structure, ensuring accurate representation of measurement standards across the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	UnitOfMeasureDto	true	Request body containing the unit of measure data, including attributes for organization hierarchy and financial entity alignment, for creating or updating measurement standards.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUnitOfMeasureDto

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

Unit Of Measure - Bulk Update

HTTP Request

PUT /api/v1/unit-of-measures/bulk

Interactive Demo

📋 Description: Updates multiple unit of measures in bulk for the financial organization structure, enabling efficient management of measurement standards across the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	UnitOfMeasureDto	true	Request body containing an array of unit of measure data for bulk updates within the financial organization structure, including relevant identifiers and attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Bulk Create

HTTP Request

POST /api/v1/unit-of-measures/bulk

Interactive Demo

📋 Description: Creates multiple unit of measures in bulk for financial entities, facilitating the efficient management of organizational structures and hierarchies.

Parameters

Name	In	Type	Required	Description
body	body	UnitOfMeasureDto	true	Request body containing an array of unit of measure definitions to facilitate the bulk creation or update of financial entities within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUnitOfMeasureDto

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

Unit Of Measure - Bulk Delete

HTTP Request

DELETE /api/v1/unit-of-measures/bulk

Interactive Demo

📋 Description: Deletes multiple unit of measures in bulk from the financial organization structure, streamlining the management of measurement standards within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of unit of measure identifiers to be deleted in bulk from 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

Unit Of Measure - Search

HTTP Request

POST /api/v1/unit-of-measures/search

Interactive Demo

📋 Description: Submits a request to search for unit of measures within the financial organization structure, enabling users to identify and manage measurement standards relevant to their 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	UnitOfMeasureDtoFilter	false	Request body containing search criteria for unit of measures within the financial organization structure, including relevant identifiers and attributes to facilitate hierarchical data retrieval.

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	PageUnitOfMeasureDto

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

Unit Of Measure - Find All

HTTP Request

GET /api/v1/unit-of-measures

Interactive Demo

📋 Description: Retrieves a list of unit of measures utilized within the financial organization structure, providing insights into the hierarchy and classification of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageUnitOfMeasureDto

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

Unit Of Measure - Create

HTTP Request

POST /api/v1/unit-of-measures

Interactive Demo

📋 Description: Creates a new unit of measure within the financial organization structure, enabling the definition and management of measurement standards for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	UnitOfMeasureDto	true	Request body containing the details of unit of measures, including their definitions and relationships 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	ResponseUnitOfMeasureDto

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

Unit Of Measure - Get Metadata

HTTP Request

GET /api/v1/unit-of-measures/meta

Interactive Demo

📋 Description: Retrieves metadata related to unit of measures within the financial organization structure, providing insights into the hierarchy and classification of financial entities. This operation supports effective management and analysis of organizational metrics.

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

Unit Of Measure - Find All By System ID

HTTP Request

GET /api/v1/unit-of-measures/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the unit of measures associated with a specified ERP system, facilitating the alignment of financial entities within the organizational structure and hierarchy.

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 efficient retrieval of unit of measures within the financial organization structure for the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageUnitOfMeasureDto

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

---