Consumer Price Index Category¶
Get¶
HTTP Request
GET /api/v1/consumer-price-index-categories/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "country": "string",
20 "province": "string",
21 "city": "string",
22 "consumerPriceIndexSourceType": "WEB",
23 "source": "string",
24 "formula": "string",
25 "indexedCurrency": true,
26 "exchangeRateType": "string",
27 "erpSystemId": 0,
28 "erpSystemDisplayId": "string",
29 "fromCurrencyId": 0,
30 "fromCurrencyDisplayId": "string",
31 "toCurrencyId": 0,
32 "toCurrencyDisplayId": "string",
33 "consumerPriceIndexValueId": "string",
34 "companyId": 0
35 }
36}
Update¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "country": "string",
7 "province": "string",
8 "city": "string",
9 "consumerPriceIndexSourceType": "WEB",
10 "source": "string",
11 "formula": "string",
12 "indexedCurrency": true,
13 "exchangeRateType": "string",
14 "erpSystemId": 0,
15 "erpSystemDisplayId": "string",
16 "fromCurrencyId": 0,
17 "fromCurrencyDisplayId": "string",
18 "toCurrencyId": 0,
19 "toCurrencyDisplayId": "string",
20 "consumerPriceIndexValueId": "string",
21 "companyId": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "country": "string",
20 "province": "string",
21 "city": "string",
22 "consumerPriceIndexSourceType": "WEB",
23 "source": "string",
24 "formula": "string",
25 "indexedCurrency": true,
26 "exchangeRateType": "string",
27 "erpSystemId": 0,
28 "erpSystemDisplayId": "string",
29 "fromCurrencyId": 0,
30 "fromCurrencyDisplayId": "string",
31 "toCurrencyId": 0,
32 "toCurrencyDisplayId": "string",
33 "consumerPriceIndexValueId": "string",
34 "companyId": 0
35 }
36}
Delete¶
HTTP Request
DELETE /api/v1/consumer-price-index-categories/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Delete Or Decommission¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/remove/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Delete Or Decommission All¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/remove/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Decommission¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/decommission/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "country": "string",
20 "province": "string",
21 "city": "string",
22 "consumerPriceIndexSourceType": "WEB",
23 "source": "string",
24 "formula": "string",
25 "indexedCurrency": true,
26 "exchangeRateType": "string",
27 "erpSystemId": 0,
28 "erpSystemDisplayId": "string",
29 "fromCurrencyId": 0,
30 "fromCurrencyDisplayId": "string",
31 "toCurrencyId": 0,
32 "toCurrencyDisplayId": "string",
33 "consumerPriceIndexValueId": "string",
34 "companyId": 0
35 }
36}
Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/decommission/modified-before/{modified_before}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Decommission Before Now¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/decommission/modified-before-now
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Decommission All¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/decommission/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "country": "string",
8 "province": "string",
9 "city": "string",
10 "consumerPriceIndexSourceType": "WEB",
11 "source": "string",
12 "formula": "string",
13 "indexedCurrency": true,
14 "exchangeRateType": "string",
15 "erpSystemId": 0,
16 "erpSystemDisplayId": "string",
17 "fromCurrencyId": 0,
18 "fromCurrencyDisplayId": "string",
19 "toCurrencyId": 0,
20 "toCurrencyDisplayId": "string",
21 "consumerPriceIndexValueId": "string",
22 "companyId": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Create Or Update¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "country": "string",
7 "province": "string",
8 "city": "string",
9 "consumerPriceIndexSourceType": "WEB",
10 "source": "string",
11 "formula": "string",
12 "indexedCurrency": true,
13 "exchangeRateType": "string",
14 "erpSystemId": 0,
15 "erpSystemDisplayId": "string",
16 "fromCurrencyId": 0,
17 "fromCurrencyDisplayId": "string",
18 "toCurrencyId": 0,
19 "toCurrencyDisplayId": "string",
20 "consumerPriceIndexValueId": "string",
21 "companyId": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "country": "string",
20 "province": "string",
21 "city": "string",
22 "consumerPriceIndexSourceType": "WEB",
23 "source": "string",
24 "formula": "string",
25 "indexedCurrency": true,
26 "exchangeRateType": "string",
27 "erpSystemId": 0,
28 "erpSystemDisplayId": "string",
29 "fromCurrencyId": 0,
30 "fromCurrencyDisplayId": "string",
31 "toCurrencyId": 0,
32 "toCurrencyDisplayId": "string",
33 "consumerPriceIndexValueId": "string",
34 "companyId": 0
35 }
36}
Bulk Update¶
HTTP Request
PUT /api/v1/consumer-price-index-categories/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "country": "string",
8 "province": "string",
9 "city": "string",
10 "consumerPriceIndexSourceType": "WEB",
11 "source": "string",
12 "formula": "string",
13 "indexedCurrency": true,
14 "exchangeRateType": "string",
15 "erpSystemId": 0,
16 "erpSystemDisplayId": "string",
17 "fromCurrencyId": 0,
18 "fromCurrencyDisplayId": "string",
19 "toCurrencyId": 0,
20 "toCurrencyDisplayId": "string",
21 "consumerPriceIndexValueId": "string",
22 "companyId": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Bulk Create¶
HTTP Request
POST /api/v1/consumer-price-index-categories/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "country": "string",
8 "province": "string",
9 "city": "string",
10 "consumerPriceIndexSourceType": "WEB",
11 "source": "string",
12 "formula": "string",
13 "indexedCurrency": true,
14 "exchangeRateType": "string",
15 "erpSystemId": 0,
16 "erpSystemDisplayId": "string",
17 "fromCurrencyId": 0,
18 "fromCurrencyDisplayId": "string",
19 "toCurrencyId": 0,
20 "toCurrencyDisplayId": "string",
21 "consumerPriceIndexValueId": "string",
22 "companyId": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "name": "string",
20 "country": "string",
21 "province": "string",
22 "city": "string",
23 "consumerPriceIndexSourceType": "WEB",
24 "source": "string",
25 "formula": "string",
26 "indexedCurrency": true,
27 "exchangeRateType": "string",
28 "erpSystemId": 0,
29 "erpSystemDisplayId": "string",
30 "fromCurrencyId": 0,
31 "fromCurrencyDisplayId": "string",
32 "toCurrencyId": 0,
33 "toCurrencyDisplayId": "string",
34 "consumerPriceIndexValueId": "string",
35 "companyId": 0
36 }
37 ]
38}
Bulk Delete¶
HTTP Request
DELETE /api/v1/consumer-price-index-categories/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search¶
HTTP Request
POST /api/v1/consumer-price-index-categories/search
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 |
body |
body |
false |
none |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "uiSelector": "string",
24 "nameLike": "string",
25 "countryLike": "string",
26 "provinceLike": "string",
27 "cityLike": "string",
28 "consumerPriceIndexSourceTypeIn": [
29 "WEB"
30 ],
31 "sourceLike": "string",
32 "formulaLike": "string",
33 "indexedCurrencyEqual": true,
34 "exchangeRateTypeLike": "string",
35 "erpSystemIdEqual": 0,
36 "erpSystemDisplayIdLike": "string",
37 "fromCurrencyIdEqual": 0,
38 "fromCurrencyDisplayIdLike": "string",
39 "toCurrencyIdEqual": 0,
40 "toCurrencyDisplayIdLike": "string",
41 "consumerPriceIndexValueIdEqual": "string",
42 "companyIdEqual": 0,
43 "companyIdIn": [
44 0
45 ]
46}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "country": "string",
25 "province": "string",
26 "city": "string",
27 "consumerPriceIndexSourceType": "WEB",
28 "source": "string",
29 "formula": "string",
30 "indexedCurrency": true,
31 "exchangeRateType": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "fromCurrencyId": 0,
35 "fromCurrencyDisplayId": "string",
36 "toCurrencyId": 0,
37 "toCurrencyDisplayId": "string",
38 "consumerPriceIndexValueId": "string",
39 "companyId": 0
40 }
41 ],
42 "number": 0,
43 "sort": {
44 "sorted": true,
45 "unsorted": true,
46 "empty": true
47 },
48 "first": true,
49 "last": true,
50 "empty": true
51}
Detach Company¶
HTTP Request
POST /api/v1/consumer-price-index-categories/detach/company/{company_id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "country": "string",
8 "province": "string",
9 "city": "string",
10 "consumerPriceIndexSourceType": "WEB",
11 "source": "string",
12 "formula": "string",
13 "indexedCurrency": true,
14 "exchangeRateType": "string",
15 "erpSystemId": 0,
16 "erpSystemDisplayId": "string",
17 "fromCurrencyId": 0,
18 "fromCurrencyDisplayId": "string",
19 "toCurrencyId": 0,
20 "toCurrencyDisplayId": "string",
21 "consumerPriceIndexValueId": "string",
22 "companyId": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Attach Company¶
HTTP Request
POST /api/v1/consumer-price-index-categories/attach/company/{company_id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "country": "string",
8 "province": "string",
9 "city": "string",
10 "consumerPriceIndexSourceType": "WEB",
11 "source": "string",
12 "formula": "string",
13 "indexedCurrency": true,
14 "exchangeRateType": "string",
15 "erpSystemId": 0,
16 "erpSystemDisplayId": "string",
17 "fromCurrencyId": 0,
18 "fromCurrencyDisplayId": "string",
19 "toCurrencyId": 0,
20 "toCurrencyDisplayId": "string",
21 "consumerPriceIndexValueId": "string",
22 "companyId": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Find All¶
HTTP Request
GET /api/v1/consumer-price-index-categories
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "country": "string",
25 "province": "string",
26 "city": "string",
27 "consumerPriceIndexSourceType": "WEB",
28 "source": "string",
29 "formula": "string",
30 "indexedCurrency": true,
31 "exchangeRateType": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "fromCurrencyId": 0,
35 "fromCurrencyDisplayId": "string",
36 "toCurrencyId": 0,
37 "toCurrencyDisplayId": "string",
38 "consumerPriceIndexValueId": "string",
39 "companyId": 0
40 }
41 ],
42 "number": 0,
43 "sort": {
44 "sorted": true,
45 "unsorted": true,
46 "empty": true
47 },
48 "first": true,
49 "last": true,
50 "empty": true
51}
Create¶
HTTP Request
POST /api/v1/consumer-price-index-categories
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "country": "string",
7 "province": "string",
8 "city": "string",
9 "consumerPriceIndexSourceType": "WEB",
10 "source": "string",
11 "formula": "string",
12 "indexedCurrency": true,
13 "exchangeRateType": "string",
14 "erpSystemId": 0,
15 "erpSystemDisplayId": "string",
16 "fromCurrencyId": 0,
17 "fromCurrencyDisplayId": "string",
18 "toCurrencyId": 0,
19 "toCurrencyDisplayId": "string",
20 "consumerPriceIndexValueId": "string",
21 "companyId": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "name": "string",
19 "country": "string",
20 "province": "string",
21 "city": "string",
22 "consumerPriceIndexSourceType": "WEB",
23 "source": "string",
24 "formula": "string",
25 "indexedCurrency": true,
26 "exchangeRateType": "string",
27 "erpSystemId": 0,
28 "erpSystemDisplayId": "string",
29 "fromCurrencyId": 0,
30 "fromCurrencyDisplayId": "string",
31 "toCurrencyId": 0,
32 "toCurrencyDisplayId": "string",
33 "consumerPriceIndexValueId": "string",
34 "companyId": 0
35 }
36}
Get Metadata¶
HTTP Request
GET /api/v1/consumer-price-index-categories/meta
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "NAME"
3]
Response Schema
Get All By Company¶
HTTP Request
GET /api/v1/consumer-price-index-categories/company/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "country": "string",
25 "province": "string",
26 "city": "string",
27 "consumerPriceIndexSourceType": "WEB",
28 "source": "string",
29 "formula": "string",
30 "indexedCurrency": true,
31 "exchangeRateType": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "fromCurrencyId": 0,
35 "fromCurrencyDisplayId": "string",
36 "toCurrencyId": 0,
37 "toCurrencyDisplayId": "string",
38 "consumerPriceIndexValueId": "string",
39 "companyId": 0
40 }
41 ],
42 "number": 0,
43 "sort": {
44 "sorted": true,
45 "unsorted": true,
46 "empty": true
47 },
48 "first": true,
49 "last": true,
50 "empty": true
51}