Documentation

Skip to end of metadata
Go to start of metadata

Cost Code - Currencies Resource

Exposed Resources Hierarchy
Cost Code - Currencies Resource

Contents:

It is possible to assign a price for each existing currency to a cost code.

Main URI of the Resource

This class operates mainly over the Resource URI: /config/costcodes/{costcode}/currencies

Exposed Methods

Create New Cost Code - Currency

Method to add a single cost code - currency. Set the price for the given cost code and currency.

Synopsis: POST http://example.com/api/config/costcodes/{costcode}/currencies
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: application/vnd.abiquo.costcodecurrency+json; version=3.8; application/vnd.abiquo.costcodecurrency+xml; version=3.8;  Content-type:  application/vnd.abiquo.costcodecurrency+json; version=3.8; application/vnd.abiquo.costcodecurrency+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: CostCodeCurrency Media Type
Response Message Body Entity: CostCodeCurrency Media Type
Request Example:

 Click here to show or hide the request example

API example removed: POST_cfg_ccs_X_currs_CT_cccurr_j_AC_cccurr_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

 

Create Multiple New Cost Code - Currencies

Method to add multiple cost code - currencies. Set the price for the given cost code in all the currencies.

Synopsis: POST http://example.com/api/config/costcodes/{costcode}/currencies
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: application/vnd.abiquo.costcodecurrencies+json; version=3.8; application/vnd.abiquo.costcodecurrencies+xml; version=3.8;  Content-type:  application/vnd.abiquo.costcodecurrencies+json; version=3.8; application/vnd.abiquo.costcodecurrencies+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: CostCodeCurrencies Media Type
Response Message Body Entity: CostCodeCurrencies Media Type
Request Example:

 Click here to show or hide the request example

 

API example removed: POST_cfg_ccs_X_currs_CT_cccurrs_j_AC_cccurrs_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

 

Modify Cost Code - Currencies

Modify the price for the given cost code in the all the currencies.

Synopsis: PUT http://example.com/api/config/costcodes/{costcode}/currencies
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: application/vnd.abiquo.costcodecurrencies+json; version=3.8; application/vnd.abiquo.costcodecurrencies+xml; version=3.8;  Content-type:  application/vnd.abiquo.costcodecurrencies+json; version=3.8; application/vnd.abiquo.costcodecurrencies+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: CostCodeCurrencies Media Type
Response Message Body Entity: CostCodeCurrencies Media Type
Request Example:

 Click here to show or hide the request example

API example removed: PUT_cfg_ccs_X_currs_X_CT_cccurr_j_AC_cccurr_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

 

Get Cost Code - Currencies

Retrieve the list of cost code-currencies for the given cost code in the all the currencies. The result can be filtered by a currency.

Synopsis: GET http://example.com/api/config/costcodes/{costcode}/currencies
Roles Required: ROLE_PRICING_VIEW
Request Headers: Accept: application/vnd.abiquo.costcodecurrencies+json; version=3.8; application/vnd.abiquo.costcodecurrencies+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

idCurrency

false

 

identifier of the {@link CurrencyDto} to filter the list.

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: CostCodeCurrencies Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_cfg_ccs_X_currs_AC_cccurrs_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Remove Cost Code - Currencies

Delete all the existing cost code-currency relations for the given cost code.

Synopsis: DELETE http://example.com/api/config/costcodes/{costcode}/currencies
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

 

API example removed: DELETE_cfg_ccs_X_currs_X
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Main URI of the Resource

This class operates mainly over the Resource URI: /config/costcodes/{costcode}/currencies/{currency}

Exposed Methods

Get Cost Code - Currency

Retrieve a single cost code - currency for the given cost code and currency.

Synopsis: GET http://example.com/api/config/costcodes/{costcode}/currencies/{currency}
Roles Required: ROLE_PRICING_VIEW
Request Headers: Accept: application/vnd.abiquo.costcodecurrency+json; version=3.8; application/vnd.abiquo.costcodecurrency+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: CostCodeCurrency Media Type
Request Example:

 Click here to show or hide the request example

 

API example removed: GET_cfg_ccs_X_currs_X_AC_cccurr_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Update CostCode - Currency

Update a cost code - currency.

Synopsis: PUT http://example.com/api/config/costcodes/{costcode}/currencies/{currency}
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: application/vnd.abiquo.costcodecurrency+json; version=3.8; application/vnd.abiquo.costcodecurrency+xml; version=3.8;  Content-type:  application/vnd.abiquo.costcodecurrency+json; version=3.8; application/vnd.abiquo.costcodecurrency+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: CostCodeCurrency Media Type
Response Message Body Entity: CostCodeCurrency Media Type
Request Example:

 Click here to show or hide the request example

 

API example removed: PUT_cfg_ccs_X_currs_X_CT_cccurr_j_AC_cccurr_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

 

Remove an existing Cost Code - Currency

Remove an existing cost code - currency.

Synopsis: DELETE http://example.com/api/config/costcodes/{costcode}/currencies/{currency}
Roles Required: ROLE_PRICING_MANAGE
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

 

API example removed: DELETE_cfg_ccs_X_currs_X
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip