Zoho Projects API Documentation
Text copied
File not found

Budget

This module covers budget-related operations in Zoho Projects. Use these APIs to configure and manage budget settings in the Zoho Projects portal.

Get Budget Settings

Retrieve the budget settings configured for the Zoho Projects portal. Use this API to get the current budget configuration, including EVM settings, currency, and profile permissions.

GET

/api/v3/portal/[PORTAL_ID]/settings/budget

OAuth Scope:

ZohoProjects.portals.READ

Path Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget";
response = invokeUrl
[
    url: url
    type: GET
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.get(url, headers=headers)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Get, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/get "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget", nil)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.get ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget" -Method GET -Headers $headers

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"

response <- GET(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Response

200{ "budget" : { "is_revenue_budget_enabled" : true, "profiles" : [ { "name" : "Employee", "id" : "4000000003074", "has_budget_permission" : false } ], "last_sync_time" : "1970-01-01T04:30:00.000Z", "evm_eac_type" : 1, "is_multi_currency_enabled" : true, "schedule_hours" : 6, "is_nonbillable_hours_included" : true, "is_additional_schedules_enabled" : false, "project_owner" : { "name" : "Project Owner", "id" : "4000000003089", "has_budget_permission" : true }, "is_budget_enabled" : true, "is_revenue_budget_available" : true, "is_budget_exceed_enabled" : true, "is_threshold_enabled" : true, "has_budget_permission" : true, "is_evm_enabled" : true, "evm_chart_view" : 1, "currency_list" : [ { "symbol" : "AED", "code" : "AED", "name" : "AED- UAE Dirham" }, { "symbol" : "Lek", "code" : "ALL", "name" : "ALL- Lek" }, { "symbol" : "AFN", "code" : "AFN", "name" : "AFN- Afghani" }, { "symbol" : "AMD", "code" : "AMD", "name" : "AMD- Armenian Dram" }, { "symbol" : "ƒ", "code" : "ANG", "name" : "ANG- Netherlands Antillian Guilder" }, { "symbol" : "AOA", "code" : "AOA", "name" : "AOA- Kwanza" }, { "symbol" : "$", "code" : "ARS", "name" : "ARS- Argentine Peso" }, { "symbol" : "$", "code" : "AUD", "name" : "AUD- Australian Dollar" }, { "symbol" : "ƒ", "code" : "AWG", "name" : "AWG- Aruban Guilder" }, { "symbol" : "AZN", "code" : "AZN", "name" : "AZN- Azerbaijanian Manat" }, { "symbol" : "KM", "code" : "BAM", "name" : "BAM- Convertible Marks" }, { "symbol" : "$", "code" : "BBD", "name" : "BBD- Barbados Dollar" }, { "symbol" : "BDT", "code" : "BDT", "name" : "BDT- Taka" }, { "symbol" : "BGN", "code" : "BGN", "name" : "BGN- Bulgarian Lev" }, { "symbol" : "BHD", "code" : "BHD", "name" : "BHD- Bahraini Dinar" }, { "symbol" : "BIF", "code" : "BIF", "name" : "BIF- Burundi Franc" }, { "symbol" : "$", "code" : "BMD", "name" : "BMD- Bermudian Dollar (Bermuda Dollar)" }, { "symbol" : "$", "code" : "BND", "name" : "BND- Brunei Dollar" }, { "symbol" : "$b", "code" : "BOB", "name" : "BOB- Boliviano" }, { "symbol" : "BOV", "code" : "BOV", "name" : "BOV- Mvdol" }, { "symbol" : "R$", "code" : "BRL", "name" : "BRL- Brazilian Real" }, { "symbol" : "$", "code" : "BSD", "name" : "BSD- Bahamian Dollar" }, { "symbol" : "BTC", "code" : "BTC", "name" : "BTC- Bitcoin" }, { "symbol" : "BTN", "code" : "BTN", "name" : "BTN- Ngultrum" }, { "symbol" : "P", "code" : "BWP", "name" : "BWP- Pula" }, { "symbol" : "p.", "code" : "BYR", "name" : "BYR- Belarussian Ruble" }, { "symbol" : "p.", "code" : "BYN", "name" : "BYN- New Belarussian Ruble" }, { "symbol" : "BZ$", "code" : "BZD", "name" : "BZD- Belize Dollar" }, { "symbol" : "$", "code" : "CAD", "name" : "CAD- Canadian Dollar" }, { "symbol" : "CDF", "code" : "CDF", "name" : "CDF- Franc Congolais" }, { "symbol" : "CHE", "code" : "CHE", "name" : "CHE- WIR Euro" }, { "symbol" : "CHF", "code" : "CHF", "name" : "CHF- Swiss Franc" }, { "symbol" : "CHW", "code" : "CHW", "name" : "CHW- WIR Franc" }, { "symbol" : "CLF", "code" : "CLF", "name" : "CLF- Unidades de formento" }, { "symbol" : "$", "code" : "CLP", "name" : "CLP- Chilean Peso" }, { "symbol" : "CNY", "code" : "CNY", "name" : "CNY- Yuan Renminbi" }, { "symbol" : "$", "code" : "COP", "name" : "COP- Colombian Peso" }, { "symbol" : "COU", "code" : "COU", "name" : "COU- Unidad de Valor Real" }, { "symbol" : "CRC", "code" : "CRC", "name" : "CRC- Costa Rican Colon" }, { "symbol" : "CUC$", "code" : "CUC", "name" : "CUC- Cuba Convertible Peso" }, { "symbol" : "CUP", "code" : "CUP", "name" : "CUP- Cuban Peso" }, { "symbol" : "CVE", "code" : "CVE", "name" : "CVE- Cape Verde Escudo" }, { "symbol" : "CYP", "code" : "CYP", "name" : "CYP- Cyprus Pound" }, { "symbol" : "CZK", "code" : "CZK", "name" : "CZK- Czech Koruna" }, { "symbol" : "DJF", "code" : "DJF", "name" : "DJF- Djibouti Franc" }, { "symbol" : "kr", "code" : "DKK", "name" : "DKK- Danish Krone" }, { "symbol" : "RD$", "code" : "DOP", "name" : "DOP- Dominican Peso" }, { "symbol" : "DZD", "code" : "DZD", "name" : "DZD- Algerian Dinar" }, { "symbol" : "kr", "code" : "EEK", "name" : "EEK- Kroon" }, { "symbol" : "£", "code" : "EGP", "name" : "EGP- Egyptian Pound" }, { "symbol" : "ERN", "code" : "ERN", "name" : "ERN- Nakfa" }, { "symbol" : "ETB", "code" : "ETB", "name" : "ETB- Ethiopian Birr" }, { "symbol" : "€", "code" : "EUR", "name" : "EUR- Euro" }, { "symbol" : "$", "code" : "FJD", "name" : "FJD- Fiji Dollar" }, { "symbol" : "£", "code" : "FKP", "name" : "FKP- Falkland Islands Pound" }, { "symbol" : "£", "code" : "GBP", "name" : "GBP- Pound Sterling" }, { "symbol" : "GEL", "code" : "GEL", "name" : "GEL- Lari" }, { "symbol" : "£", "code" : "GGP", "name" : "GGP- Guernsey Pound" }, { "symbol" : "¢", "code" : "GHS", "name" : "GHS- Cedi" }, { "symbol" : "£", "code" : "GIP", "name" : "GIP- Gibraltar Pound" }, { "symbol" : "GMD", "code" : "GMD", "name" : "GMD- Dalasi" }, { "symbol" : "GNF", "code" : "GNF", "name" : "GNF- Guinea Franc" }, { "symbol" : "Q", "code" : "GTQ", "name" : "GTQ- Quetzal" }, { "symbol" : "GWP", "code" : "GWP", "name" : "GWP- Guinea-Bissau Peso" }, { "symbol" : "$", "code" : "GYD", "name" : "GYD- Guyana Dollar" }, { "symbol" : "元", "code" : "HKD", "name" : "HKD- Hong Kong Dollar" }, { "symbol" : "L", "code" : "HNL", "name" : "HNL- Lempira" }, { "symbol" : "kn", "code" : "HRK", "name" : "HRK- Croatian Kuna" }, { "symbol" : "HTG", "code" : "HTG", "name" : "HTG- Gourde" }, { "symbol" : "Ft", "code" : "HUF", "name" : "HUF- Forint" }, { "symbol" : "Rp", "code" : "IDR", "name" : "IDR- Rupiah" }, { "symbol" : "ILS", "code" : "ILS", "name" : "ILS- New Israeli Sheqel" }, { "symbol" : "£", "code" : "IMP", "name" : "IMP- Isle of Man Pound" }, { "symbol" : "₹", "code" : "INR", "name" : "INR- Indian Rupee" }, { "symbol" : "IQD", "code" : "IQD", "name" : "IQD- Iraqi Dinar" }, { "symbol" : "IRR", "code" : "IRR", "name" : "IRR- Iranian Rial" }, { "symbol" : "kr", "code" : "ISK", "name" : "ISK- Iceland Krona" }, { "symbol" : "£", "code" : "JEP", "name" : "JEP- Jersey Pound" }, { "symbol" : "J$", "code" : "JMD", "name" : "JMD- Jamaican Dollar" }, { "symbol" : "JOD", "code" : "JOD", "name" : "JOD- Jordanian Dinar" }, { "symbol" : "¥", "code" : "JPY", "name" : "JPY- Yen" }, { "symbol" : "KES", "code" : "KES", "name" : "KES- Kenyan Shilling" }, { "symbol" : "KGS", "code" : "KGS", "name" : "KGS- Som" }, { "symbol" : "KHR", "code" : "KHR", "name" : "KHR- Riel" }, { "symbol" : "KMF", "code" : "KMF", "name" : "KMF- Comoro Franc" }, { "symbol" : "₩", "code" : "KPW", "name" : "KPW- North Korean Won" }, { "symbol" : "₩", "code" : "KRW", "name" : "KRW- Won" }, { "symbol" : "KWD", "code" : "KWD", "name" : "KWD- Kuwaiti Dinar" }, { "symbol" : "$", "code" : "KYD", "name" : "KYD- Cayman Islands Dollar" }, { "symbol" : "KZT", "code" : "KZT", "name" : "KZT- Tenge" }, { "symbol" : "LAK", "code" : "LAK", "name" : "LAK- Kip" }, { "symbol" : "£", "code" : "LBP", "name" : "LBP- Lebanese Pound" }, { "symbol" : "Rs", "code" : "LKR", "name" : "LKR- Sri Lanka Rupee" }, { "symbol" : "$", "code" : "LRD", "name" : "LRD- Liberian Dollar" }, { "symbol" : "LSL", "code" : "LSL", "name" : "LSL- Loti" }, { "symbol" : "Lt", "code" : "LTL", "name" : "LTL- Lithuanian Litas" }, { "symbol" : "Ls", "code" : "LVL", "name" : "LVL- Latvian Lats" }, { "symbol" : "LYD", "code" : "LYD", "name" : "LYD- Libyan Dinar" }, { "symbol" : "MAD", "code" : "MAD", "name" : "MAD- Moroccan Dirham" }, { "symbol" : "MDL", "code" : "MDL", "name" : "MDL- Moldovan Leu" }, { "symbol" : "MGA", "code" : "MGA", "name" : "MGA- Malagascy Ariary" }, { "symbol" : "MKD", "code" : "MKD", "name" : "MKD- Denar" }, { "symbol" : "MMK", "code" : "MMK", "name" : "MMK- Kyat" }, { "symbol" : "MNT", "code" : "MNT", "name" : "MNT- Tugrik" }, { "symbol" : "MOP", "code" : "MOP", "name" : "MOP- Pataca" }, { "symbol" : "MRO", "code" : "MRO", "name" : "MRO- Ouguiya" }, { "symbol" : "MRU", "code" : "MRU", "name" : "MRU- Ouguiya" }, { "symbol" : "MTL", "code" : "MTL", "name" : "MTL- Maltese Lira" }, { "symbol" : "Rp", "code" : "MUR", "name" : "MUR- Mauritius Rupee" }, { "symbol" : "MVR", "code" : "MVR", "name" : "MVR- Rufiyaa" }, { "symbol" : "MWK", "code" : "MWK", "name" : "MWK- Kwacha" }, { "symbol" : "$", "code" : "MXN", "name" : "MXN- Mexican Peso" }, { "symbol" : "MXV", "code" : "MXV", "name" : "MXV- Mexican Unidad de Inversion (UID)" }, { "symbol" : "RM", "code" : "MYR", "name" : "MYR- Malaysian Ringgit" }, { "symbol" : "MT", "code" : "MZN", "name" : "MZN- Metical" }, { "symbol" : "$", "code" : "NAD", "name" : "NAD- Namibian Dollar" }, { "symbol" : "NGN", "code" : "NGN", "name" : "NGN- Naira" }, { "symbol" : "C$", "code" : "NIO", "name" : "NIO- Cordoba Oro" }, { "symbol" : "kr", "code" : "NOK", "name" : "NOK- Norwegian Krone" }, { "symbol" : "Rp", "code" : "NPR", "name" : "NPR- Nepalese Rupee" }, { "symbol" : "$", "code" : "NZD", "name" : "NZD- New Zealand Dollar" }, { "symbol" : "OMR", "code" : "OMR", "name" : "OMR- Rial Omani" }, { "symbol" : "B/.", "code" : "PAB", "name" : "PAB- Balboa" }, { "symbol" : "S/.", "code" : "PEN", "name" : "PEN- Nuevo Sol" }, { "symbol" : "PGK", "code" : "PGK", "name" : "PGK- Kina" }, { "symbol" : "Php", "code" : "PHP", "name" : "PHP- Philippine Peso" }, { "symbol" : "Rs", "code" : "PKR", "name" : "PKR- Pakistan Rupee" }, { "symbol" : "PLN", "code" : "PLN", "name" : "PLN- Zloty" }, { "symbol" : "Gs", "code" : "PYG", "name" : "PYG- Guarani" }, { "symbol" : "QAR", "code" : "QAR", "name" : "QAR- Qatari Rial" }, { "symbol" : "ROL", "code" : "ROL", "name" : "ROL- Old Leu" }, { "symbol" : "lei", "code" : "RON", "name" : "RON- New Leu" }, { "symbol" : "RSD", "code" : "RSD", "name" : "RSD- Serbian Dinar" }, { "symbol" : "RUB", "code" : "RUB", "name" : "RUB- Russian Ruble" }, { "symbol" : "RWF", "code" : "RWF", "name" : "RWF- Rwanda Franc" }, { "symbol" : "SAR", "code" : "SAR", "name" : "SAR- Saudi Riyal" }, { "symbol" : "$", "code" : "SBD", "name" : "SBD- Solomon Islands Dollar" }, { "symbol" : "Rp", "code" : "SCR", "name" : "SCR- Seychelles Rupee" }, { "symbol" : "SDD", "code" : "SDD", "name" : "SDD- Sudanese Dinar" }, { "symbol" : "SDG", "code" : "SDG", "name" : "SDG- Sudanese Pound" }, { "symbol" : "kr", "code" : "SEK", "name" : "SEK- Swedish Krona" }, { "symbol" : "$", "code" : "SGD", "name" : "SGD- Singapore Dollar" }, { "symbol" : "£", "code" : "SHP", "name" : "SHP- Saint Helena Pound" }, { "symbol" : "SIT", "code" : "SIT", "name" : "SIT- Tolar" }, { "symbol" : "SKK", "code" : "SKK", "name" : "SKK- Slovak Koruna" }, { "symbol" : "SLL", "code" : "SLL", "name" : "SLL- Leone" }, { "symbol" : "Le", "code" : "SLE", "name" : "SLE- Sierra Leonean Leone" }, { "symbol" : "SSP", "code" : "SSP", "name" : "SSP- South Sudanese Pound" }, { "symbol" : "S", "code" : "SOS", "name" : "SOS- Somali Shilling" }, { "symbol" : "$", "code" : "SRD", "name" : "SRD- Surinam Dollar" }, { "symbol" : "STD", "code" : "STD", "name" : "STD- Dobra" }, { "symbol" : "STN", "code" : "STN", "name" : "STN- Dobra" }, { "symbol" : "$", "code" : "SVC", "name" : "SVC- El Salvador Colon" }, { "symbol" : "£", "code" : "SYP", "name" : "SYP- Syrian Pound" }, { "symbol" : "SZL", "code" : "SZL", "name" : "SZL- Lilangeni" }, { "symbol" : "THB", "code" : "THB", "name" : "THB- Baht" }, { "symbol" : "TJS", "code" : "TJS", "name" : "TJS- Somoni" }, { "symbol" : "TMT", "code" : "TMT", "name" : "TMT- Manat" }, { "symbol" : "TND", "code" : "TND", "name" : "TND- Tunisian Dinar" }, { "symbol" : "TOP", "code" : "TOP", "name" : "TOP- Paanga" }, { "symbol" : "TL", "code" : "TRL", "name" : "TRL- Turkish Lira" }, { "symbol" : "YTL", "code" : "TRY", "name" : "TRY- New Turkish Lira" }, { "symbol" : "TT$", "code" : "TTD", "name" : "TTD- Trinidad and Tobago Dollar" }, { "symbol" : "$", "code" : "TVD", "name" : "TVD- Tuvalu Dollar" }, { "symbol" : "NT$", "code" : "TWD", "name" : "TWD- New Taiwan Dollar" }, { "symbol" : "TZS", "code" : "TZS", "name" : "TZS- Tanzanian Shilling" }, { "symbol" : "UAH", "code" : "UAH", "name" : "UAH- Hryvnia" }, { "symbol" : "UGX", "code" : "UGX", "name" : "UGX- Uganda Shilling" }, { "symbol" : "$", "code" : "USD", "name" : "USD- US Dollar" }, { "symbol" : "UYI", "code" : "UYI", "name" : "UYI- Uruguay Peso en Unidades Indexadas" }, { "symbol" : "$U", "code" : "UYU", "name" : "UYU- Peso Uruguayo" }, { "symbol" : "UZS", "code" : "UZS", "name" : "UZS- Uzbekistan Sum" }, { "symbol" : "VEB", "code" : "VEB", "name" : "VEB- Bolivar" }, { "symbol" : "VEF", "code" : "VEF", "name" : "VEF- Bolivar Fuerte" }, { "symbol" : "VES", "code" : "VES", "name" : "VES- Venezuelan Bolivar Soberano" }, { "symbol" : "VED", "code" : "VED", "name" : "VED- Venezuelan Bolivar Digital" }, { "symbol" : "VND", "code" : "VND", "name" : "VND- Dong" }, { "symbol" : "VUV", "code" : "VUV", "name" : "VUV- Vatu" }, { "symbol" : "WST", "code" : "WST", "name" : "WST- Tala" }, { "symbol" : "XAF", "code" : "XAF", "name" : "XAF- CFA Franc BEAC" }, { "symbol" : "$", "code" : "XCD", "name" : "XCD- East Caribbean Dollar" }, { "symbol" : "XDR", "code" : "XDR", "name" : "XDR- SDR" }, { "symbol" : "XOF", "code" : "XOF", "name" : "XOF- CFA Franc BCEAO" }, { "symbol" : "XPF", "code" : "XPF", "name" : "XPF- CFP Franc" }, { "symbol" : "Cg", "code" : "XCG", "name" : "XCG- Caribbean Guilder" }, { "symbol" : "YER", "code" : "YER", "name" : "YER- Yemeni Rial" }, { "symbol" : "R", "code" : "ZAR", "name" : "ZAR- Rand" }, { "symbol" : "ZMK", "code" : "ZMK", "name" : "ZMK- Kwacha" }, { "symbol" : "ZMW", "code" : "ZMW", "name" : "ZMW- Zambian Kwacha" }, { "symbol" : "Z$", "code" : "ZWD", "name" : "ZWD- Zimbabwe Dollar" }, { "symbol" : "Z$", "code" : "ZWL", "name" : "ZWL- New Zimbabwe Dollar" }, { "symbol" : "ZiG", "code" : "ZWG", "name" : "ZWG- Zimbabwe Gold" } ], "default_currency" : "USD" } }

Update Budget Settings

Update the budget settings configured for the Zoho Projects portal. Use this API to enable or disable budget tracking, configure EVM settings, set the default currency, and manage profile permissions.

POST

/api/v3/portal/[PORTAL_ID]/settings/budget

OAuth Scope:

ZohoProjects.portals.UPDATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • JSON
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X POST \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget";
params = Map();
params.put("is_budget_enabled", true);
params.put("default_currency", "USD");
params.put("schedule_hour", "6");
params.put("is_threshold_enabled", true);
params.put("is_budget_exceed_enabled", true);
params.put("profiles", [{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}]);
params.put("is_evm_enabled", true);
params.put("evm_chart_view", "weekly");
params.put("evm_eac_type", "atypical");
params.put("is_revenue_budget_enabled", true);
params.put("is_nonbillable_hours_included", false);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget');

const payload = JSON.stringify({"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}'

response = requests.post(url, headers=headers, data=payload)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Post, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
request.Content = new StringContent(
    @"{""is_budget_enabled"":true,""default_currency"":""USD"",""schedule_hour"":""6"",""is_threshold_enabled"":true,""is_budget_exceed_enabled"":true,""profiles"":[{""add"":[{""id"":""4000000062001""}],""remove"":[{""id"":""4000000062001""}],""id"":""4000000062001""}],""is_evm_enabled"":true,""evm_chart_view"":""weekly"",""evm_eac_type"":""atypical"",""is_revenue_budget_enabled"":true,""is_nonbillable_hours_included"":false}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/post "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}"
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}")
    req, _ := http.NewRequest("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}|json} in
  Lwt_main.run (
    Client.post ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget" -Method POST -Headers $headers -Body $body

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget"

response <- POST(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"is_budget_enabled\":true,\"default_currency\":\"USD\",\"schedule_hour\":\"6\",\"is_threshold_enabled\":true,\"is_budget_exceed_enabled\":true,\"profiles\":[{\"add\":[{\"id\":\"4000000062001\"}],\"remove\":[{\"id\":\"4000000062001\"}],\"id\":\"4000000062001\"}],\"is_evm_enabled\":true,\"evm_chart_view\":\"weekly\",\"evm_eac_type\":\"atypical\",\"is_revenue_budget_enabled\":true,\"is_nonbillable_hours_included\":false}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/budget")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"is_budget_enabled":true,"default_currency":"USD","schedule_hour":"6","is_threshold_enabled":true,"is_budget_exceed_enabled":true,"profiles":[{"add":[{"id":"4000000062001"}],"remove":[{"id":"4000000062001"}],"id":"4000000062001"}],"is_evm_enabled":true,"evm_chart_view":"weekly","evm_eac_type":"atypical","is_revenue_budget_enabled":true,"is_nonbillable_hours_included":false}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json
{ "is_budget_enabled" : true, "default_currency" : "USD", "schedule_hour" : "6", "is_threshold_enabled" : true, "is_budget_exceed_enabled" : true, "profiles" : [ { "add" : [ { "id" : "4000000062001" } ], "remove" : [ { "id" : "4000000062001" } ], "id" : "4000000062001" } ], "is_evm_enabled" : true, "evm_chart_view" : "weekly", "evm_eac_type" : "atypical", "is_revenue_budget_enabled" : true, "is_nonbillable_hours_included" : false }

Sample Response

200{ "is_budget_enabled" : false, "default_currency" : "string-value", "schedule_hour" : "string-value", "is_threshold_enabled" : false, "is_budget_exceed_enabled" : false, "profiles" : [ { "add" : [ { "id" : 4000000094003 } ], "remove" : [ { "id" : 4000000094003 } ], "id" : 4000000094003 } ], "is_evm_enabled" : false, "evm_chart_view" : "string-value", "evm_eac_type" : "string-value", "is_revenue_budget_enabled" : false, "is_nonbillable_hours_included" : false, "id" : 4000000094003, "created_time" : "2024-12-27T10:31:14.566Z" }

Get Currency Setting

Retrieve the currency settings configured for the Zoho Projects portal. Use this API to get the base currency, currency list, and conversion settings.

GET

/api/v3/portal/[PORTAL_ID]/settings/currency

OAuth Scope:

ZohoProjects.portals.READ

Path Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency";
response = invokeUrl
[
    url: url
    type: GET
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.get(url, headers=headers)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Get, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/get "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency", nil)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.get ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency" -Method GET -Headers $headers

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency"

response <- GET(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/settings/currency")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Response

200{ "currency" : { "has_budget_permission" : true, "base_currency" : { "symbol" : "$", "currency_name" : "USD- US Dollar", "exchange_rate" : 1.0, "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : true, "currency_id" : 4000000020001, "currency_code" : "USD", "decimal_places" : 2, "is_delete" : true }, "is_manual_conversion" : true, "currency_list" : [ { "symbol" : "AED", "currency_name" : "AED- UAE Dirham", "exchange_rate" : 10.0, "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : false, "currency_id" : 4000000020143, "currency_code" : "AED", "decimal_places" : 2, "is_delete" : true } ] } }

Add Currency

Add a new currency to the organisation. Use this API to configure the currency code, symbol, format, and exchange rate for budget and financial tracking across projects.

POST

/api/v3/portal/[PORTAL_ID]/currency

OAuth Scope:

ZohoProjects.portals.CREATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • JSON
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X POST \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency";
params = Map();
params.put("currency_code", "AED");
params.put("symbol", "AED");
params.put("decimal_places", "2");
params.put("format", "#,##,##0.00");
params.put("exchange_rate", 10.0);
params.put("is_base_currency", false);
params.put("conversion_type", "1");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency');

const payload = JSON.stringify({"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

response = requests.post(url, headers=headers, data=payload)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Post, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency");
request.Content = new StringContent(
    @"{""currency_code"":""AED"",""symbol"":""AED"",""decimal_places"":""2"",""format"":""#,##,##0.00"",""exchange_rate"":10.0,""is_base_currency"":false,""conversion_type"":""1""}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/post "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}"
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}")
    req, _ := http.NewRequest("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}|json} in
  Lwt_main.run (
    Client.post ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency" -Method POST -Headers $headers -Body $body

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency"

response <- POST(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json
{ "currency_code" : "AED", "symbol" : "AED", "decimal_places" : "2", "format" : "#,##,##0.00", "exchange_rate" : 10.0, "is_base_currency" : false, "conversion_type" : "1" }

Sample Response

201{ "currency" : { "base_currency" : { "symbol" : "$", "currency_name" : "USD- US Dollar", "exchange_rate" : "1.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : true, "currency_id" : "4000000020001", "currency_code" : "USD", "decimal_places" : "2", "is_delete" : true }, "is_manual_conversion" : true, "currency_list" : [ { "symbol" : "AED", "currency_name" : "AED- UAE Dirham", "exchange_rate" : "10.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : false, "currency_id" : "4000000020143", "currency_code" : "AED", "decimal_places" : "2", "is_delete" : true } ] } }

Update Currency

Update an existing currency configured for the Zoho Projects portal. Use this API to modify the currency code, symbol, format, or exchange rate. Only the fields included in the request are modified.

PATCH

/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]

OAuth Scope:

ZohoProjects.portals.UPDATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • JSON
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X PATCH \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]";
params = Map();
params.put("currency_code", "AED");
params.put("symbol", "AED");
params.put("decimal_places", "2");
params.put("format", "#,##,##0.00");
params.put("exchange_rate", 10.0);
params.put("is_base_currency", false);
params.put("conversion_type", "1");
response = invokeUrl
[
    url: url
    type: PATCH
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]');

const payload = JSON.stringify({"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}'

response = requests.patch(url, headers=headers, data=payload)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Patch, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
request.Content = new StringContent(
    @"{""currency_code"":""AED"",""symbol"":""AED"",""decimal_places"":""2"",""format"":""#,##,##0.00"",""exchange_rate"":10.0,""is_base_currency"":false,""conversion_type"":""1""}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/patch "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}"
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}")
    req, _ := http.NewRequest("PATCH", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
PATCH https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "PATCH"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"PATCH"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}|json} in
  Lwt_main.run (
    Client.patch ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]" -Method PATCH -Headers $headers -Body $body

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"

response <- PATCH(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"currency_code\":\"AED\",\"symbol\":\"AED\",\"decimal_places\":\"2\",\"format\":\"#,##,##0.00\",\"exchange_rate\":10.0,\"is_base_currency\":false,\"conversion_type\":\"1\"}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"currency_code":"AED","symbol":"AED","decimal_places":"2","format":"#,##,##0.00","exchange_rate":10.0,"is_base_currency":false,"conversion_type":"1"}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json
{ "currency_code" : "AED", "symbol" : "AED", "decimal_places" : "2", "format" : "#,##,##0.00", "exchange_rate" : 10.0, "is_base_currency" : false, "conversion_type" : "1" }

Sample Response

200{ "currency" : { "base_currency" : { "symbol" : "$", "currency_name" : "USD- US Dollar", "exchange_rate" : "1.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : true, "currency_id" : "4000000020001", "currency_code" : "USD", "decimal_places" : "2", "is_delete" : true }, "is_manual_conversion" : true, "currency_list" : [ { "symbol" : "AED", "currency_name" : "AED- UAE Dirham", "exchange_rate" : "10.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : false, "currency_id" : "4000000020143", "currency_code" : "AED", "decimal_places" : "2", "is_delete" : true } ] } }

Delete Currency

Remove a currency configured for the Zoho Projects portal.

DELETE

/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]

OAuth Scope:

ZohoProjects.portals.DELETE

Path Parameters

Param Name
Data Type
Description

Request Example

Request Example
  • cURL
  • Deluge
  • Node.js
  • Ruby
  • PHP
  • Python
  • C
  • C#
  • C++
  • Clojure
  • Go
  • HTTP
  • Java
  • JS Fetch
  • Kotlin
  • Objective-C
  • OCaml
  • PowerShell
  • R
  • Swift

curl -X DELETE \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]";
response = invokeUrl
[
    url: url
    type: DELETE
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.delete(url, headers=headers)

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Delete, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/delete "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]", nil)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
DELETE https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]");
HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]';

const options = {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "DELETE"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"DELETE"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];
open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.delete ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]" -Method DELETE -Headers $headers

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]"

response <- DELETE(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/currency/[CURRENCY_ID]")!
var request = URLRequest(url: url)
request.httpMethod = "DELETE"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Response

200{ "currency" : { "base_currency" : { "symbol" : "$", "currency_name" : "USD- US Dollar", "exchange_rate" : "1.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : true, "currency_id" : "4000000020001", "currency_code" : "USD", "decimal_places" : "2", "is_delete" : true }, "is_manual_conversion" : true, "currency_list" : [ { "symbol" : "AED", "currency_name" : "AED- UAE Dirham", "exchange_rate" : "10.0000000000", "format_key" : "#,##,##0.00", "format" : "1,23,456.78", "is_base_currency" : false, "currency_id" : "4000000020143", "currency_code" : "AED", "decimal_places" : "2", "is_delete" : true } ] } }
AI Tools
ChatGPT Open in ChatGPT ↗ Open in ChatGPT to ask questions about this page
Claude Open in Claude ↗ Open in Claude to ask questions about this page
Copy as Markdown Copy this page as markdown to use with AI assistants
View as Markdown ↗ Open this page as markdown in a new tab
Copy OpenAPI Spec Copy the OpenAPI YAML to the clipboard
View as YAML ↗ Open the OpenAPI spec in a new tab
Download YAML Save the OpenAPI spec as a .yaml file