Consumer Price Index Category

Consumer Price Index Category - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific consumer price index category within the financial organization structure, identified by the provided ID.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
}

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

Consumer Price Index Category - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified consumer price index category within the financial organization structure, ensuring accurate representation of the hierarchy and organizational data.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing updated information for the specified consumer price index category, including attributes relevant to the organization’s financial structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "country": "string",
  "province": "string",
  "city": "string",
  "consumerPriceIndexSourceType": "WEB",
  "source": "string",
  "formula": "string",
  "indexedCurrency": true,
  "exchangeRateType": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string",
  "consumerPriceIndexValueId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
}

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

Consumer Price Index Category - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified consumer price index category 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 Category - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified consumer price index category from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date.

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 Category - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple consumer price index categories in bulk from the financial organization structure, ensuring streamlined management of financial entities and their hierarchical classifications.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of consumer price index category 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

Consumer Price Index Category - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified consumer price index category within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures the integrity and relevance of organizational data by allowing for the management of outdated or unnecessary categories.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
}

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

Consumer Price Index Category - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions consumer price index categories that were modified before the specified date, enabling organizations to maintain an accurate and relevant financial structure within their hierarchy. This operation supports effective management of financial entities by streamlining outdated category data.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions consumer price index categories that were modified before the current date, ensuring the financial organization structure remains up-to-date and relevant. This operation supports the maintenance of an accurate hierarchy within financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple consumer price index categories in bulk, allowing financial organizations to efficiently manage their hierarchical structure and maintain accurate financial entity classifications.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of consumer price index category identifiers for bulk decommissioning within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple consumer price index categories in bulk, facilitating efficient management of financial organization structures and hierarchies within a financial entity.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing bulk data for creating or updating consumer price index categories, including relevant attributes and hierarchical relationships within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Create Or Update

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates consumer price index categories within the financial organization structure, ensuring accurate representation of hierarchical relationships and facilitating effective financial entity management.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing the consumer price index category data, including details for creating or updating financial entity classifications within the organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "country": "string",
  "province": "string",
  "city": "string",
  "consumerPriceIndexSourceType": "WEB",
  "source": "string",
  "formula": "string",
  "indexedCurrency": true,
  "exchangeRateType": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string",
  "consumerPriceIndexValueId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
}

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

Consumer Price Index Category - Bulk Update

HTTP Request

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

Interactive Demo

📋 Description: Updates multiple consumer price index categories in bulk, allowing financial organizations to efficiently manage and restructure their hierarchical data within the financial entity framework.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing a bulk update of consumer price index categories, including hierarchical structure and organizational identifiers relevant to financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Bulk Create

HTTP Request

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

Interactive Demo

📋 Description: Submits multiple consumer price index categories in bulk to the financial organization structure, facilitating efficient updates and management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing a bulk upload of consumer price index category data, including hierarchical relationships and organizational structure details relevant to financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ]
}

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

Consumer Price Index Category - Bulk Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes multiple consumer price index categories in bulk, allowing for efficient management of financial organization structures and hierarchies within a financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of consumer price index category identifiers to be deleted in bulk, relevant for managing 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 Category - Search

HTTP Request

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

Interactive Demo

📋 Description: Submits a search request for consumer price index categories within the financial organization structure, enabling users to identify and analyze relevant financial entities based on hierarchical relationships.

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	ConsumerPriceIndexCategoryDtoFilter	false	Request body containing search criteria for consumer price index categories, including filters relevant to the financial organization structure and 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",
  "uiSelector": "string",
  "nameLike": "string",
  "countryLike": "string",
  "provinceLike": "string",
  "cityLike": "string",
  "consumerPriceIndexSourceTypeIn": [
    "WEB"
  ],
  "sourceLike": "string",
  "formulaLike": "string",
  "indexedCurrencyEqual": true,
  "exchangeRateTypeLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdLike": "string",
  "fromCurrencyIdEqual": 0,
  "fromCurrencyDisplayIdLike": "string",
  "toCurrencyIdEqual": 0,
  "toCurrencyDisplayIdLike": "string",
  "consumerPriceIndexValueIdEqual": "string",
  "companyIdEqual": 0,
  "companyIdIn": [
    0
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageConsumerPriceIndexCategoryDto

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",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ],
  "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 Category - Detach Company

HTTP Request

POST /api/v1/consumer-price-index-categories/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from its associated consumer price index categories within the financial organization structure, facilitating the management of organizational hierarchy and financial entity 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 detach consumer price index categories.
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing the details of the consumer price index category to be detached from the specified financial entity, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 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 Category - Attach Company

HTTP Request

POST /api/v1/consumer-price-index-categories/attach/company/{company_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
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to associate consumer price index categories during the attachment process.
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing the financial entity association data, including category identifiers and hierarchical relationships for the specified company.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 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 Category - Find All

HTTP Request

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

Interactive Demo

📋 Description: Retrieves a list of consumer price index categories within the financial organization structure, providing insights into the hierarchical classification of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageConsumerPriceIndexCategoryDto

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",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ],
  "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 Category - Create

HTTP Request

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

Interactive Demo

📋 Description: Creates a new consumer price index category within the financial organization structure, enabling the classification and hierarchy of financial entities for enhanced data management and analysis.

Parameters

Name	In	Type	Required	Description
body	body	ConsumerPriceIndexCategoryDto	true	Request body containing the financial organization structure data for consumer price index categories, including relevant attributes and hierarchical relationships.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "country": "string",
  "province": "string",
  "city": "string",
  "consumerPriceIndexSourceType": "WEB",
  "source": "string",
  "formula": "string",
  "indexedCurrency": true,
  "exchangeRateType": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string",
  "consumerPriceIndexValueId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseConsumerPriceIndexCategoryDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "country": "string",
    "province": "string",
    "city": "string",
    "consumerPriceIndexSourceType": "WEB",
    "source": "string",
    "formula": "string",
    "indexedCurrency": true,
    "exchangeRateType": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string",
    "consumerPriceIndexValueId": "string",
    "companyId": 0
  }
}

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

Consumer Price Index Category - Get Metadata

HTTP Request

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

Interactive Demo

📋 Description: Fetches metadata for consumer price index categories within the financial organization structure, providing insights into the hierarchical relationships and classifications 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

Consumer Price Index Category - Get All By Company

HTTP Request

GET /api/v1/consumer-price-index-categories/company/{id}

Interactive Demo

📋 Description: Fetches the consumer price index categories associated with a specific financial entity, identified by its unique ID, to support organizational structure and hierarchy analysis.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of consumer price index categories for a specified financial entity within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageConsumerPriceIndexCategoryDto

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",
      "country": "string",
      "province": "string",
      "city": "string",
      "consumerPriceIndexSourceType": "WEB",
      "source": "string",
      "formula": "string",
      "indexedCurrency": true,
      "exchangeRateType": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string",
      "consumerPriceIndexValueId": "string",
      "companyId": 0
    }
  ],
  "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

---