JavaScript SDK Samples - Currencies Operations
Get Currencies
class Currency
{
/**
* Get Currencies
* This method is used to get all the available currencies in your organization.
*/
static async getCurrencies() {
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Call getCurrencies method
let response = await currenciesOperations.getCurrencies();
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.ResponseWrapper) {
//Get the array of obtained Currency instances
let currencies = responseObject.getCurrencies();
currencies.forEach(currency => {
//Get the Id of each currency
console.log("Currency Id: " + currency.getId());
//Get the IsoCode of each currency
console.log("Currency IsoCode: " + currency.getIsoCode());
//Get the Symbol of each currency
console.log("Currency Symbol: " + currency.getSymbol());
//Get the CreatedTime of each currency
console.log("Currency CreatedTime: " + currency.getCreatedTime());
//Get if the currency is active
console.log("Currency IsActive: " + currency.getIsActive().toString());
//Get the ExchangeRate of each currency
console.log("Currency ExchangeRate: " + currency.getExchangeRate());
//Get the format instance of each currency
let format = currency.getFormat();
if (format != null) {
//Get the DecimalSeparator of the Format
console.log("Currency Format DecimalSeparator: " + format.getDecimalSeparator().getValue());
//Get the ThousandSeparator of the Format
console.log("Currency Format ThousandSeparator: " + format.getThousandSeparator().getValue());
//Get the DecimalPlaces of the Format
console.log("Currency Format DecimalPlaces: " + format.getDecimalPlaces().getValue());
}
//Get the createdBy User instance of each currency
let createdBy = currency.getCreatedBy();
//Check if createdBy is not null
if (createdBy != null) {
//Get the Name of the createdBy User
console.log("Currency CreatedBy User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Currency CreatedBy User-ID: " + createdBy.getId());
}
//Get the PrefixSymbol of each currency
console.log("Currency PrefixSymbol: " + currency.getPrefixSymbol().toString());
//Get the IsBase of each currency
console.log("Currency IsBase: " + currency.getIsBase().toString());
//Get the ModifiedTime of each currency
console.log("Currency ModifiedTime: " + currency.getModifiedTime());
//Get the Name of each currency
console.log("Currency Name: " + currency.getName());
//Get the modifiedBy User instance of each currency
let modifiedBy = currency.getModifiedBy();
//Check if modifiedBy is not null
if (modifiedBy != null) {
//Get the Name of the modifiedBy User
console.log("Currency ModifiedBy User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Currency ModifiedBy User-ID: " + modifiedBy.getId());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Add Currencies
class Currency
{
/**
* Add Currencies
* This method is used to add new currencies to your organization.
*/
static async addCurrencies() {
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Currency.Model.BodyWrapper();
//Array to hold Currency instances
let currencies = [];
//Get instance of Currency Class
let currency = new ZCRM.Currency.Model.Currency();
//To set the position of the ISO code in the currency.
//true: Display ISO code before the currency value.
//false: Display ISO code after the currency value.
currency.setPrefixSymbol(true);
//To set the name of the currency.
currency.setName("Angolan Kwanza - AOA");
//To set the ISO code of the currency.
currency.setIsoCode("AOA");
//To set the symbol of the currency.
currency.setSymbol("Kz");
//To set the rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("20.000000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
let format = new ZCRM.Currency.Model.Format();
//It can be a Period or Comma, depending on the currency.
format.setDecimalSeparator(new Choice("Period"));
//It can be a Period, Comma, or Space, depending on the currency.
format.setThousandSeparator(new Choice("Comma"));
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice("2"));
//To set the format of the currency
currency.setFormat(format);
currencies.push(currency);
//Set the array to Currency in BodyWrapper instance
request.setCurrencies(currencies);
//Call addCurrencies method that takes BodyWrapper instance as parameter
let response = await currenciesOperations.addCurrencies(request);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ActionWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getCurrencies();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Currency.Model.SuccessResponse) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Update Currencies
class Currency
{
/**
* Update Currencies
* This method is used to update currency details.
*/
static async updateCurrencies() {
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Currency.Model.BodyWrapper();
//Array to hold Currency instances
let currencies = [];
//Get instance of Currency Class
let currency = new ZCRM.Currency.Model.Currency();
//To set currency Id
currency.setId(3477061000006008002n);
//To set the position of the ISO code in the currency.
//true: Display ISO code before the currency value.
//false: Display ISO code after the currency value.
currency.setPrefixSymbol(true);
//To set the rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("10.000000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
let format = new ZCRM.Currency.Model.Format();
//It can be a Period or Comma, depending on the currency.
format.setDecimalSeparator(new Choice("Period"));
//It can be a Period, Comma, or Space, depending on the currency.
format.setThousandSeparator(new Choice("Space"));
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice("2"));
//To set the format of the currency
currency.setFormat(format);
//Add Currency instance to the array
currencies.push(currency);
//Set the array to Currency in BodyWrapper instance
request.setCurrencies(currencies);
//Call updateCurrencies method that takes BodyWrapper instance as parameter
let response = await currenciesOperations.updateCurrencies(request);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ActionWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getCurrencies();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Currency.Model.SuccessResponse) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Enable Multiple Currencies
Update the Base Currency
class Currency
{
/**
* Update Currency
* This method is used to update base currency details.
*/
static async updateBaseCurrency() {
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Get instance of BaseCurrencyWrapper Class that will contain the request body
let request = new ZCRM.Currency.Model.BaseCurrencyWrapper();
//Get instance of Currency Class
let currency = new ZCRM.Currency.Model.Currency();
//To set the position of the ISO code in the base currency.
//true: Display ISO code before the currency value.
//false: Display ISO code after the currency value.
currency.setPrefixSymbol(true);
//To set the symbol of the base currency.
currency.setSymbol("Af");
//To set the rate at which the currency has to be exchanged for home base currency.
currency.setExchangeRate("1.0000000");
//To set currency Id
currency.setId(3477061000006008002n);
let format = new ZCRM.Currency.Model.Format();
//It can be a Period or Comma, depending on the base currency.
format.setDecimalSeparator(new Choice("Period"));
//It can be a Period, Comma, or Space, depending on the base currency.
format.setThousandSeparator(new Choice("Comma"));
//To set the number of decimal places allowed for the base currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice("2"));
//To set the format of the base currency
currency.setFormat(format);
//Set the Currency in BodyWrapper instance
request.setBaseCurrency(currency);
//Call updateBaseCurrency method that takes BodyWrapper instance as parameter
let response = await currenciesOperations.updateBaseCurrency(request);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected BaseCurrencyActionWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.BaseCurrencyActionWrapper) {
//Get the received obtained ActionResponse instances
let actionResponse = responseObject.getBaseCurrency();
//Check if the request is successful
if (actionResponse instanceof ZCRM.Currency.Model.SuccessResponse) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Get a Currency
class Currency
{
/**
* Get Currency
* This method is used to get the details of a specific currency.
* @param {BigInt} currencyId Specify the unique ID of the currency.
*/
static async getCurrency(currencyId) {
//example
//let currencyId = 3477061000006011001n;
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Call getCurrency method that takes currencyId as parameter
let response = await currenciesOperations.getCurrency(currencyId);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.ResponseWrapper) {
//Get the array of obtained Currency instances
let currencies = responseObject.getCurrencies();
currencies.forEach(currency => {
//Get the Id of each currency
console.log("Currency Id: " + currency.getId());
//Get the IsoCode of each currency
console.log("Currency IsoCode: " + currency.getIsoCode());
//Get the Symbol of each currency
console.log("Currency Symbol: " + currency.getSymbol());
//Get the CreatedTime of each currency
console.log("Currency CreatedTime: " + currency.getCreatedTime());
//Get if the currency is active
console.log("Currency IsActive: " + currency.getIsActive().toString());
//Get the ExchangeRate of each currency
console.log("Currency ExchangeRate: " + currency.getExchangeRate());
//Get the format instance of each currency
let format = currency.getFormat();
if (format != null) {
//Get the DecimalSeparator of the Format
console.log("Currency Format DecimalSeparator: " + format.getDecimalSeparator().getValue());
//Get the ThousandSeparator of the Format
console.log("Currency Format ThousandSeparator: " + format.getThousandSeparator().getValue());
//Get the DecimalPlaces of the Format
console.log("Currency Format DecimalPlaces: " + format.getDecimalPlaces().getValue());
}
//Get the createdBy User instance of each currency
let createdBy = currency.getCreatedBy();
//Check if createdBy is not null
if (createdBy != null) {
//Get the Name of the createdBy User
console.log("Currency CreatedBy User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Currency CreatedBy User-ID: " + createdBy.getId());
}
//Get the PrefixSymbol of each currency
console.log("Currency PrefixSymbol: " + currency.getPrefixSymbol().toString());
//Get the IsBase of each currency
console.log("Currency IsBase: " + currency.getIsBase().toString());
//Get the ModifiedTime of each currency
console.log("Currency ModifiedTime: " + currency.getModifiedTime());
//Get the Name of each currency
console.log("Currency Name: " + currency.getName());
//Get the modifiedBy User instance of each currency
let modifiedBy = currency.getModifiedBy();
//Check if modifiedBy is not null
if (modifiedBy != null) {
//Get the Name of the modifiedBy User
console.log("Currency ModifiedBy User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Currency ModifiedBy User-ID: " + modifiedBy.getId());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Update a Currency
class Currency
{
/**
* Update Currency
* This method is used to update currency details.
* @param {BigInt} currencyId Specify the unique ID of the currency.
*/
static async updateCurrency(currencyId) {
//example
//let currencyId = 3477061000006011001n;
//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Currency.Model.BodyWrapper();
//Array to hold Currency instances
let currencies = [];
//Get instance of Currency Class
let currency = new ZCRM.Currency.Model.Currency();
//To set the position of the ISO code in the currency.
//true: Display ISO code before the currency value.
//false: Display ISO code after the currency value.
currency.setPrefixSymbol(true);
//To set the rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("5.0000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
let format = new ZCRM.Currency.Model.Format();
//It can be a Period or Comma, depending on the currency.
format.setDecimalSeparator(new Choice("Period"));
//It can be a Period, Comma, or Space, depending on the currency.
format.setThousandSeparator(new Choice("Comma"));
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice("2"));
//To set the format of the currency
currency.setFormat(format);
//Add the Currency instance to the array
currencies.push(currency);
//Set the array to Currency in BodyWrapper instance
request.setCurrencies(currencies);
//Call updateCurrency method that takes BodyWrapper instance and currencyId as parameters
let response = await currenciesOperations.updateCurrency(currencyId, request);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ActionWrapper instance is received
if (responseObject instanceof ZCRM.Currency.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getCurrencies();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Currency.Model.SuccessResponse) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Currency.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}