Chilkat Online Tools

TCL / Zoho CRM REST APIs / Invoices

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "data": [
#     {
#       "Product_Details": [
#         {
#           "product": {
#             "name": "sample",
#             "id": "{{product_id}}"
#           },
#           "quantity": 1
#         }
#       ],
#       "Invoice_Date": "2021-01-21",
#       "Account_Name": {
#         "name": "Zylker",
#         "id": "{{account_id}}"
#       },
#       "Sales_Order": {
#         "name": "SalesOrder1001",
#         "id": "{{sales_order_id}}"
#       },
#       "Subject": "Invoice101",
#       "Contact_Name": {
#         "name": "Patricia Boyle",
#         "id": "{{contact_id}}"
#       }
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data[0].Product_Details[0].product.name" "sample"
CkJsonObject_UpdateString $json "data[0].Product_Details[0].product.id" "{{product_id}}"
CkJsonObject_UpdateInt $json "data[0].Product_Details[0].quantity" 1
CkJsonObject_UpdateString $json "data[0].Invoice_Date" "2021-01-21"
CkJsonObject_UpdateString $json "data[0].Account_Name.name" "Zylker"
CkJsonObject_UpdateString $json "data[0].Account_Name.id" "{{account_id}}"
CkJsonObject_UpdateString $json "data[0].Sales_Order.name" "SalesOrder1001"
CkJsonObject_UpdateString $json "data[0].Sales_Order.id" "{{sales_order_id}}"
CkJsonObject_UpdateString $json "data[0].Subject" "Invoice101"
CkJsonObject_UpdateString $json "data[0].Contact_Name.name" "Patricia Boyle"
CkJsonObject_UpdateString $json "data[0].Contact_Name.id" "{{contact_id}}"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/crm/v2/Invoices/upsert" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Product_Details": [
                {
                    "product": {
                        "name": "sample",
                        "id": "{{product_id}}"
                    },
                    "quantity": 1
                }
            ],
            "Invoice_Date": "2021-01-21",
            "Account_Name": {
                "name": "Zylker",
                "id": "{{account_id}}"
            },
            "Sales_Order": {
                "name": "SalesOrder1001",
                "id": "{{sales_order_id}}"
            },
            "Subject": "Invoice101",
            "Contact_Name": {
                "name": "Patricia Boyle",
                "id": "{{contact_id}}"
            }
        }
    ]
}'
https://domain.com/crm/v2/Invoices/upsert

Postman Collection Item JSON

{
  "name": "Invoices",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Product_Details\": [\n                {\n                    \"product\": {\n                        \"name\": \"sample\",\n                        \"id\": \"{{product_id}}\"\n                    },\n                    \"quantity\": 1\n                }\n            ],\n            \"Invoice_Date\": \"2021-01-21\",\n            \"Account_Name\": {\n                \"name\": \"Zylker\",\n                \"id\": \"{{account_id}}\"\n            },\n            \"Sales_Order\": {\n                \"name\": \"SalesOrder1001\",\n                \"id\": \"{{sales_order_id}}\"\n            },\n            \"Subject\": \"Invoice101\",\n            \"Contact_Name\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"{{contact_id}}\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Invoices/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Invoices",
        "upsert"
      ]
    },
    "description": "To add new entities to the invoices module."
  },
  "response": [
  ]
}