Currency

Object that represents a supported currency.

Supported API Calls: List | Get | Update

Object Properties

Property

Type

Description

Id

integer

A unique ID for a currency object. When adding a new currency the value must be 0.

Name

string (100)

Name of the currency.

IsActive

boolean

Flag to indicate if this currency is actively being supported.

IsDefault

boolean

Flag to indicate this is the default currency.

AlphaCode

string (100)

Currency's code

ExchangeRate

float

The Exchange Rate is relative to the default currency which is always set at 1.

List

Description

Returns a list of currencies supported by BlueCamroo.

URL

https://{company}.bluecamroo.com/api/currency/list

HTTP Method

GET

Data Return

Returns the currency list in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Update

Description

Updates a currency object.

URL

https://{company}.bluecamroo.com/api/currency/update

HTTP Method

Parameters

A currency object.

Data Return

Returns the currency object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)