Function: currency

Result: the list of elements

Currencies

Access level: admin

  • id — Id
  • name — Name
  • iso — ISO code
  • code — ISO number
  • status — Status

Name

Function: currency.relate

Result: the list of elements

Exchange rates

Access level: admin

  • relate — Name
  • iso — Code
  • ratedate — Last update
  • rate — Current rate
  • status — Upload currencies automatically

Name

Function: currencyrate

Result: the list of elements

Exchange rates

Access level: admin

  • id — Id
  • ratedate — Date
  • rate — Rate
Currency rate

Function: currencyrate.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid — parent list unique identifier (id element of currency.relate function).
    • elid — unique identifier (id element of currencyrate function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of currency.relate function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of currency.relate function).
    • elid — unique identifier (id element of currencyrate function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • ratedate — Date. Start date of the exchange rate
  • amount — Number. Number of items of the base currency
  • rate — Rate. Set the exchange rate for the date and units provided above
Delete

Function: currencyrate.delete

Delete

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currencyrate function.

Result: successful operation or error message

Upload exchange rate

Function: currencyrate.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid — parent list unique identifier (id element of currency.relate function).
    • elid — unique identifier (id element of currencyrate function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of currency.relate function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of currency.relate function).
    • elid — unique identifier (id element of currencyrate function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • autoupload — . (Optional parameter. To enable the option click "on".) Exchange rate will be uploaded automatically
  • autotime — Upload time. Enter the upload time (hh:mm). A cron job will start every day at this time to update exchange rates
  • upload — . (Optional parameter. To enable the option click "on".) Update exchange rates with parameters specified below
  • multi — Correction factor . Multiply the uploaded currency rate by the value from this field
  • sum — Increase by. Increase the uploaded currency rate by the value from this field
  • fromdate — Start date. Upload data starting from the selected date. Otherwise data will be uploaded from the last update date
  • rewrite — . (Optional parameter. To enable the option click "on".) Select the check box to overwrite the data saved in the system if the same date is used

Resume

Function: currency.resume

Resume

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message

Edit the selected currency

Function: currency.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of currency function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of currency function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name — Name. Enter a currency name
  • iso — ISO code. ISO code
  • symbol — Symbol . UTF symbol of the currency
  • code — ISO number. ISO number

Suspend

Function: currency.suspend

Suspend

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message

Update exchange rates

Function: currency.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of currency function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of currency function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Delete

Function: currency.delete

Delete

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message