Consumer Price Index Value

Consumer Price Index Value - Get

HTTP Request

GET /api/v1/consumer-price-index-values/{id}

Interactive Demo

📋 Description: Retrieves the consumer price index value for a specified financial entity, providing insights into the organization’s economic performance within its hierarchical structure.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Consumer Price Index Value - Update

HTTP Request

PUT /api/v1/consumer-price-index-values/{id}

Interactive Demo

📋 Description: Updates the consumer price index value for a specified financial entity within the organizational structure, ensuring accurate representation of economic data in the hierarchy.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ConsumerPriceIndexValueDto	true	Request body containing updated consumer price index values, including relevant financial metrics and hierarchical identifiers for the specified organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "value": 0,
  "effectiveDate": "2019-08-24",
  "consumerPriceIndexCategoryId": 0,
  "consumerPriceIndexCategoryDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Consumer Price Index Value - Delete

HTTP Request

DELETE /api/v1/consumer-price-index-values/{id}

Interactive Demo

📋 Description: Deletes a specified consumer price index value 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

Consumer Price Index Value - Delete Or Decommission

HTTP Request

PUT /api/v1/consumer-price-index-values/remove/{id}

Interactive Demo

📋 Description: Removes a specified Consumer Price Index (CPI) value 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

Consumer Price Index Value - Delete Or Decommission All

HTTP Request

PUT /api/v1/consumer-price-index-values/remove/bulk

Interactive Demo

📋 Description: Removes multiple consumer price index values in bulk from the financial organization structure, ensuring accurate hierarchy management within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of consumer price index values to be removed in bulk, reflecting adjustments 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

Consumer Price Index Value - Decommission

HTTP Request

PUT /api/v1/consumer-price-index-values/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified Consumer Price Index (CPI) value within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures the integrity and accuracy of financial data 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	ResponseConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Consumer Price Index Value - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/consumer-price-index-values/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions consumer price index values that were modified before the specified date, facilitating the maintenance of an accurate financial organization structure and hierarchy. This operation ensures that outdated data is effectively managed within the financial entity’s records.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which consumer price index values will be decommissioned, ensuring alignment with the organization’s financial hierarchy and structural integrity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Decommission Before Now

HTTP Request

PUT /api/v1/consumer-price-index-values/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions consumer price index values that were modified before the current date, ensuring the integrity of the financial organization structure by removing outdated data from the hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Decommission All

HTTP Request

PUT /api/v1/consumer-price-index-values/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple consumer price index values in bulk, allowing financial organizations to efficiently manage and update their hierarchical structure and data integrity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a bulk list of consumer price index values to be decommissioned, including associated metadata and identifiers for financial entities within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Create Or Update Bulk

HTTP Request

PUT /api/v1/consumer-price-index-values/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple consumer price index values in bulk, enabling efficient management of financial data within the organizational structure and hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexValueDto	true	Request body containing bulk data for creating or updating consumer price index values, including relevant financial entity identifiers and hierarchical organization structure details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Create Or Update

HTTP Request

PUT /api/v1/consumer-price-index-values/createOrUpdate

Interactive Demo

📋 Description: Creates or updates consumer price index values within the financial organization structure, ensuring accurate representation of economic data in relation to the organization’s hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexValueDto	true	Request body containing the consumer price index values along with associated metadata for the financial organization structure, enabling the creation or update of hierarchical financial entity data.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "value": 0,
  "effectiveDate": "2019-08-24",
  "consumerPriceIndexCategoryId": 0,
  "consumerPriceIndexCategoryDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Consumer Price Index Value - Bulk Update

HTTP Request

PUT /api/v1/consumer-price-index-values/bulk

Interactive Demo

📋 Description: Updates multiple consumer price index values in bulk for a specified financial organization structure, ensuring accurate and timely data management within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexValueDto	true	Request body containing a bulk set of consumer price index values, including relevant financial entity identifiers and hierarchical organization structure details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Bulk Create

HTTP Request

POST /api/v1/consumer-price-index-values/bulk

Interactive Demo

📋 Description: Submits bulk consumer price index values for multiple financial entities within the organizational structure, enabling efficient updates and management of economic data across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexValueDto	true	Request body containing bulk consumer price index values, including associated financial organization identifiers and hierarchical structure details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Consumer Price Index Value - Bulk Delete

HTTP Request

DELETE /api/v1/consumer-price-index-values/bulk

Interactive Demo

📋 Description: Deletes multiple consumer price index values in bulk, allowing for efficient management of financial data within the organization’s structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the consumer price index values to be deleted, reflecting the financial organization structure and hierarchy.

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

Consumer Price Index Value - Search

HTTP Request

POST /api/v1/consumer-price-index-values/search

Interactive Demo

📋 Description: Submits a request to search for consumer price index values within the financial organization structure, allowing users to filter results based on specific criteria related to organizational hierarchy and 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	ConsumerPriceIndexValueDtoFilter	false	Request body containing the search criteria for consumer price index values, including parameters related to organizational structure and financial entity hierarchy.

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",
  "valueEqual": 0,
  "effectiveDateGreaterThanOrEqual": "2019-08-24",
  "effectiveDateLessThanOrEqual": "2019-08-24",
  "effectiveDateEqual": "2019-08-24",
  "consumerPriceIndexCategoryIdEqual": 0,
  "consumerPriceIndexCategoryDisplayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageConsumerPriceIndexValueDto

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",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "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

Consumer Price Index Value - Detach Consumer Price Index Category

HTTP Request

POST /api/v1/consumer-price-index-values/detach/consumer-price-index-category/{consumerPriceIndexCategoryId}

Interactive Demo

📋 Description: Detaches a specified consumer price index category from the financial organization structure, allowing for adjustments in the hierarchy of financial entities. This operation ensures that the organizational structure remains aligned with current financial reporting needs.

Parameters

Name	In	Type	Required	Description
consumerPriceIndexCategoryId	path	integer(int64)	true	Unique identifier for the consumer price index category
body	body	ConsumerPriceIndexValueDto	true	Request body containing the details necessary to detach a consumer price index category from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "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

Consumer Price Index Value - Attach Consumer Price Index Category

HTTP Request

POST /api/v1/consumer-price-index-values/attach/consumer-price-index-category/{relation_id}

Interactive Demo

📋 Description: Attaches a specified consumer price index category to a financial entity within the organizational structure, facilitating enhanced categorization and analysis of financial data.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the consumer price index category within the financial organization structure, facilitating the attachment of relevant data in a hierarchical context.
body	body	ConsumerPriceIndexValueDto	true	Request body containing the consumer price index category data, including relevant attributes and metadata, to establish a relationship within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "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

Consumer Price Index Value - Find All

HTTP Request

GET /api/v1/consumer-price-index-values

Interactive Demo

📋 Description: Fetches the consumer price index values associated with the financial organization structure, providing insights into economic trends within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the consumer price index values 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	PageConsumerPriceIndexValueDto

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",
      "value": 0,
      "effectiveDate": "2019-08-24",
      "consumerPriceIndexCategoryId": 0,
      "consumerPriceIndexCategoryDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "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

Consumer Price Index Value - Create

HTTP Request

POST /api/v1/consumer-price-index-values

Interactive Demo

📋 Description: Submits new consumer price index values for a specified financial organization, facilitating accurate tracking and analysis of economic indicators within the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexValueDto	true	Request body containing the consumer price index values data, including relevant financial entity identifiers and hierarchical structure details.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "value": 0,
  "effectiveDate": "2019-08-24",
  "consumerPriceIndexCategoryId": 0,
  "consumerPriceIndexCategoryDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexValueDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "value": 0,
    "effectiveDate": "2019-08-24",
    "consumerPriceIndexCategoryId": 0,
    "consumerPriceIndexCategoryDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Consumer Price Index Value - Get Metadata

HTTP Request

GET /api/v1/consumer-price-index-values/meta

Interactive Demo

📋 Description: Retrieves metadata related to the consumer price index values, providing insights into the organizational structure and hierarchy of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "VALUE"
]

Response Schema

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

---