Chilkat Online Tools

DataFlex / Zoho CRM REST APIs / Enable Multi-Currency

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "base_currency": {
    //     "format": {
    //       "decimal_separator": "Period",
    //       "thousand_separator": "Comma",
    //       "decimal_places": "2"
    //     },
    //     "prefix_symbol": true,
    //     "name": "Algerian Dinar - DZD",
    //     "iso_code": "DZD",
    //     "symbol": "Af",
    //     "exchange_rate": "1.0000000"
    //   }
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "base_currency.format.decimal_separator" "Period" To iSuccess
    Get ComUpdateString Of hoJson "base_currency.format.thousand_separator" "Comma" To iSuccess
    Get ComUpdateString Of hoJson "base_currency.format.decimal_places" "2" To iSuccess
    Get ComUpdateBool Of hoJson "base_currency.prefix_symbol" True To iSuccess
    Get ComUpdateString Of hoJson "base_currency.name" "Algerian Dinar - DZD" To iSuccess
    Get ComUpdateString Of hoJson "base_currency.iso_code" "DZD" To iSuccess
    Get ComUpdateString Of hoJson "base_currency.symbol" "Af" To iSuccess
    Get ComUpdateString Of hoJson "base_currency.exchange_rate" "1.0000000" To iSuccess

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://domain.com/crm/v2/org/currencies/actions/enable" vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1


End_Procedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "base_currency": {
    "format": {
      "decimal_separator": "Period",
      "thousand_separator": "Comma",
      "decimal_places": "2"
    },
    "prefix_symbol": true,
    "name": "Algerian Dinar - DZD",
    "iso_code": "DZD",
    "symbol": "Af",
    "exchange_rate": "1.0000000"
  }
}'
https://domain.com/crm/v2/org/currencies/actions/enable

Postman Collection Item JSON

{
  "name": "Enable Multi-Currency",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"base_currency\": {\n    \"format\": {\n      \"decimal_separator\": \"Period\",\n      \"thousand_separator\": \"Comma\",\n      \"decimal_places\": \"2\"\n    },\n    \"prefix_symbol\": true,\n    \"name\": \"Algerian Dinar - DZD\",\n    \"iso_code\": \"DZD\",\n    \"symbol\": \"Af\",\n    \"exchange_rate\": \"1.0000000\"\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/org/currencies/actions/enable",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "org",
        "currencies",
        "actions",
        "enable"
      ]
    },
    "description": "To enable multiple currencies for your organization."
  },
  "response": [
    {
      "name": "ALREADY_ENABLED",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"base_currency\": {\n    \"format\": {\n      \"decimal_separator\": \"Period\",\n      \"thousand_separator\": \"Comma\",\n      \"decimal_places\": \"2\"\n    },\n    \"prefix_symbol\": true,\n    \"name\": \"Algerian Dinar - DZD\",\n    \"iso_code\": \"DZD\",\n    \"symbol\": \"Af\",\n    \"exchange_rate\": \"1.0000000\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/org/currencies/actions/enable",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "org",
            "currencies",
            "actions",
            "enable"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 12 May 2021 06:57:58 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "124"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-12T07:56:48+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4027076"
        },
        {
          "key": "clientsubVersion",
          "value": "748ecbe82ec7e144b66ee25f264bbd88"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"base_currency\": {\n        \"code\": \"ALREADY_ENABLED\",\n        \"details\": {},\n        \"message\": \"The multi-currency is already enabled\",\n        \"status\": \"error\"\n    }\n}"
    },
    {
      "name": "MANDATORY_NOT_FOUND",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"base_currency\": {\n        \"format\": {\n            \"decimal_separator\": \"Period\",\n            \"thousand_separator\": \"Comma\",\n            \"decimal_places\": \"2\"\n        },\n        \"prefix_symbol\": true,\n        \"name\": \"Algerian Dinar - DZD\",\n        \"symbol\": \"Af\",\n        \"exchange_rate\": \"1.0000000\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/org/currencies/actions/enable",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "org",
            "currencies",
            "actions",
            "enable"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 12 May 2021 06:59:13 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "178"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-12T07:56:48+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4027076"
        },
        {
          "key": "clientsubVersion",
          "value": "748ecbe82ec7e144b66ee25f264bbd88"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"base_currency\": {\n        \"code\": \"MANDATORY_NOT_FOUND\",\n        \"details\": {\n            \"api_name\": \"iso_code\",\n            \"json_path\": \"$.base_currency[0].iso_code\"\n        },\n        \"message\": \"required field not found\",\n        \"status\": \"error\"\n    }\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "COPY",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"base_currency\": {\n        \"format\": {\n            \"decimal_separator\": \"Period\",\n            \"thousand_separator\": \"Comma\",\n            \"decimal_places\": \"2\"\n        },\n        \"prefix_symbol\": true,\n        \"name\": \"Algerian Dinar - DZD\",\n        \"symbol\": \"Af\",\n        \"exchange_rate\": \"1.0000000\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/org/currencies/actions/enable",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "org",
            "currencies",
            "actions",
            "enable"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 12 May 2021 06:59:28 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "124"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Frame-Options",
          "value": "deny"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_REQUEST_METHOD\",\n    \"details\": {},\n    \"message\": \"The http request method type is not a valid one\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "AUTHENTICATION_FAILURE",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"base_currency\": {\n        \"format\": {\n            \"decimal_separator\": \"Period\",\n            \"thousand_separator\": \"Comma\",\n            \"decimal_places\": \"2\"\n        },\n        \"prefix_symbol\": true,\n        \"name\": \"Algerian Dinar - DZD\",\n        \"symbol\": \"Af\",\n        \"exchange_rate\": \"1.0000000\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/org/currencies/actions/enable",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "org",
            "currencies",
            "actions",
            "enable"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 12 May 2021 06:59:47 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "98"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"AUTHENTICATION_FAILURE\",\n    \"details\": {},\n    \"message\": \"Authentication failed\",\n    \"status\": \"error\"\n}"
    }
  ]
}